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

公開メンバ関数

 __construct (array $h, array $pageDataFields, array $tempData, array $pageData)
 
 storedFields ()
 
 getCurrentInterests ()
 
 add_interest ($field)
 
 removeInterest ($field)
 
 add_tab ($tab_name, $tab_view, $cssClass=null)
 
 refresh (array $data=null)
 
 find_page ($id)
 
 find_all ()
 
 new_page (array $params=array())
 
 appendNewPage (array $params=array())
 
 insert (array $pages, $index)
 
 destroy ($key)
 
 find_field_value ($field, $value, $separator=null)
 
 find_field_value_sortkey ($field, $value, $sortKey, $sortFlag=null, $sep=null)
 
 refresh_from_texteditor (array $headings, $index)
 
 update ($s, array $params)
 
 create_tabs ($s)
 
 headAsPHP ()
 
 pageAsPHP ($id)
 

詳解

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

構築子と解体子

◆ __construct()

XH\PageDataRouter::__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.

PageDataRouter.php52 行目に定義があります。

関数詳解

◆ add_interest()

XH\PageDataRouter::add_interest (   $field)

Registers a field for the page data.

引数
string$fieldThe name of the page data field.
戻り値
void

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

◆ add_tab()

XH\PageDataRouter::add_tab (   $tab_name,
  $tab_view,
  $cssClass = null 
)

Registers a page data tab.

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

PageDataRouter.php129 行目に定義があります。

◆ appendNewPage()

XH\PageDataRouter::appendNewPage ( array  $params = array())

Appends a new page.

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

PageDataRouter.php198 行目に定義があります。

◆ create_tabs()

XH\PageDataRouter::create_tabs (   $s)

Returns the page data tab views.

引数
int$sThe index of the page.

bool string string string object The publisher.

戻り値
string HTML

PageDataRouter.php386 行目に定義があります。

◆ destroy()

XH\PageDataRouter::destroy (   $key)

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

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

PageDataRouter.php224 行目に定義があります。

◆ find_all()

XH\PageDataRouter::find_all ( )

Returns the page data of all pages.

戻り値
array

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

◆ find_field_value()

XH\PageDataRouter::find_field_value (   $field,
  $value,
  $separator = null 
)

Returns an array of all pages containing $value in $field.

If $separator is given the $field will be translated to an array

  • explode($separator, $value) - before the search.
引数
string$fieldThe name of the field.
string$valueThe value to look for.
string$separatorThe list item separator.
戻り値
array

PageDataRouter.php242 行目に定義があります。

◆ find_field_value_sortkey()

XH\PageDataRouter::find_field_value_sortkey (   $field,
  $value,
  $sortKey,
  $sortFlag = null,
  $sep = null 
)

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

PageDataRouter.php266 行目に定義があります。

◆ find_page()

XH\PageDataRouter::find_page (   $id)

Returns the page data of a single page.

引数
int$idThe page index.
戻り値
array

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

◆ getCurrentInterests()

XH\PageDataRouter::getCurrentInterests ( )

Returns the currently registered interests.

Must not be called before all plugins have been loaded.

戻り値
array
から
1.6

PageDataRouter.php78 行目に定義があります。

◆ headAsPHP()

XH\PageDataRouter::headAsPHP ( )

Returns the global page data arrays as a PHP tag.

戻り値
string The PHP tag.
から
1.6

PageDataRouter.php430 行目に定義があります。

◆ insert()

XH\PageDataRouter::insert ( 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

PageDataRouter.php212 行目に定義があります。

◆ new_page()

XH\PageDataRouter::new_page ( array  $params = array())

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

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

PageDataRouter.php182 行目に定義があります。

◆ pageAsPHP()

XH\PageDataRouter::pageAsPHP (   $id)

Returns the page data of a single page as PHP tag.

引数
int$idThe index of the page.
戻り値
string The PHP tag.
から
1.6

PageDataRouter.php459 行目に定義があります。

◆ refresh()

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

Replaces the existing page data.

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

PageDataRouter.php142 行目に定義があります。

◆ refresh_from_texteditor()

XH\PageDataRouter::refresh_from_texteditor ( array  $headings,
  $index 
)

Updates the page data according to changes from the online editor. Returns whether that succeeded.

引数
array$headingsThe page headings contained in the current edit.
int$indexThe page index.
戻り値
bool

PageDataRouter.php284 行目に定義があります。

◆ removeInterest()

XH\PageDataRouter::removeInterest (   $field)

Unregisters a field for the page data. To permanently remove the field, one has to call XH_saveContents() subsequently.

引数
string$fieldA page data field name.
戻り値
void
から
1.6

PageDataRouter.php110 行目に定義があります。

◆ storedFields()

XH\PageDataRouter::storedFields ( )

Returns all fields that are stored in the page data.

戻り値
array
から
1.6

PageDataRouter.php64 行目に定義があります。

◆ update()

XH\PageDataRouter::update (   $s,
array  $params 
)

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

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

PageDataRouter.php361 行目に定義があります。


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