モジュール開発情報 - xoops_version.phpの書式

・モジュールの名前を指定します。
$modversion['name'] = 'モジュール名';

・モジュールのバージョンを指定します。
$modversion['version'] = 1.0;

・モジュールの説明を指定します。
$modversion['description'] = 'モジュールの説明';

・モジュールに関する貢献者や謝辞について記述します。
$modversion['credits'] = 'クレジット';

・モジュールの作者の情報を指定します。
$modversion['author'] = '作者情報';

・モジュールのライセンス形式を指定します。
$modversion['license'] = 'ライセンス';

・モジュールが公式モジュールか非公式モジュールかを指定します。1が公式モジュール、0が非公式モジュールです。
$modversion['official'] = 0;

・管理画面で表示されるモジュールのアイコン画像を指定します。
$modversion['image'] = 'images/logo.png';

・モジュールのディレクトリ名を指定します。
$modversion['dirname'] = 'ディレクトリ名';

・モジュールが使用するテーブルのCREATE文を定義したSQLファイルを指定します。
$modversion['sqlfile']['mysql'] = 'sql/mysql.sql';

・モジュールが使用するテーブルのテーブル名を指定します。
$modversion['tables'][0] = 'table_name1';
(複数のテーブルを使用する場合は、配列のインデックスに連番を振ります)

・モジュールが管理画面を持つ場合、1を指定します。
$modversion['hasAdmin'] = 1;

・管理画面のトップページを指定します。
$modversion['adminindex'] = 'admin/index.php';

・管理画面のメニュー情報定義ファイルを指定します。
$modversion['adminmenu'] = 'admin/menu.php';

・モジュールの管理画面の一般設定で表示する設定項目の識別子、表題、説明、表示形式、値の型、デフォルト値を指定します。
$modversion['config'][1]['name'] = 'config';
$modversion['config'][1]['title'] = '表題';
$modversion['config'][1]['description'] = '説明';
$modversion['config'][1]['formtype'] = 'yesno';
$modversion['config'][1]['valuetype'] = 'int';
$modversion['config'][1]['default'] = 1;
(複数の設定項目を使用する場合は、配列のインデックスに連番を振ります)

※詳細については「管理画面の表示」のページで解説します

・モジュールがメインメニューを持つ場合、1を指定します。
$modversion['hasMain'] = 1;

・サブメニューの名前と遷移先のPHPプログラムのファイル名を指定します。
$modversion['sub'][1]['name'] = 'サブメニュー名';
$modversion['sub'][1]['url'] = 'sub.php';
(複数のサブメニューを使用する場合は、配列のインデックスに連番を振ります)

・テンプレートのファイル名と説明を指定します。
$modversion['templates'][1]['file'] = 'template.html';
$modversion['templates'][1]['description'] = '説明';
(複数のテンプレートを使用する場合は、配列のインデックスに連番を振ります)

・ブロックの処理を記述したPHPプログラムのファイル名、ブロックの名前、説明、表示処理を実装した関数名、ブロックオプション、編集処理を実装した関数名、テンプレートファイル名を指定します。
$modversion['blocks'][1]['file'] = 'block.php';
$modversion['blocks'][1]['name'] = 'ブロック名';
$modversion['blocks'][1]['description'] = '説明';
$modversion['blocks'][1]['show_func'] = 'b_show';
$modversion['blocks'][1]['options'] = '1|10|100';
$modversion['blocks'][1]['edit_func'] = 'b_edit';
$modversion['blocks'][1]['template'] = 'block_template.html';
(複数のブロックを使用する場合は、配列のインデックスに連番を振ります)

※詳細については「ブロックの表示」のページで解説します

・モジュールがXOOPSの検索機能を利用する場合、1を指定します。
$modversion['hasSearch'] = 1;

・検索処理を記述したPHPプログラムのファイル名、関数名を指定します。
$modversion['search']['file'] = 'include/search.inc.php';
$modversion['search']['func'] = 'search';

※詳細については「検索機能」のページで解説します

・モジュールがXOOPSのコメント機能を利用する場合、1を指定します。
$modversion['hasComments'] = 1;

・コメント投稿フォームを表示するPHPプログラムのファイル名を指定します。
$modversion['comments']['pageName'] = 'article.php';

・コメントを付ける記事を特定するためのパラメーター名を指定します。
$modversion['comments']['itemName'] = 'id';

・コメント投稿時の追加パラメーターを配列で指定します。
$modversion['comments']['extraParams'] = array('param1', 'param2');

・コメントに関するイベント(掲載の承認、コメント数の更新)が発生時に実行する処理を記述したPHPプログラムのファイル名を指定します。
$modversion['comments']['callbackFile'] = 'include/comment_callback.php';

・コメント掲載承認イベント発生時に実行する処理の関数名を指定します。
$modversion['comments']['callback']['approve'] = 'comment_approve';

・コメント数更新イベント発生時に実行する処理の関数名を指定します。
$modversion['comments']['callback']['update'] = 'comment_update';

※詳細については「コメント機能」のページで解説します

・モジュールがXOOPSのイベント通知機能を利用する場合、1を指定します。
$modversion['hasNotification'] = 1;

・イベント通知処理を記述したPHPプログラムのファイル名、関数名を指定します。
$modversion['notification']['lookup_file'] = 'include/notification.inc.php';
$modversion['notification']['lookup_func'] = 'notify';

・イベントのカテゴリー情報(カテゴリー名、表題、説明、イベント発生元のPHPプログラムのファイル名、イベント発生元の識別子の項目名、ブックマーク許可フラグ)を指定します。
$modversion['notification']['category'][1]['name'] = 'category';
$modversion['notification']['category'][1]['title'] = '表題';
$modversion['notification']['category'][1]['description'] = '説明';
$modversion['notification']['category'][1]['subscribe_from'] = array('subscribe.php');
$modversion['notification']['category'][1]['item_name'] = 'subscribe_id';
$modversion['notification']['category'][1]['allow_bookmark'] = 1;
(複数のカテゴリーを使用する場合は、配列のインデックスに連番を振ります)

・イベント情報(イベント名、所属カテゴリー名、表題、キャプション、説明、管理者フラグ、非表示フラグ、イベント通知メールのテンプレートファイル名、イベント通知メールの件名)を指定します。
$modversion['notification']['event'][1]['name'] = 'new_post';
$modversion['notification']['event'][1]['category'] = 'category';
$modversion['notification']['event'][1]['title'] = '表題';
$modversion['notification']['event'][1]['caption'] = 'キャプション';
$modversion['notification']['event'][1]['description'] = '説明';
$modversion['notification']['event'][1]['admin_only'] = 1;
$modversion['notification']['event'][1]['invisible'] = 1;
$modversion['notification']['event'][1]['mail_template'] = 'template';
$modversion['notification']['event'][1]['mail_subject'] = _'イベント通知メールの件名';
(複数のイベントを使用する場合は、配列のインデックスに連番を振ります)

※詳細については「イベント通知機能」のページで解説します