OXID eShop CE  4.10.2
 All Classes Namespaces Files Functions Variables Pages
OxNavigationTree Class Reference
+ Inheritance diagram for OxNavigationTree:
+ Collaboration diagram for OxNavigationTree:

Public Member Functions

 getTabs ($sId, $iAct, $blSetActive=true)
 getActiveTab ($sId, $iAct)
 getBtn ($sClass)
 getDomXml ()
 getListNodes ($aNodes)
 markNodeActive ($sNodeId)
 getListUrl ($sId)
 getEditUrl ($sId, $iActTab)
 getClassId ($sClassName)
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 __construct ()
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

Protected Member Functions

 _cleanEmptyParents ($oDom, $sParentXPath, $sChildXPath)
 _addLinks ($oDom)
 _loadFromFile ($sMenuFile, $oDom)
 _addDynLinks ($oDom)
 _sessionizeLocalUrls ($oDom)
 _checkRights ($oDom)
 _checkGroups ($oDom)
 _checkDemoShopDenials ($oDom)
 removeInvisibleMenuNodes ($oDom)
 _copyAttributes ($oDomElemTo, $oDomElemFrom)
 _mergeNodes ($oDomElemTo, $oDomElemFrom, $oXPathTo, $oDomDocTo, $sQueryStart)
 _merge ($oDomNew, $oDom)
 _getMenuFiles ()
 _checkDynFile ($sDynFilePath)
 _processCachedFile ($sCacheContents)
 _getInitialDom ()
 _getAdminUrl ()
 _hasRights ($sRights)
 _hasGroup ($sGroupId)
 _getDynMenuUrl ($iLang, $blLoadDynContents)
 _getDynMenuLang ()

Protected Attributes

 $_oDom = null
 $_oInitialDom = null
 $_sDynIncludeUrl = null
 $_aSupportedExpathXmlEncodings = array('utf-8', 'utf-16', 'iso-8859-1', 'us-ascii')

Additional Inherited Members

- Static Protected Attributes inherited from oxSuperCfg
static $_oConfig = null
static $_oSession = null
static $_oRights = null
static $_oActUser = null
static $_blIsAdmin = null

Detailed Description

Navigation tree control class

Definition at line 6 of file oxnavigationtree.php.

Member Function Documentation

OxNavigationTree::_addDynLinks (   $oDom)
protected

Adds to element DynTabs

Deprecated:
since v5.3 (2016-05-20); Dynpages will be removed.
Parameters
object$oDomdom element to add links

Definition at line 124 of file oxnavigationtree.php.

OxNavigationTree::_addLinks (   $oDom)
protected

Adds links to xml nodes to resolve paths

Parameters
DomDocument$oDomwhere to add links

Definition at line 59 of file oxnavigationtree.php.

OxNavigationTree::_checkDemoShopDenials (   $oDom)
protected

Removes form tree elements if this is demo shop and elements have disableForDemoShop="1"

Parameters
DOMDocument$oDomdocument to check group
Returns
null

Definition at line 280 of file oxnavigationtree.php.

OxNavigationTree::_checkDynFile (   $sDynFilePath)
protected

Checks if dyn file is valid for inclusion

Deprecated:
since v5.3 (2016-05-20); Dynpages will be removed.
Parameters
string$sDynFilePathdyn file path
Returns
bool

Definition at line 540 of file oxnavigationtree.php.

OxNavigationTree::_checkGroups (   $oDom)
protected

Removes from tree elements which don't have required groups

Parameters
DOMDocument$oDomdocument to check group

Definition at line 247 of file oxnavigationtree.php.

OxNavigationTree::_checkRights (   $oDom)
protected

Removes form tree elements which does not have required user rights

Parameters
object$oDomDOMDocument

Definition at line 216 of file oxnavigationtree.php.

OxNavigationTree::_cleanEmptyParents (   $oDom,
  $sParentXPath,
  $sChildXPath 
)
protected

clean empty nodes from tree

Parameters
object$oDomdom object
string$sParentXPathparent xpath
string$sChildXPathchild xpath from parent

Definition at line 40 of file oxnavigationtree.php.

OxNavigationTree::_copyAttributes (   $oDomElemTo,
  $oDomElemFrom 
)
protected

Copys attributes form one element to another

Parameters
object$oDomElemToDOMElement
object$oDomElemFromDOMElement

Definition at line 320 of file oxnavigationtree.php.

OxNavigationTree::_getAdminUrl ( )
protected

Admin url getter

Returns
string

Definition at line 773 of file oxnavigationtree.php.

OxNavigationTree::_getDynMenuLang ( )
protected

Get dynamic pages language code

Deprecated:
since v5.3 (2016-05-20); Dynpages will be removed.
Returns
string

Definition at line 863 of file oxnavigationtree.php.

OxNavigationTree::_getDynMenuUrl (   $iLang,
  $blLoadDynContents 
)
protected

Get dynamic pages url or local path

Deprecated:
since v5.3 (2016-05-20); Dynpages will be removed.
Parameters
int$iLanglanguage id
string$blLoadDynContentsget local or remote content path
Returns
string

Definition at line 841 of file oxnavigationtree.php.

OxNavigationTree::_getInitialDom ( )
protected

get initial dom, not modified by init method

Returns
DOMDocument

Definition at line 586 of file oxnavigationtree.php.

OxNavigationTree::_getMenuFiles ( )
protected

Returns array witn pathes + names ox manu xml files. Paths are checked

Returns
array

Definition at line 455 of file oxnavigationtree.php.

OxNavigationTree::_hasGroup (   $sGroupId)
protected

Checks if user in required group

Parameters
string$sGroupIdactive group id
Returns
bool

Definition at line 805 of file oxnavigationtree.php.

OxNavigationTree::_hasRights (   $sRights)
protected

Checks if user has required rights

Parameters
string$sRightssession user rights
Returns
bool

Definition at line 793 of file oxnavigationtree.php.

OxNavigationTree::_loadFromFile (   $sMenuFile,
  $oDom 
)
protected

Loads data form XML file, and merges it with main oDomXML.

Parameters
string$sMenuFilewhich file to load
DomDocument$oDomwhere to load

Definition at line 86 of file oxnavigationtree.php.

OxNavigationTree::_merge (   $oDomNew,
  $oDom 
)
protected

If oDomXML exist meges nodes

Parameters
DomDocument$oDomNewwhat to merge
DomDocument$oDomwhere to merge

Definition at line 372 of file oxnavigationtree.php.

OxNavigationTree::_mergeNodes (   $oDomElemTo,
  $oDomElemFrom,
  $oXPathTo,
  $oDomDocTo,
  $sQueryStart 
)
protected

Merges nodes of newly added menu xml file

Parameters
object$oDomElemTomerge target
object$oDomElemFrommerge source
object$oXPathTonode path
object$oDomDocTonode to append child
string$sQueryStartnode query

Definition at line 336 of file oxnavigationtree.php.

OxNavigationTree::_processCachedFile (   $sCacheContents)
protected

process cache contents and return the result deprecated, as cache files are cleared from session data, which is only added after loading the cache by _sessionizeLocalUrls()

Parameters
string$sCacheContentsinitial cached string
See Also
self::_sessionizeLocalUrls()
Returns
string

Definition at line 575 of file oxnavigationtree.php.

OxNavigationTree::_sessionizeLocalUrls (   $oDom)
protected

add session parameters to local urls

Parameters
object$oDomdom element to add links

Definition at line 195 of file oxnavigationtree.php.

OxNavigationTree::getActiveTab (   $sId,
  $iAct 
)

Returns active TAB class name

Parameters
string$sIdclass name
int$iActactive tab number
Returns
string

Definition at line 415 of file oxnavigationtree.php.

OxNavigationTree::getBtn (   $sClass)

returns from oDomXML tree buttons stdClass, which belongs to $sClass

Parameters
string$sClassclass name
Returns
mixed

Definition at line 434 of file oxnavigationtree.php.

OxNavigationTree::getClassId (   $sClassName)

Returns id of class assigned to current node

Parameters
string$sClassNameactive class name
Returns
string

Definition at line 817 of file oxnavigationtree.php.

OxNavigationTree::getDomXml ( )

Returns DomXML

Returns
DOMDocument

Definition at line 650 of file oxnavigationtree.php.

OxNavigationTree::getEditUrl (   $sId,
  $iActTab 
)

Formats and returns url for edit area

Parameters
string$sIdtab related class
int$iActTabactive tab
Returns
string

Definition at line 743 of file oxnavigationtree.php.

OxNavigationTree::getListNodes (   $aNodes)

Returns DOMNodeList of given navigation classes

Parameters
array$aNodesNode array
Returns
DOMNodeList

Definition at line 682 of file oxnavigationtree.php.

OxNavigationTree::getListUrl (   $sId)

Formats and returns url for list area

Parameters
string$sIdtab related class
Returns
string

Definition at line 717 of file oxnavigationtree.php.

OxNavigationTree::getTabs (   $sId,
  $iAct,
  $blSetActive = true 
)

Returns from oDomXML tree tabs DOMNodeList, which belongs to $sId

Parameters
string$sIdclass name
int$iActcurrent tab number
bool$blSetActivemarks tab as active
Returns
DOMNodeList

Definition at line 387 of file oxnavigationtree.php.

OxNavigationTree::markNodeActive (   $sNodeId)

Marks passed node as active

Parameters
string$sNodeIdnode id

Definition at line 695 of file oxnavigationtree.php.

OxNavigationTree::removeInvisibleMenuNodes (   $oDom)
protected

Removes node from tree elements if it is marked as not visible (visible="0")

Parameters
DOMDocument$oDomdocument to check group
Returns
null

Definition at line 303 of file oxnavigationtree.php.

Member Data Documentation

OxNavigationTree::$_aSupportedExpathXmlEncodings = array('utf-8', 'utf-16', 'iso-8859-1', 'us-ascii')
protected

Definition at line 31 of file oxnavigationtree.php.

OxNavigationTree::$_oDom = null
protected

stores DOM object for all navigation tree

Definition at line 12 of file oxnavigationtree.php.

OxNavigationTree::$_oInitialDom = null
protected

keeps unmodified dom

Definition at line 17 of file oxnavigationtree.php.

OxNavigationTree::$_sDynIncludeUrl = null
protected

Definition at line 24 of file oxnavigationtree.php.


The documentation for this class was generated from the following file: