|
Procedural File: Document.php
Source Location: Program_Root/Misc/Document.php
Classes:
Document
This package contains the data of the current page request, and renders it for the Sitellite Content Server. It also provides several global-level functions that provide developers with control over the contents and the properties of the page request.
Page Details:
page_add_header [line 492]
void page_add_header(
string $header)
|
|
Adds an HTTP header to send with the page.
Tags:
Parameters
page_add_link [line 538]
void page_add_link(
string $rel, string $type, string $href, [string $charset = false], [string $hreflang = false], [mixed $name = false])
|
|
Adds a link tag to the page.
Tags:
Parameters
| string |
$rel |
|
| string |
$type |
|
| string |
$href |
|
| string |
$charset |
|
| string |
$hreflang |
|
page_add_meta [line 504]
void page_add_meta(
string $key, string $value, [string $name = 'name'])
|
|
Adds an HTML meta tag to the page.
Tags:
Parameters
| string |
$key |
|
| string |
$value |
|
| string |
$name |
|
page_add_script [line 514]
void page_add_script(
string $script)
|
|
Adds a JavaScript script to the page.
Tags:
Parameters
page_add_style [line 524]
void page_add_style(
string $style)
|
|
Adds a CSS stylesheet to the page.
Tags:
Parameters
page_below [line 615]
void page_below(
string $ref, string 1)
|
|
Sets the below_page property of the page. This sets the position of the page within the web site breadcrumbs.
Tags:
Parameters
page_description [line 589]
void page_description(
string $description)
|
|
Sets the description of the page.
Tags:
Parameters
page_get_section [line 646]
string page_get_section(
)
|
|
Alias of the getSection() method. Returns the first section page that the current page is a child of.
Tags:
page_get_title [line 657]
string page_get_title(
[string $page = false])
|
|
Alias of the getTitle() method.
Tags:
Parameters
page_head_title [line 569]
void page_head_title(
string $title)
|
|
Sets the head_title of the page.
Tags:
Parameters
page_id [line 549]
void page_id(
string $id)
|
|
Sets the page ID to something other than its default. Handy for actions with page aliases.
Tags:
Parameters
page_is_parent [line 668]
boolean page_is_parent(
string $parent)
|
|
Alias of the isParent() method.
Tags:
Parameters
page_keywords [line 601]
void page_keywords(
string $keywords)
|
|
Sets the keywords of the page.
Tags:
Parameters
page_nav_title [line 579]
void page_nav_title(
string $title)
|
|
Sets the nav_title of the page.
Tags:
Parameters
page_onblur [line 731]
void page_onblur(
string $value)
|
|
Adds an onblur="" handler to the page. This can be rendered in your XT templates in the onblur attribute of your HTML body tag, by inserting the value "${onblur}".
Tags:
Parameters
page_onclick [line 748]
void page_onclick(
string $value)
|
|
Adds an onclick="" handler to the page. This can be rendered in your XT templates in the onclick attribute of your HTML body tag, by inserting the value "${onclick}".
Tags:
Parameters
page_onfocus [line 714]
void page_onfocus(
string $value)
|
|
Adds an onfocus="" handler to the page. This can be rendered in your XT templates in the onfocus attribute of your HTML body tag, by inserting the value "${onfocus}".
Tags:
Parameters
page_onload [line 680]
void page_onload(
string $value)
|
|
Adds an onload="" handler to the page. This can be rendered in your XT templates in the onload attribute of your HTML body tag, by inserting the value "${onload}".
Tags:
Parameters
page_onunload [line 697]
void page_onunload(
string $value)
|
|
Adds an onunload="" handler to the page. This can be rendered in your XT templates in the onunload attribute of your HTML body tag, by inserting the value "${onunload}".
Tags:
Parameters
page_template [line 625]
void page_template(
string $value)
|
|
Sets the template to use to render the page.
Tags:
Parameters
page_template_set [line 635]
void page_template_set(
string $value)
|
|
Sets the template set (ie. theme) to use to render the page.
Tags:
Parameters
page_title [line 559]
void page_title(
string $title)
|
|
Sets the title of the page.
Tags:
Parameters
|