MSM_PluginBlockクラス
MSM_PluginBlockクラスは、すべてのプラグインブロックの基底クラスです。PUBLISのプラグインクラスは通常このクラスを継承して作成します。以下の表で、サブクラスに関連するMSM_PluginBlockのメソッドとプロパティについて説明します。
MSM_Block のメソッド
メソッド名 |
引数 |
戻り値 |
説明 |
---|---|---|---|
MSM_PluginBlock [public] |
$blockId ブロックID |
なし |
コンストラクタ。生成するブロックオブジェクトのIDを引数にとる。 |
getHtml [public] |
$db データベースオブジェクト $page ページオブジェクト $mode 編集中モード |
ブロックのHTML |
プラグイン未指定の場合のメッセージ表示のHTMLを返却する。 MSM_Block::getHtmlメソッドをオーバーライドする。 |
getHeadHtml [public] |
$db データベースオブジェクト $page ページオブジェクト $mode 編集中モード |
ページのHEAD要素内に出力するHTML |
プラグインブロックでは、デフォルトでJavascriptを使用しないため、空を返す。 MSM_Block::getHeadHtmlメソッドをオーバーライドする。仮に、Javascriptを使用するプラグインを作成する場合は、このメソッドをオーバーライドする。 |
getButtons [public] |
$db データベースオブジェクト $permissionDetail 未使用 |
編集ページの、ブロックの操作アイコンHTML |
編集ページに表示されるプラグインブロックの操作アイコンのHTMLを返却する。 プラグインに設定を持つ場合は、このメソッドをオーバーライドして、設定画面を呼び出すアイコンを追加する必要がある。 |
getTypeName [public] |
なし |
ブロックの名称 |
ブロックの名称を返却する。 |
Write [public] |
$_data ブロックのデータを格納した連想配列 |
なし |
ページツリーインポートエクスポート用データ書き込みメソッド |
MSM_PluginBlock のプロパティ
なし