|
|
SyntaxCMS.Request
SectionRequest
Request | +-- SectionRequest
|
public class SectionRequest extends Request
|
|
|
Methods inherited from Request |
request, isincluded, setpath, getpath, getpathelement, setpathelement, countpathelements, setpathdefault, getpathdefault, getvar, getvars, setvar, delvar, setvars, addvars, gettrailstart, settrail, addtrailpoint, settrailpoint, getsidebarscript, setsidebarscript, getwindowtitle, setpagetitle, setmetakeywords, setmetadescription, getvarsasquerystring, getvarsashiddeninputs |
|
|
Private Method Summary |
void |
_popSection() Pops & returns the hash for current session.
|
integer |
getSectionID() Shortcut for getting curr section id.
|
object Section |
&getSection() Get current section as a Section object.
|
integer |
getSectionDepth() Returns the depth of the current section.
|
boolean |
isParentSection(integer $section_id) Whether or not passed Section ID is in the path of sections.
|
void |
parsePath() This parsePath implementation avoids the more expensive crazy left join that hans implemented.
|
array |
getBaseTrail() Build breadcrumb from NAV_ROOT_EL to current section, including all ancestors.
|
array |
getTrail() Get array of current breadcrumb trail.Warning: documentation is missing.
|
string |
getScript() Returns the script to use for displaying the section.Warning: documentation is missing.
|
string |
getMetaKeywords() Returns the META-tag keywords.Warning: documentation is missing.
|
string |
getMetaDescription() Returns the META-tag description.Warning: documentation is missing.
|
string |
getPageTitle() Returns the current page title.Warning: documentation is missing.
|
|
Fields inherited from Request |
$children, $parent, $arrpath, $arrpathdefaults, $arrrequestvars, $blnincluded, $strpagetitle, $strmetakeywords, $strmetadescription, $arrtrail, $sidebarscript |
|
Private Field Summary |
array |
$arrSections Path of information for each Section.
|
array |
$arrFullPath The path that includes hidden NAV_ROOT_EL section.
|
|
$Section Stores the current Section object.
|
|
$currSection The top section element.
|
boolean |
$blnParsed Whether Section has been parsed.
|
|
Public Method Details |
SectionRequest |
public void SectionRequest()
|
|
|
Returns |
void |
|
|
Private Method Details |
_popSection |
private void _popSection()
|
|
This is used by the getSection() and getSectionID() methods. Only really exists for efficiency -- so that if curr section id is only needed, no need to instantiate Section object.
|
Returns |
void |
|
getSectionID |
private integer getSectionID()
|
|
|
Returns |
integer |
|
&getSection |
private object Section &getSection()
|
|
|
Returns |
object Section |
|
getSectionDepth |
private integer getSectionDepth()
|
|
A useful function for building breadcrumbs, etc.
|
Returns |
integer The current section's depth. |
|
isParentSection |
private boolean isParentSection(integer $section_id)
|
|
|
Parameter |
|
|
Returns |
boolean |
|
parsePath |
private void parsePath()
|
|
|
Returns |
void |
Author(s) |
|
|
getBaseTrail |
private array getBaseTrail()
|
|
|
Returns |
array |
|
getTrail |
private array getTrail()
|
|
Warning: documentation is missing.
|
Returns |
array |
|
getScript |
private string getScript()
|
|
Note: unlike the module-based navigation we always use the same script here.
Warning: documentation is missing.
|
Returns |
string |
|
getMetaKeywords |
private string getMetaKeywords()
|
|
Warning: documentation is missing.
|
Returns |
string The Keywords to use in META tag. |
|
getMetaDescription |
private string getMetaDescription()
|
|
Warning: documentation is missing.
|
Returns |
string The Description to use in META tag. |
|
getPageTitle |
private string getPageTitle()
|
|
Warning: documentation is missing.
|
Returns |
string The page title. |
|
|
Private Field Details |
$arrSections |
private array $arrSections
>>array() <<
Used by breadcrumb trail builder.
|
|
$arrFullPath |
private array $arrFullPath
>> <<
|
|
$Section |
private $Section
>>null <<
Mostly a sort of cache so that recurring calls to getSection() don't re-instantiate.
|
|
$currSection |
private $currSection
>>null <<
OR error if section can't be found.
|
|
$blnParsed |
private boolean $blnParsed
>>false <<
|
|
|
|
|
Generated on Fri, 28 Apr 2006 19:06:12 -0400 by PHPDoc v1.5 www.phpdoc.de
|