リファレンス2
1. Legacy_ActionForm
2. XCube_PageNavigator
3. Legacy_AbstractModule
4. Legacy_BlockProcedure
Legacy_ActionFormクラス
アクション時の値の受け取りや入力検査を実施可能にします。
ファイル場所:/module/legacy/kernel/Legacy_ActionForm.class.php(但し実体は、親クラスのXCube_ActionFormの中にある。)
Legacy_ActionForm | ||||||||||||
主なメンバ変数 | ||||||||||||
$mFormProperties | フォームの型をセットする配列。
型ごとのクラス名を以下に記載します。 XCube_BoolProperty : Bool型 XCube_BoolArrayProperty : Bool型の配列 XCube_IntProperty : 数値型 XCube_IntArrayProperty : 数値型の配列 XCube_FloatProperty : 小数点型 XCube_FloatArrayProperty : 小数点型の配列 XCube_StringProperty : 文字列型 XCube_StringArrayProperty : 文字列型の配列 XCube_TextProperty : テキスト型 XCube_TextArrayProperty : テキスト型の配列 XCube_FileProperty : ファイル XCube_FileArrayProperty : ファイルの配列 XCube_ImageFileProperty : イメージファイル XCube_ImageFileArrayProperty : イメージファイルの配列 使用方法は(例)$this->mFormProperties['name']= new XCube_StringProperty('name'); |
|||||||||||
$mFieldProperties | 入力検査をセットする配列。
入力検査のタイプを以下に記載します。 required : 入力必須 minlength : 最小文字数 maxlength : 最大文字数型 min : 最小値 max : 最大値 intRange : 数値の範囲 email : メールアドレス mask : 正規表現 extension : 拡張子 maxfilesize : ファイルサイズ 使用方法は(例)$this->mFieldProperties['name']->setDependsByArray(array('required, 'maxlength'')); |
|||||||||||
$mErrorFlg | エラー判定のフラグ。 | |||||||||||
$mErrorMessages | エラーメッセージをセットする配列。 | |||||||||||
主なメンバ関数 | ||||||||||||
Legacy_ActionForm() |
|
|||||||||||
prepare() |
|
|||||||||||
set() |
|
|||||||||||
get($key, $index=null) |
|
|||||||||||
fetch() |
|
|||||||||||
validate() |
|
|||||||||||
hasError() |
|
|||||||||||
addErrorMessage($message) |
|
|||||||||||
getErrorMessages() |
|
XCube_PageNavigatorクラス
ページナビを作成する場合に使用する。
ファイル場所:/core/XCube_PageNavigator.class.php
XCube_PageNavigator | ||||||||||
主なメンバ変数 | ||||||||||
$mStart | 取得開始する行数 | |||||||||
$mTotalItems | 全部の行数 | |||||||||
$mPerpage | 取得する行数 | |||||||||
$mUrl | ページナビのURL | |||||||||
$mFetch | デリゲートオブジェクト | |||||||||
主なメンバ関数 | ||||||||||
XCube_PageNavigator($url, $flags=XCUBE_PAGENAVI_START) |
|
|||||||||
fetch() |
|
|||||||||
setTotalItems($total) |
|
|||||||||
getTotalItems() |
|
|||||||||
getTotalPages() |
|
|||||||||
getCurrentPage() |
|
|||||||||
hasPrivPage() |
|
|||||||||
getPrivStart() |
|
|||||||||
hasNextPage() |
|
|||||||||
getNextStart() |
|
Legacy_AbstractModuleクラス
モジュール作成時、各種コントロールやレンダーシステムの使用が可能にするようにします。(Legacy_ModuleAdapterクラスを使用することも可能。Legacy_ModuleAdapterの親クラスはLegacy_AbstractModule)
ファイル場所:/module/legacy/kernel/Legacy_Module.class.php
Legacy_AbstractModule | ||||||||||
主なメンバ変数 | ||||||||||
$mAttributes | 配列。setArreibute()で値がセットされる。 | |||||||||
$mModuleConfig | $xoopsModuleConfigがセットされます。 | |||||||||
$mRender | レンダーターゲットオブジェクトがセットされます。 | |||||||||
主なメンバ関数 | ||||||||||
Legacy_AbstractModule($module) |
|
|||||||||
setModuleGoncig($config) |
|
|||||||||
getRenderSystem() |
|
|||||||||
hasAdminIndex() |
|
|||||||||
getAdminIndex() |
|
|||||||||
getAdminMenu() |
|
|||||||||
setAttribute($key, $value) |
|
|||||||||
hasAttribute($key) |
|
|||||||||
getAttribute($key) |
|
|||||||||
getRenderTarget() |
|
Legacy_BlockProcedureクラス
ブロック作成時に継承が必要なクラスです。
ファイル場所:/module/legacy/kernel/Legacy_BlockProcedure.class.php
Legacy_BlockProcedure | ||||||
主なメンバ変数 | ||||||
$mRender | レンダーターゲットオブジェクトがセットされます。 | |||||
$_mBlock | ブロックオブジェクトがセットされます。 | |||||
主なメンバ関数 | ||||||
Legacy_BlockProcedure(&$block) |
|
|||||
execute() |
|
|||||
getOptionForm() |
|
|||||
getTitle() |
|
|||||
getEntryIndex() |
|
|||||
getName() |
|
|||||
getWeight() |
|
|||||
getId() |
|
|||||
getRenderTarget() |
|