- Symphony 2.2.2
-
› assets
11 -
› boot
9 -
› core
22 -
› email-gateways
3 -
› toolkit
67 -
› Unknown
33 - Delegates87
- Deprecated30
Versions
- 2.7.9
- 2.7.8
- 2.7.7
- 2.7.6
- 2.7.5
- 2.7.3
- 2.7.2
- 2.7.10
- 2.7.1
- 2.7.0
- 2.6.9
- 2.6.8
- 2.6.7
- 2.6.6
- 2.6.5
- 2.6.4
- 2.6.3
- 2.6.2
- 2.6.11
- 2.6.10
- 2.6.1
- 2.6.0
- 2.5.3
- 2.5.2
- 2.5.1
- 2.5.0
- 2.4
- 2.3.6
- 2.3.5
- 2.3.4
- 2.3.3
- 2.3.2
- 2.3.1
- 2.3
- 2.2.5
- 2.2.4
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2
Options
Page HTMLPage
public class HTMLPage extends Page
class.htmlpage.php #12HTMLPage extends the Page class to provide an object representation of a Symphony backend page.
Properties
XMLElement $Body
An XMLElement object for the <body>
XMLElement $Form
An XMLElement object for the <form>
. Most Symphony backend pages
are contained within a main form
XMLElement $Head
An XMLElement object for the <head>
XMLElement $Html
An XMLElement object for the <html>
element. This is the parent
DOM element for all other elements on the output page.
Methods
string __buildQueryString(
$exclude)
This function builds a HTTP query string from $_GET
parameters with
the option to remove parameters with an $exclude
array
Parameters
void __construct()
Constructor for the HTMLPage. Intialises the class variables with empty instances of XMLElement
integer addElementToHead(XMLElement $object, $position)
Adds an XMLElement to the $this->_head
array at a desired position.
If no position is given, the object will be added to the end
of the $this->_head
array. If that position is already taken, it will
add the object at the next available position.
Parameters
Returns
Returns the position that the $object
has been set in the $this->_head
See Also
integer addScriptToHead(
$path, $position, $duplicate)
Convenience function to add a <script>
element to the $this->_head
. By default
the function will allow duplicates to be added to the $this->_head
. A duplicate
is determined by if the $path
is unique.
Parameters
Returns
Returns the position that the script has been set in the $this->_head
integer addStylesheetToHead(
$path, $type, $position, $duplicate)
Convenience function to add a stylesheet to the $this->_head
in a <link>
element.
By default the function will allow duplicates to be added to the $this->_head
.
A duplicate is determined by if the $path
is unique.
Parameters
Returns
Returns the position that the stylesheet has been set in the $this->_head
boolean checkElementsInHead(
$path, $attribute, $value)
Determines if two elements are duplicates based on an attribute and value
Parameters
string generate()
The generate function calls the __build()
function before appending
all the current page's headers and then finally calling the $Html's
generate function which generates a HTML DOM from all the
XMLElement children.
See Also
void removeFromHead(
$elementName)
Given an elementName, this function will remove the corresponding
XMLElement from the $this->_head
int setTitle(
$title)
Setter function for the <title>
of a backend page. Uses the
addElementToHead()
function to place into the $this->_head
array.
Returns
Returns the position that the title has been set in the $_head