Pages.php の 27 行目に定義があります。
◆ __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.php の 82 行目に定義があります。
◆ children()
XH\Pages::children |
( |
|
$n, |
|
|
|
$ignoreHidden = true |
|
) |
| |
Returns an array of indexes of direct children of a page.
- 引数
-
int | $n | A page index. |
bool | $ignoreHidden | Whether hidden pages should be ignored. |
- 戻り値
- array of int
array The configuration of the core.
Pages.php の 216 行目に定義があります。
◆ content()
Returns the content of a page.
- 引数
-
- 戻り値
- string
Pages.php の 181 行目に定義があります。
◆ 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 | $pageIndex | A page index. |
bool | $ignoreHidden | Whether hidden pages should be ignored. |
- 戻り値
- array
Pages.php の 268 行目に定義があります。
◆ getCount()
Returns the number of pages.
- 戻り値
- int
Pages.php の 112 行目に定義があります。
◆ heading()
◆ isHidden()
Returns whether a page is hidden.
CAVEAT: this is not realiable during the loading of plugins.
- 引数
-
- 戻り値
- bool
Pages.php の 102 行目に定義があります。
◆ level()
Returns the menu level of a page.
- 引数
-
- 戻り値
- int
Pages.php の 169 行目に定義があります。
◆ 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 | $prefix | A prefix for every heading. |
bool | $ignoreHidden | Whether hidden pages shall be ignored. |
- 戻り値
- array
Pages.php の 309 行目に定義があります。
◆ name()
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.
- 引数
-
- 戻り値
- string
- 参照
- heading()
- から
- 1.7
Pages.php の 145 行目に定義があります。
◆ pageWithHeading()
XH\Pages::pageWithHeading |
( |
|
$heading | ) |
|
Returns the index of the first page with the heading $heading.
- 引数
-
string | $heading | The heading of the page. |
- 戻り値
- int The index of the page, or -1 if not found.
Pages.php の 289 行目に定義があります。
◆ 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 | $n | A page index. |
bool | $ignoreHidden | Whether hidden pages should be ignored. |
- 戻り値
- int
Pages.php の 246 行目に定義があります。
◆ toplevels()
XH\Pages::toplevels |
( |
|
$ignoreHidden = true | ) |
|
Returns an array of indexes of the toplevel pages.
- 引数
-
bool | $ignoreHidden | Whether hidden pages should be ignored. |
- 戻り値
- array
Pages.php の 193 行目に定義があります。
◆ url()
Returns the URL of a page.
- 引数
-
- 戻り値
- string
Pages.php の 157 行目に定義があります。
このクラス詳解は次のファイルから抽出されました: