tplfuncs.php File Reference

Functions
	XH_renderPrevLink ()
	Renders the prev link. More...
	XH_renderNextLink ()
	Renders the next link. More...
	head ()
	Returns the complete HEAD element. More...
	sitename ()
	Returns the language dependend site title. More...
	pagename ()
	Returns the global site title. More...
	onload ()
	Returns the onload attribute for the body element. More...
	toc ($start=null, $end=null, $li='li')
	Returns the table of contents. More...
	li (array $ta, $st)
	Returns a menu structure of certain pages. More...
	XH_buildHc ()
	Sets global variables for CSS/DHTML menus. More...
	searchbox ()
	Returns the search form. More...
	sitemaplink ()
	Returns the sitemap link. More...
	printlink ()
	Returns the link for the print view. More...
	XH_printUrl ()
	Returns the URL of the print view. More...
	mailformlink ()
	Returns the link to the mail form. More...
	loginlink ()
	Returns the link to the login form. More...
	lastupdate ($br=null, $hour=null)
	Returns the date of the last update of the site. More...
	locator ($separator='>')
	Returns the locator (breadcrumb navigation). More...
	editmenu ()
	Returns the admin menu. More...
	content ()
	Returns the contents area. More...
	submenu ($html='')
	Returns the submenu of a page. More...
	previouspage ()
	Returns a link to the previous page. More...
	nextpage ()
	Returns a link to the next page. More...
	top ($id='TOP')
	Returns a link to the top of the page. More...
	languagemenu ()
	Returns the language menu. More...
	XH_emergencyTemplate ()
	Provides a minimal template (in case template isn't found). More...
	poweredByLink ($linktext='')
	Returns a powered by CMSimple_XH link. More...

Detailed Description

Template functions.

Author

Peter Harteg peter.nosp@m.@har.nosp@m.teg.d.nosp@m.k

The CMSimple_XH developers devs@.nosp@m.cmsi.nosp@m.mple-.nosp@m.xh.o.nosp@m.rg

Copyright

1999-2009 Peter Harteg

2009-2023 The CMSimple_XH developers https://www.cmsimple-xh.org/?About-CMSimple_XH/The-XH-Team

GNU GPLv3 http://www.gnu.org/licenses/gpl-3.0.en.html

Function Documentation

content()

content

(

)

Returns the contents area.

Returns

string HTML

editmenu()

editmenu

(

)

Returns the admin menu.

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

Returns

string HTML

See also

XH_adminMenu()

Deprecated:

since 1.7. Just remove from the template.

head()

head

(

)

Returns the complete HEAD element.

Returns

string HTML

languagemenu()

languagemenu

(

)

Returns the language menu.

Returns

string HTML

lastupdate()

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

Returns the date of the last update of the site.

Parameters

bool	$br	Whether to emit a br element between text and date.
int	$hour	The time correction in hours.

Returns

string HTML

li()

li	(	array	$ta,
			$st
	)

Returns a menu structure of certain pages.

Parameters

array	$ta	The indexes of the pages.
mixed	$st	The menu level to start with or the type of menu.

Returns

string HTML

locator()

locator

(

$separator = '>'

)

Returns the locator (breadcrumb navigation).

Parameters

string

$separator

The separator between the breadcrumb links.

Returns

string HTML

loginlink()

loginlink

(

)

Returns the link to the login form.

Returns

string HTML

mailformlink()

mailformlink

(

)

Returns the link to the mail form.

Returns

string HTML

nextpage()

nextpage

(

)

Returns a link to the next page.

Returns

string|null HTML

See also

previouspage()

onload()

onload

(

)

Returns the onload attribute for the body element.

Returns

string HTML

pagename()

pagename

(

)

Returns the global site title.

Returns

string HTML

poweredByLink()

poweredByLink

(

$linktext = ''

)

Returns a powered by CMSimple_XH link.

Parameters

string

$linktext

Returns

string

Since

1.7

previouspage()

previouspage

(

)

Returns a link to the previous page.

Returns

string|null HTML

See also

nextpage()

printlink()

printlink

(

)

Returns the link for the print view.

Returns

string HTML

searchbox()

searchbox

(

)

Returns the search form.

Returns

string HTML

sitemaplink()

sitemaplink

(

)

Returns the sitemap link.

Returns

string HTML

sitename()

sitename

(

)

Returns the language dependend site title.

Returns

string HTML

submenu()

submenu

(

$html = ''

)

Returns the submenu of a page.

Parameters

string

$html

Optional markup to wrap the heading.

Returns

string HTML

toc()

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

Returns the table of contents.

Parameters

int	$start	The menu level to start with.
int	$end	The menu level to end with.
callable	$li	A callback that actually creates the view.

Returns

string HTML

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.

Parameters

string

$id

An (X)HTML ID.

Returns

string

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.

Returns

void

Since

1.6.2

XH_emergencyTemplate()

XH_emergencyTemplate

(

)

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

Returns

void

Since

1.6.3

XH_printUrl()

XH_printUrl

(

)

Returns the URL of the print view.

Returns

string

Since

1.6

XH_renderNextLink()

XH_renderNextLink

(

)

Renders the next link.

Returns

string HTML

Since

1.6.3

XH_renderPrevLink()

XH_renderPrevLink

(

)

Renders the prev link.

Returns

string HTML

Since

1.6.3