Function_Reference - xmobile for XOOPS Wiki - xmobile for XOOPS

class XmobilePluginHandler

このクラスの元となるファイルは、class/Plugin.class.php です。各プラグインのファイルはここに記載されている関数をオーバーライドして動作しています。プラグイン製作者は、この元関数をコピーしカスタマイズする事によって各モジュール固有の動作を生み出します。また、デフォルト状態で問題ない場合は、不要なオーバーライドを避ける事によりプラグインのソースを極力小さく保てます。

$template

概要：プラグイン用のテンプレートファイル名をセットします。 xmobile/templates フォルダ内に設置したファイルを記載します。

$itemTableName

概要：データベース・テーブル名を記載します。XOOPSプリフィックスは不要です。

---

getCatList()

概要：カテゴリ一覧の取得。オブジェクトとして取得し、smarty変数にセットします。

getConfirmView()

概要：getEditView()により表示された入力フォームへのサブミットにより呼び出され、POSTされた入力データに関する処理を行います。キャンセル処理や入力値確認・保存実行等を行い結果の表示をsmarty変数の'item_detail'にセットし処理を終了します。以下はsaveEntry関数で保存を行いその結果を返す例です。

$this->controller->render->template->assign('item_detail',$this->saveEntry());

getEditLink()

概要：コンテンツ下部に編集用のリンク表示を行います。

getEditView()

概要：編集用画面全体の描画を行います。但し、formタグ中の実際の入力項目はテンプレート上に記述しこの関数内では smarty 変数(例:show_edit)にtrueをセットするに留めます。

　$this->controller->render->template->assign('show_edit',true);

実際の記述は、各プラグインモジュール用のテンプレート(xmobile_プラグイン名.html)にて記述します。

getForm()

概要：getEditViewから呼び出され、フォーム入力内容の描画を行います。

getDefaultView()

概要：初期画面

getListView()

概要：一覧画面

getDetailView()

概要：詳細画面

getItemList()

概要：一覧画面。現在選択中の条件（ setItemCriteria 関数による）で表示可能なレコードの一覧を取得します。返値は配列変数

$item_list[$i]['key'] １からのカウント順
$item_list[$i]['title'] 整形（adjustTitle関数）済みタイトル文字列
$item_list[$i]['url'] URLパラメータ
$item_list[$i]['date'] 日時

これ以外の状態表示を行いたい場合は、関数をオーバーライドし独自に作成します。

getRecentList()

概要：初期画面の最新のコンテンツ・リスト

setItemCriteria()

概要：初期値セット。 GET/POST変数からデータを取得は$this->utils->getGetPost()関数を使用しクラス内変数へセットします。 また、 item_criteria 関数を使用して、取得したパラメータを元にWHERE条件をこの関数内で設定します。

setNextViewState($nextViewState)

概要：次に進むべきアクションの指定。 $nextViewState = confirm(入力確認) / detail(詳細表示) / list(一覧表示)