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

公開メンバ関数

 __construct ()
 
 isHidden ($n)
 
 getCount ()
 
 heading ($n)
 
 name ($n)
 
 url ($n)
 
 level ($n)
 
 content ($n)
 
 toplevels ($ignoreHidden=true)
 
 children ($n, $ignoreHidden=true)
 
 parent ($n, $ignoreHidden=true)
 
 getAncestorsOf ($pageIndex, $ignoreHidden=true)
 
 pageWithHeading ($heading)
 
 linkList ($prefix='', $ignoreHidden=true)
 

詳解

Pages.php27 行目に定義があります。

構築子と解体子

◆ __construct()

XH\Pages::__construct ( )

Constructs an instance.

array The headings of the pages. array The URLs of the pages. array The menu levels of the pages. array The contents of the pages.

Pages.php82 行目に定義があります。

関数詳解

◆ children()

XH\Pages::children (   $n,
  $ignoreHidden = true 
)

Returns an array of indexes of direct children of a page.

引数
int$nA page index.
bool$ignoreHiddenWhether hidden pages should be ignored.
戻り値
array of int

array The configuration of the core.

Pages.php216 行目に定義があります。

◆ content()

XH\Pages::content (   $n)

Returns the content of a page.

引数
int$nA page index.
戻り値
string

Pages.php181 行目に定義があります。

◆ getAncestorsOf()

XH\Pages::getAncestorsOf (   $pageIndex,
  $ignoreHidden = true 
)

Returns the page indexes of all ancestors of a certain page.

The order of the result is unspecified.

引数
int$pageIndexA page index.
bool$ignoreHiddenWhether hidden pages should be ignored.
戻り値
array

Pages.php268 行目に定義があります。

◆ getCount()

XH\Pages::getCount ( )

Returns the number of pages.

戻り値
int

Pages.php112 行目に定義があります。

◆ heading()

XH\Pages::heading (   $n)

Returns the heading of a page.

引数
int$nA page index.
戻り値
string
参照
name()

Pages.php126 行目に定義があります。

◆ isHidden()

XH\Pages::isHidden (   $n)

Returns whether a page is hidden.

CAVEAT: this is not realiable during the loading of plugins.

引数
int$nA page index.
戻り値
bool

Pages.php102 行目に定義があります。

◆ level()

XH\Pages::level (   $n)

Returns the menu level of a page.

引数
int$nA page index.
戻り値
int

Pages.php169 行目に定義があります。

◆ linkList()

XH\Pages::linkList (   $prefix = '',
  $ignoreHidden = true 
)

Returns an array of pairs of heading/link of all pages. Can be used to build the internal link list for tinyMCE and CKEditor as well as respective selectboxes for other plugins.

引数
string$prefixA prefix for every heading.
bool$ignoreHiddenWhether hidden pages shall be ignored.
戻り値
array

Pages.php309 行目に定義があります。

◆ name()

XH\Pages::name (   $n)

Returns the name of a page.

The name of a page is its heading sans any HTML tags, and with all HTML entities decoded, i.e. the plain text version of the heading.

引数
int$nA page index.
戻り値
string
参照
heading()
から
1.7

Pages.php145 行目に定義があります。

◆ pageWithHeading()

XH\Pages::pageWithHeading (   $heading)

Returns the index of the first page with the heading $heading.

引数
string$headingThe heading of the page.
戻り値
int The index of the page, or -1 if not found.

Pages.php289 行目に定義があります。

◆ parent()

XH\Pages::parent (   $n,
  $ignoreHidden = true 
)

Returns the index of the parent page of a page. Returns null, if $n is a toplevel page.

引数
int$nA page index.
bool$ignoreHiddenWhether hidden pages should be ignored.
戻り値
int

Pages.php246 行目に定義があります。

◆ toplevels()

XH\Pages::toplevels (   $ignoreHidden = true)

Returns an array of indexes of the toplevel pages.

引数
bool$ignoreHiddenWhether hidden pages should be ignored.
戻り値
array

Pages.php193 行目に定義があります。

◆ url()

XH\Pages::url (   $n)

Returns the URL of a page.

引数
int$nA page index.
戻り値
string

Pages.php157 行目に定義があります。


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