ぜろちゃんねる
機能拡張プラグインマニュアル
version.0.10
はじめに
機能拡張プラグインとはぜろちゃんねるの通常動作に加えて、機能を追加するものです。
プラグインファイル
ファイル名は 0ch_[任意の名前].pl としてください。
システムはこのファイル名で、プラグインであることを認識します。
また、上記ファイルが test/plugin ディレクトリに格納されている必要があります。
インタフェイス
プラグインは以下に示す公開メソッドが実装必須となっています。
また、パッケージ名は ZERO_PLUGIN としてください。
new
プラグインオブジェクトのコンストラクタ。
プラグインはすべてインスタンスを生成して実行されるので実装してください。
getName()
プラグインの機能名を取得。
機能の名称を返してください。管理画面の機能名表示など使用されます。
getExplanation()
プラグインの説明を取得。
機能の簡単な説明を返してください。管理画面の説明表示など使用されます。
getType()
プラグインの呼び出しタイプを取得。
プラグインが呼び出される個所に応じて以下の表に示す値を返します。複数箇所で呼ばれるプラグインは返す値の論理和
を取ったものを返してください。
返す値 | 呼び出しタイミング |
1 | スレッド作成時 |
2 | レス書き込み時 |
4 | read.cgi呼び出し時 |
8 | index.cgi作成時 |
execute($Sys : MELKOR,$Form : SAMWISE)
プラグインを実行します。
プラグインの機能を実装してください。
戻り値として正常終了したときは0を、異常終了したときは0以外を返してください。
※現在は、戻り値についてはみていません。なにが返されても処理を続行します。
注意
現在プラグイン動作に関してのシステム側での充分なエラーチェックはしていません。
動作に関して充分にテストした上で使用してください。
また、不用意に見知らぬプラグインを導入して有効にすることは避けてください。