XOOPSのモジュール開発手順メモ
XOOPSのモジュール開発手順メモ
・モジュールを開発するためには、
1.モジュール構成を作る。
2.DBを作る
3.管理画面を作る
4.ブロックを作る
5.本体を作る
6.そのほかの機能を作る。
のステップを踏みます。
他のモジュールを参考にしながら以下にメモです。
まず、
[STEP１] モジュール構成を作る。
他のモジュールのフォルダを見ると、
「project_version.php」
なんてファイルがあると思いますが、これがxoopsモジュールの肝です。
このファイルには、色々なモジュールの情報が含まれています。
1.モジュール本体の情報
2.DBのテーブル
3.管理画面の項目
4.ブロックのプログラム情報
5.テンプレート
6.イベントの構成
これら全てを書き込む必要があるので、まずこの段階でモジュールの構成をしっかり検討しましょう。
[STEP2]DBを作る。
他のモジュールフォルダに「SQL」がありますよね。
これを参考にSQLファイルを作りましょう。重要なのは、[STEP１]で指定したDBのテーブル構成と一致している必要があるということです。
また、テーブル名は[STEP１]でもそうですが、XOOPSのテーブルサフィックスなしの情報を記載します。
[STEP３]管理画面の項目
管理画面は他のモジュールを参考にしてつくればすぐにつくれます。
一般設定を使用する場合は、プログラミング不要です。
[STEP1]で一般設定項目を指定すれば、画面が自動的に構成される仕組みです。
[STEP4]ブロックを作る。
ブロックは「block」なんてフォルダが他のモジュールにあると思います。
参考にしてください。これも[STEP１]と整合性が必要です。
[STEP１]では、どのブロックで、どのプログラムを使用して、どのテンプレートで表示するかを書いておきます。
その通りにプログラムを作らないと動きません。
また、ブロックのプログラムを作る場合、戻りは必ず配列でもどします。
これは、XOOPSがsmartyを使用して画面を表示する際に必要です。
また、忘れずにブロック用テンプレートも作ってください。[STEP1]でテンプレート名を指定していますので、ちゃんと整合性を合わせてください。
[STEP５]本体
xoopsのモジュール本体はindex.phpで作ってください。
本体用テンプレートが必要です。
他のモジュールを参考にします。
[STEP6]そのほかの機能
XOOPSにはサイト内検索の機能があります。
他のモジュールを参考にして、モジュール内のincludeフォルダにsearch.phpを作成します。
モジュールの検索対象を指定して、結果セットを返すようにます。
簡単なメモ書きですが、他のモジュールを参考にしてXOOPSモジュールの開発をしてみましょう！
大切なのは「XOOPS＿VERSION.PHP」というファイルです。
