CMSimple_XH 開発者ドキュメント
tplfuncs.php ファイル

[ソースコード]

名前空間

 XH
 

関数

 XH_renderPrevLink ()
 
 XH_renderNextLink ()
 
 head ()
 
 sitename ()
 
 pagename ()
 
 onload ()
 
 toc ($start=null, $end=null, $li='li')
 
 li (array $ta, $st)
 
 XH_buildHc ()
 
 searchbox ()
 
 sitemaplink ()
 
 printlink ()
 
 XH_printUrl ()
 
 mailformlink ()
 
 loginlink ()
 
 lastupdate ($br=null, $hour=null)
 
 locator ()
 
 editmenu ()
 
 content ()
 
 submenu ($html='')
 
 previouspage ()
 
 nextpage ()
 
 top ($id='TOP')
 
 languagemenu ()
 
 XH_emergencyTemplate ()
 
 poweredByLink ($linktext='')
 

詳解

Template functions.

tplfuncs.php に定義があります。

関数詳解

◆ content()

content ( )

Returns the contents area.

戻り値
string HTML

int The index of the current page. string The output of the contents area. array The content of the pages. bool Whether edit mode is active.

tplfuncs.php464 行目に定義があります。

◆ editmenu()

editmenu ( )

Returns the admin menu.

Returns an empty string since XH 1.5, as the admin menu is automatically inserted to the template.

戻り値
string HTML
参照
XH_adminMenu()
非推奨:
since 1.7. Just remove from the template.

tplfuncs.php447 行目に定義があります。

◆ head()

head ( )

Returns the complete HEAD element.

戻り値
string HTML

string The page title. array The configuration of the core. array The paths of system files and folders. array The localization of the core. string HTML to be inserted to the HEAD Element.

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

◆ languagemenu()

languagemenu ( )

Returns the language menu.

戻り値
string HTML

array The paths of system files and folders. array The configuration of the core. string The current language.

tplfuncs.php597 行目に定義があります。

◆ lastupdate()

lastupdate (   $br = null,
  $hour = null 
)

Returns the date of the last update of the site.

引数
bool$brWhether to emit a br element between text and date.
int$hourThe time correction in hours.
戻り値
string HTML

array The localization of the core. array The paths of system files and folders.

tplfuncs.php389 行目に定義があります。

◆ li()

li ( array  $ta,
  $st 
)

Returns a menu structure of certain pages.

引数
array$taThe indexes of the pages.
mixed$stThe menu level to start with or the type of menu.
戻り値
string HTML

tplfuncs.php217 行目に定義があります。

◆ locator()

locator ( )

Returns the locator (breadcrumb navigation).

戻り値
string HTML

tplfuncs.php410 行目に定義があります。

◆ loginlink()

loginlink ( )

Returns the link to the login form.

int The index of the requested page. array The localization of the core.

戻り値
string HTML

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

◆ mailformlink()

mailformlink ( )

Returns the link to the mail form.

戻り値
string HTML

array The configuration of the core.

tplfuncs.php350 行目に定義があります。

◆ nextpage()

nextpage ( )

Returns a link to the next page

戻り値
string HTML

array The localization of the core.

参照
previouspage()

tplfuncs.php559 行目に定義があります。

◆ onload()

onload ( )

Returns the onload attribute for the body element.

戻り値
string HTML

string JavaScript for the onload attribute of the BODY element.

tplfuncs.php138 行目に定義があります。

◆ pagename()

pagename ( )

Returns the global site title.

戻り値
string HTML

array The configuration of the core.

tplfuncs.php123 行目に定義があります。

◆ poweredByLink()

poweredByLink (   $linktext = '')

Creates the link to the generated page "Site/CMS Info".

One of the 3 functions to create "Site/CMS Info".

引数
string$linktextThe text to be displayed as the link in the template.
戻り値
string The link.

string The site (script) name.

から
1.7

tplfuncs.php671 行目に定義があります。

◆ previouspage()

previouspage ( )

Returns a link to the previous page.

戻り値
string HTML

array The localization of the core.

参照
nextpage()

tplfuncs.php540 行目に定義があります。

◆ printlink()

printlink ( )

Returns the link for the print view.

戻り値
string HTML

array The localization of the core.

tplfuncs.php305 行目に定義があります。

◆ searchbox()

searchbox ( )

Returns the search form.

戻り値
string HTML

string The script name. array The localization of the core.

tplfuncs.php272 行目に定義があります。

◆ sitemaplink()

sitemaplink ( )

Returns the sitemap link.

戻り値
string HTML

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

◆ sitename()

sitename ( )

Returns the language dependend site title.

戻り値
string HTML

array The localization of the core.

tplfuncs.php108 行目に定義があります。

◆ submenu()

submenu (   $html = '')

Returns the submenu of a page.

引数
string$htmlOptional markup to wrap the heading.
戻り値
string HTML

int The index of the current page. int The number of pages. array The menu levels of the pages. array The localization of the core. array The configuration of the core.

tplfuncs.php497 行目に定義があります。

◆ toc()

toc (   $start = null,
  $end = null,
  $li = 'li' 
)

Returns the table of contents.

引数
int$startThe menu level to start with.
int$endThe menu level to end with.
callable$liA callback that actually creates the view.
戻り値
string HTML

int The number of pages. int The index of the current page. array The menu levels of the pages. array The configuration of the core.

tplfuncs.php160 行目に定義があります。

◆ top()

top (   $id = 'TOP')

Returns a link to the top of the page.

To work, an appropriate ID has to be defined in the template.

引数
string$idAn (X)HTML ID.
戻り値
string HTML

array The localization of the core.

tplfuncs.php580 行目に定義があります。

◆ XH_buildHc()

XH_buildHc ( )

Sets global variables for CSS/DHTML menus.

The most important variable is $hc, which is an array of page indexes of the pages of the menu. This is normally passed as first argument to li(), e.g. li($hc). $hl holds the number of these pages. $si holds the index of the current page within $hc; it might be useful for advanced menus.

戻り値
void

int The number of pages. int The current page index. array The configuration of the core. int The index of the current page in $hc. array The page indexes of the visible menu items. int The length of $hc.

から
1.6.2

tplfuncs.php243 行目に定義があります。

◆ XH_emergencyTemplate()

XH_emergencyTemplate ( )

Provides a minimal template (in case template isn't found).

戻り値
void
から
1.6.3

tplfuncs.php641 行目に定義があります。

◆ XH_printUrl()

XH_printUrl ( )

Returns the URL of the print view.

戻り値
string

string The requested special function. string The current search string. string The requested special file. string The script name.

から
1.6

tplfuncs.php325 行目に定義があります。

◆ XH_renderNextLink()

XH_renderNextLink ( )

Renders the next link.

戻り値
string HTML

string The script name. array The page URLs.

から
1.6.3

tplfuncs.php50 行目に定義があります。

◆ XH_renderPrevLink()

XH_renderPrevLink ( )

Renders the prev link.

戻り値
string HTML

string The script name. array The page URLs.

から
1.6.3

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