Packageindex Classtrees Modulegroups Elementlist Report XML Files

SectionNavigatorOptimized

SectionNavigator
   |
  +-- SectionNavigatorOptimized

private class SectionNavigatorOptimized extends SectionNavigator

 

Methods inherited from SectionNavigator

sectionnavigator, setsection, _setchildren, haschildren, &getchildren, &gethomesection, &_gethomesection, ishomesection, getnavpath, &getparent, setdescend, _descend, _addtostacks, _removefromstacks, _getfromstacks, &getnextsection, getdepth, countchildren, &getancestorcollection, getdescendantids, is_authorized

Public Method Summary

object SectionNavigator &singleton([ object pxdb_record $section ])
Instantiate one copy of this object.Warning: documentation is missing.
void setShowHiddenSections([ boolean $show ])
Controls wether we return hidden children sectionsWarning: documentation is missing.

Private Method Summary

object Reference &_getChildrenCollection([ string $url_path ])
Generates the pxdb_collection for the getChildren method,Warning: documentation is missing.
object pxdb_record &_getSectionByUrlPath(string $url_path)
Gets a Section by its URL Path**, optimized for MySQL db performanceWarning: documentation is missing.
object pxdb_collection &_getParentCollection([ string $url_path ])
Abstraction method for implementation of getting the collection with a Parent in it.Warning: documentation is missing.

Fields inherited from SectionNavigator

$section, $haschildren, $children, $homesection, $sectionstack, $childrenstack, $descend, $depth, $_showhiddensections

Public Method Details

&singleton

public object SectionNavigator &singleton([ object pxdb_record $section ])

 

Warning: documentation is missing.

Parameter
object pxdb_record $section = >>null<<
Returns object SectionNavigator


setShowHiddenSections

public void setShowHiddenSections([ boolean $show ])

 

Warning: documentation is missing.

Parameter
boolean $show = >>true<<
=return hidden sections ( default )
Returns void


Private Method Details

&_getChildrenCollection

private object Reference &_getChildrenCollection([ string $url_path ])

  used to abstract it for overloading.

Warning: documentation is missing.

Parameter
string $url_path = >>null<<
The URL PATH* of the section *Change
Returns object Reference

to the pxdb_collection class containing the children


&_getSectionByUrlPath

private object pxdb_record &_getSectionByUrlPath(string $url_path)

  ** Changed from URL ID

Warning: documentation is missing.

Parameter
string $url_path
The URL PATH* of the section you're trying to get *Change
Returns object pxdb_record

Reference to a pxdb_record object or false on failure


&_getParentCollection

private object pxdb_collection &_getParentCollection([ string $url_path ])

 

Warning: documentation is missing.

Parameter
string $url_path = >>null<<
The URL ID of the section that is a child of the parent you want.
Returns object pxdb_collection

Reference to the PxDB collection containing the parent



Packageindex Classtrees Modulegroups Elementlist Report XML Files
Generated on Fri, 28 Apr 2006 19:06:12 -0400 by PHPDoc v1.5 www.phpdoc.de