Inheritance diagram for OxNavigationTree:

Collaboration diagram for OxNavigationTree:

Public Member Functions
	init ()
	getTabs ($sId, $iAct, $blSetActive=true)
	getActiveTab ($sId, $iAct)
	getBtn ($sClass)
	getDomXml ()
	getListNodes ($aNodes)
	markNodeActive ($sNodeId)
	getListUrl ($sId)
	getEditUrl ($sId, $iActTab)
	getClassId ($sClassName)
	getShopVersionNr ()
Protected Member Functions
	_cleanEmptyParents ($oDom, $sParentXPath, $sChildXPath)
	_addLinks ($oDom)
	_loadFromFile ($sMenuFile, $oDom)
	_addDynLinks ($oDom)
	_sessionizeLocalUrls ($oDom)
	_checkRights ($oDom)
	_checkGroups ($oDom)
	_checkDemoShopDenials ($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

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

Parameters:

object

$oDom dom element to add links

Returns:: null

Definition at line 111 of file oxnavigationtree.php.

OxNavigationTree._addLinks ( $ oDom ) [protected]

Adds links to xml nodes to resolve paths

Parameters:

DomDocument

$oDom where to add links

Returns:: null

Definition at line 66 of file oxnavigationtree.php.

OxNavigationTree._checkDemoShopDenials ( $ oDom ) [protected]

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

Parameters:

DOMDocument

$oDom document to check group

Returns:: null

Definition at line 271 of file oxnavigationtree.php.

OxNavigationTree._checkDynFile ( $ sDynFilePath ) [protected]

Checks if dyn file is valid for inclusion

Parameters:

string

$sDynFilePath dyn file path

Returns:: bool

Definition at line 524 of file oxnavigationtree.php.

OxNavigationTree._checkGroups ( $ oDom ) [protected]

Removes form tree elements whitch doesn't have requred groups

Parameters:

DOMDocument

$oDom document to check group

Returns:: null

Definition at line 238 of file oxnavigationtree.php.

OxNavigationTree._checkRights ( $ oDom ) [protected]

Removes form tree elements whitch doesn't have requred user rights

Parameters:

object

$oDom DOMDocument

Returns:: null

Definition at line 205 of file oxnavigationtree.php.

OxNavigationTree._cleanEmptyParents	(	$	oDom,
		$	sParentXPath,
		$	sChildXPath
	)			`[protected]`

clean empty nodes from tree

Parameters:

	object	$oDom dom object
	string	$sParentXPath parent xpath
	string	$sChildXPath child xpath from parent

Returns:: null

Definition at line 45 of file oxnavigationtree.php.

OxNavigationTree._copyAttributes	(	$	oDomElemTo,
		$	oDomElemFrom
	)			`[protected]`

Copys attributes form one element to another

Parameters:

	object	$oDomElemTo DOMElement
	object	$oDomElemFrom DOMElement

Returns:: null

Definition at line 295 of file oxnavigationtree.php.

OxNavigationTree._getAdminUrl ( ) [protected]

Admin url getter

Returns:: string

Definition at line 750 of file oxnavigationtree.php.

OxNavigationTree._getDynMenuLang ( ) [protected]

Get dynamic pages language code

Returns:: string

Definition at line 853 of file oxnavigationtree.php.

OxNavigationTree._getDynMenuUrl	(	$	iLang,
		$	blLoadDynContents
	)			`[protected]`

Get dynamic pages url or local path

Parameters:

	int	$iLang language id
	string	$blLoadDynContents get local or remote content path

Returns:: string

Definition at line 833 of file oxnavigationtree.php.

OxNavigationTree._getInitialDom ( ) [protected]

get initial dom, not modified by init method

Returns:: DOMDocument

Definition at line 570 of file oxnavigationtree.php.

OxNavigationTree._getMenuFiles ( ) [protected]

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

Returns:: array

Definition at line 433 of file oxnavigationtree.php.

OxNavigationTree._hasGroup ( $ sGroupId ) [protected]

Checks if user in required group

Parameters:

string

$sGroupId active group id

Returns:: bool

Definition at line 781 of file oxnavigationtree.php.

OxNavigationTree._hasRights ( $ sRights ) [protected]

Checks if user has required rights

Parameters:

string

$sRights session user rights

Returns:: bool

Definition at line 769 of file oxnavigationtree.php.

OxNavigationTree._loadFromFile	(	$	sMenuFile,
		$	oDom
	)			`[protected]`

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

Parameters:

	string	$sMenuFile which file to load
	DomDocument	$oDom where to load

Returns:: null

Definition at line 95 of file oxnavigationtree.php.

OxNavigationTree._merge	(	$	oDomNew,
		$	oDom
	)			`[protected]`

If oDomXML exist meges nodes

Parameters:

	DomDocument	$oDomNew what to merge
	DomDocument	$oDom where to merge

Returns:: null

Definition at line 351 of file oxnavigationtree.php.

OxNavigationTree._mergeNodes	(	$	oDomElemTo,
		$	oDomElemFrom,
		$	oXPathTo,
		$	oDomDocTo,
		$	sQueryStart
	)			`[protected]`

Merges nodes of newly added menu xml file

Parameters:

	object	$oDomElemTo merge target
	object	$oDomElemFrom merge source
	object	$oXPathTo node path
	object	$oDomDocTo node to append child
	string	$sQueryStart node query

Returns:: null

Definition at line 313 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

$sCacheContents initial cached string

Deprecated:

See also:: self._sessionizeLocalUrls()

Returns:: string

Definition at line 560 of file oxnavigationtree.php.

OxNavigationTree._sessionizeLocalUrls ( $ oDom ) [protected]

add session parameters to local urls

Parameters:

object

$oDom dom element to add links

Returns:: null

Definition at line 182 of file oxnavigationtree.php.

OxNavigationTree.getActiveTab	(	$	sId,
		$	iAct
	)

Returns active TAB class name

Parameters:

	string	$sId class name
	int	$iAct active tab number

Returns:: string

Definition at line 394 of file oxnavigationtree.php.

OxNavigationTree.getBtn ( $ sClass )

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

Parameters:

string

$sClass class name

Returns:: mixed

Definition at line 413 of file oxnavigationtree.php.

OxNavigationTree.getClassId ( $ sClassName )

Returns id of class assigned to current node

Parameters:

string

$sClassName active class name

Returns:: string

Definition at line 793 of file oxnavigationtree.php.

OxNavigationTree.getDomXml ( )

Returns DomXML

Returns:: DOMDocument

Definition at line 630 of file oxnavigationtree.php.

OxNavigationTree.getEditUrl	(	$	sId,
		$	iActTab
	)

Formats and returns url for edit area

Parameters:

	string	$sId tab related class
	int	$iActTab active tab

Returns:: string

Definition at line 721 of file oxnavigationtree.php.

OxNavigationTree.getListNodes ( $ aNodes )

Returns DOMNodeList of given navigation classes

Parameters:

array

$aNodes Node array

Returns:: DOMNodeList

Definition at line 659 of file oxnavigationtree.php.

OxNavigationTree.getListUrl ( $ sId )

Formats and returns url for list area

Parameters:

string

$sId tab related class

Returns:: string

Definition at line 696 of file oxnavigationtree.php.

OxNavigationTree.getShopVersionNr ( )

Returns current shop version number

Deprecated:: not used any more

Returns:: strong

Definition at line 813 of file oxnavigationtree.php.

OxNavigationTree.getTabs	(	$	sId,
		$	iAct,
		$	blSetActive = `true`
	)

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

Parameters:

	string	$sId class name
	int	$iAct current tab number
	bool	$blSetActive marks tab as active

Returns:: DOMNodeList

Definition at line 366 of file oxnavigationtree.php.

OxNavigationTree.init ( )

Empty init method

Deprecated:: currently oxNavigationTree.getDomXml() does what this method did before

Returns:: null

Definition at line 32 of file oxnavigationtree.php.

OxNavigationTree.markNodeActive ( $ sNodeId )

Marks passed node as active

Parameters:

string

$sNodeId node id

Returns:: null

Definition at line 674 of file oxnavigationtree.php.

Member Data Documentation

OxNavigationTree.$_oDom = null [protected]

stores DOM object for all navigation tree

Definition at line 11 of file oxnavigationtree.php.

OxNavigationTree.$_oInitialDom = null [protected]

keeps unmodified dom

Definition at line 16 of file oxnavigationtree.php.

OxNavigationTree.$_sDynIncludeUrl = null [protected]

Definition at line 23 of file oxnavigationtree.php.

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

admin/oxnavigationtree.php

OxNavigationTree Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation