線上書籍

Home

XOOPS 模組開發

一、 使用範例模組
  1. 將 demo.zip 解壓，得到demo目錄。
  2. 將 demo 目錄改名為您自訂的模組名稱如：tad_honor 或 school_news
  3. 將 tad_honor 或 school_news 搬移到網頁目錄下的 modules 中，如：C:\my_xoops\www\modules
二、 XOOPS模組結構
  1. 一個XOOPS模組就是一個目錄，此目錄會放在modules底下。
  2. 底下是新的（2.5之後的）XOOPS的模組目錄建議結構（PHP > 5.2）：
    admin
    blocks
    class
    css
    docs
    images
        |--- admin
        |--- icons
    include
    language
        |--- english
            |--- help
    sql
    templates
        |--- blocks
    test    		 模組後台目錄
    區塊檔案目錄
    額外的物件庫或函式庫目錄
    模組樣式目錄
    說明文件目錄
    圖檔目錄
        |--- 後台界面用到的圖檔
        |--- 其他圖檔
    引入檔目錄：如搜尋、模組自動檔
    語系目錄
        |--- 英語語系（Big5中文為tchinese、UTF-8為tchinese_utf8）
            |--- 說明文件語系
    資料庫結構目錄：裡面會有.sql檔
    模組樣板目錄：用來放置模組頁面的樣板檔，均為.html檔
        |--- 區塊樣板檔：一樣為.html檔
    測試檔目錄：放置Selenium 測試檔
  3. 其實您完全不管這個結構也是無所謂的，但黃底的目錄（如果有用到該功能的話）則是一定要有的，而且不能亂改目錄名稱！紅底的目錄則是常用的目錄。
  4. 關於Selenium可參考http://www.jaceju.net/blog/archives/1293/
三、認識xoops_version.php
  1. XOOPS的模組目錄下一定有xoops_version.php設定檔，否則就不是標準模組。
  2. 設定檔中，最重要的設定為$modversion['dirname']，可直接輸入模組目錄名稱。
  3. 接著請依照設定檔順序，產生相對檔案出來。
  4. $modversion['version'] 版本號寫法：1.0、2.3...均可，但1.0.1需寫成 1.01。
  5. $modversion['module_status']模組狀態可以是Alpha、Beta、RC、Release
  6. $modversion['adminmenu']後台選單的圖示為32x32，可從這裡下載：
  7. $modversion['sqlfile']['mysql']資料庫結構檔，可從phpMyAdmin直接匯出，不須加上前置字串 （XOOPS的資料表均有前置字串，每個網站都不同，正常安裝時可自設）。
  四、xoops_version.php 中的語系
  1. xoops_version.php 若有用到中文的部份，建議做成語系檔。
  2. xoops_version.php 的語系檔一律位於 language/tchinese_utf8/modinfo.php 中（不可自訂檔案或改檔名）
  3. 語系設定方法： define("_MI_語系名稱" , "對應的實際中文");
  4. 「_MI_語系名稱」是PHP常數，一般而言建議用底線開頭，並全部大寫，以容易識別（但其實無強制性）。
  5. _MI 是XOOPS建議的常數開頭。
  6. 一般 _MI 後面會加上模組名稱，以避免常數衝突，例如： _MI_TADHONOR_XXX 或者縮寫 _MI_TH_XXX