Public Method Details |
Request |
public void Request()
|
|
|
Returns |
void |
|
isIncluded |
public void isIncluded([ boolean $new_value ])
|
|
page.
|
Parameter |
|
boolean |
$new_value |
= >>null<< |
|
The new value for $_included. |
|
Returns |
void |
|
getPath |
public string getPath()
|
|
|
Returns |
string Path built from $arrPath |
|
getPathElement |
public string getPathElement(integer $num)
|
|
|
Parameter |
|
integer |
$num |
|
|
The index to retrieve |
|
Returns |
string element of $arrPath |
|
setPathElement |
public void setPathElement(integer $num, string $value)
|
|
|
Parameter |
|
integer |
$num |
|
|
The index to set. |
|
|
string |
$value |
|
|
The value to set it to. |
|
Returns |
void |
|
countPathElements |
public integer countPathElements()
|
|
|
Returns |
integer |
|
setVar |
public void setVar(string $varname, mixed $value)
|
|
|
Parameter |
|
|
|
|
Returns |
void |
|
getTrailStart |
public array getTrailStart()
|
|
This is the HOME section. The main navigation tier happens to be a section for this site framework. You could of course change this, but more than likely a "homepage" is going to be a site section (with customized template) rather than a content module / application.
|
Returns |
array The Top-level navigation component. |
|
setTrail |
public void setTrail(array $trail)
|
|
|
Parameter |
|
array |
$trail |
|
|
The multi-dimentional array that is the breadcrumb trail. |
|
Returns |
void |
|
addTrailPoint |
public void addTrailPoint(array $point)
|
|
|
Parameter |
|
array |
$point |
|
|
Hash of trail data [crumb, url]. |
|
Returns |
void |
|
setTrailPoint |
public void setTrailPoint(array $index, $point)
|
|
|
Parameter |
|
array |
$index |
|
|
Hash of trail data [crumb, url]. |
|
|
|
$point |
|
|
Warning: documentation is missing. |
|
Returns |
void |
|
getTrail |
public array getTrail()
|
|
This class will return contents of $arrTrail array, appended to the top-level section 'HOME'). There is currently no proper way of overriding this auto-prepend behavior.
|
Returns |
array |
|
getSidebarScript |
public string getSidebarScript()
|
|
|
Returns |
string |
|
setSidebarScript |
public void setSidebarScript(string $script)
|
|
|
Parameter |
|
|
Returns |
void |
|
getPageTitle |
public string getPageTitle()
|
|
By default just returns the value in $strPageTitle
|
Returns |
string |
|
getWindowTitle |
public string getWindowTitle([ string $delim ])
|
|
This is based on the breadcrumb trail.
|
Parameter |
|
string |
$delim |
= >>': '<< |
|
This is the text to separate elements of title. |
|
Returns |
string |
|
setPageTitle |
public void setPageTitle(string $page_title)
|
|
built. (e.g. modules don't have a rule for page title, while sections do).
|
Parameter |
|
|
Returns |
void |
|
getMetaKeywords |
public string getMetaKeywords()
|
|
By default just returns the value in $strMetaKeywords
|
Returns |
string The Keywords to use in META tag. |
|
setMetaKeywords |
public void setMetaKeywords(string $keywords)
|
|
built. (e.g. modules don't have a rule for keywords, while sections do).
|
Parameter |
|
|
Returns |
void |
|
getMetaDescription |
public string getMetaDescription()
|
|
By default just returns the value in $strMetaDescription.
|
Returns |
string The Description to use in META tag. |
|
setMetaDescription |
public void setMetaDescription(string $desc)
|
|
built. (e.g. modules don't have a rule for description, while sections do).
|
Parameter |
|
|
Returns |
void |
|
getVarsAsQueryString |
public string getVarsAsQueryString([ array $ignore ])
|
|
Useful for persisting of values via href links.
|
Parameter |
|
array |
$ignore |
= >>null<< |
|
set of variables to exclude |
|
Returns |
string |
|
getVarsAsHiddenInputs |
public string getVarsAsHiddenInputs([ array $ignore ])
|
|
Useful for persisting of values via href links.
|
Parameter |
|
array |
$ignore |
= >>null<< |
|
set of variables to exclude |
|
Returns |
string |
|