CMSimple_XH 開発者ドキュメント
XH\PageDataModel クラス

公開メンバ関数

 __construct (array $h, array $pageDataFields, array $tempData, array $pageData)
 
 storedFields ()
 
 refresh (array $data=null)
 
 addParam ($field)
 
 removeParam ($field)
 
 addTab ($title, $view_file, $cssClass=null)
 
 findKey ($key)
 
 findFieldValue ($field, $value)
 
 findArrayfieldValue ($field, $value, $separator)
 
 findFieldValueSortkey ($field, $value, $sortKey, $sortFlag, $sep)
 
 create (array $params=array())
 
 appendPage (array $params)
 
 replace (array $pages, $index)
 
 storeTemp (array $page)
 
 delete ($key)
 
 updateKey ($key, array $params)
 

フィールド

 $params
 
 $data
 
 $temp_data
 
 $tabs
 

詳解

PageDataModel.php28 行目に定義があります。

構築子と解体子

◆ __construct()

XH\PageDataModel::__construct ( array  $h,
array  $pageDataFields,
array  $tempData,
array  $pageData 
)

Constructs an instance.

引数
array$hThe page headings.
array$pageDataFieldsThe page data fields.
array$tempDataThe most recently deleted page data.
array$pageDataThe page data.

PageDataModel.php73 行目に定義があります。

関数詳解

◆ addParam()

XH\PageDataModel::addParam (   $field)

Registers a page data field.

引数
string$fieldThe page data field to add.
戻り値
void

PageDataModel.php155 行目に定義があります。

◆ addTab()

XH\PageDataModel::addTab (   $title,
  $view_file,
  $cssClass = null 
)

Registers a page data tab.

引数
string$titleThe title of the tab.
string$view_fileThe filename of the view.
string$cssClassA CSS class name.
戻り値
void

PageDataModel.php187 行目に定義があります。

◆ appendPage()

XH\PageDataModel::appendPage ( array  $params)

Appends a new page.

引数
array$paramsPage data of the page.
戻り値
void
から
1.6

PageDataModel.php311 行目に定義があります。

◆ create()

XH\PageDataModel::create ( array  $params = array())

Returns the page data for a new page, without actually creating the page.

引数
array$paramsDefault page data.
戻り値
array

PageDataModel.php292 行目に定義があります。

◆ delete()

XH\PageDataModel::delete (   $key)

Deletes the page data of a single page. Returns whether that succeeded.

引数
int$keyThe index of the page.
戻り値
bool

PageDataModel.php353 行目に定義があります。

◆ findArrayfieldValue()

XH\PageDataModel::findArrayfieldValue (   $field,
  $value,
  $separator 
)

Returns the page data of all pages which contain a value in a list field.

引数
string$fieldThe name of the field.
string$valueThe value to look for.
string$separatorThe list item separator.
戻り値
array

PageDataModel.php235 行目に定義があります。

◆ findFieldValue()

XH\PageDataModel::findFieldValue (   $field,
  $value 
)

Returns the page data of all pages which contain a value in a field.

引数
string$fieldThe name of the field.
mixed$valueThe value to look for.
戻り値
array

PageDataModel.php213 行目に定義があります。

◆ findFieldValueSortkey()

XH\PageDataModel::findFieldValueSortkey (   $field,
  $value,
  $sortKey,
  $sortFlag,
  $sep 
)

Returns the sorted page data of all pages, which contain a value in a (list) field.

引数
string$fieldThe name of the field.
string$valueThe value to look for.
string$sortKeyThe name of the field to sort by.
int$sortFlagThe sort options as for array_multisort().
string$sepThe list item separator.
戻り値
array

PageDataModel.php262 行目に定義があります。

◆ findKey()

XH\PageDataModel::findKey (   $key)

Returns the page data of a single page.

引数
int$keyThe index of the page.
戻り値
array

PageDataModel.php199 行目に定義があります。

◆ refresh()

XH\PageDataModel::refresh ( array  $data = null)

Replaces the existing page data.

引数
array$dataThe new page data.
戻り値
bool Whether the page data have been refreshed.

PageDataModel.php139 行目に定義があります。

◆ removeParam()

XH\PageDataModel::removeParam (   $field)

Removes a page data field.

引数
string$fieldA page data field to remove.
戻り値
void

PageDataModel.php168 行目に定義があります。

◆ replace()

XH\PageDataModel::replace ( array  $pages,
  $index 
)

Replaces the page data of a single page. Returns whether that succeeded.

引数
array$pagesThe new page data.
int$indexThe index of the page.
戻り値
bool

PageDataModel.php324 行目に定義があります。

◆ storedFields()

XH\PageDataModel::storedFields ( )

Returns all fields that are stored in the page data.

戻り値
array
から
1.6

PageDataModel.php91 行目に定義があります。

◆ storeTemp()

XH\PageDataModel::storeTemp ( array  $page)

Stores page data in the recycle bin.

引数
array$pageThe page data.
戻り値
void

PageDataModel.php337 行目に定義があります。

◆ updateKey()

XH\PageDataModel::updateKey (   $key,
array  $params 
)

Updates the page data of a single page and returns whether that succeeded.

引数
int$keyThe index of the page.
array$paramsThe dictionary of fields to update.
戻り値
bool

PageDataModel.php367 行目に定義があります。


このクラス詳解は次のファイルから抽出されました: