OxNavigationTree Class Reference

Inheritance diagram for OxNavigationTree:

[legend]

Collaboration diagram for OxNavigationTree:

[legend]

List of all members.

Detailed Description

Navigation tree control class

Definition at line 6 of file oxnavigationtree.php.


Public Member Functions
	init ()
	getTabs ($sId, $iAct, $blSetActive=true)
	getActiveTab ($sId, $iAct)
	getBtn ($sClass)
	getDomXml ()
	getListNodes ($aNodes)
	getListUrl ($sId)
	getEditUrl ($sId, $iActTab)
	getClassId ($sClassName)
	getShopVersionNr ()
Protected Member Functions
	_addLinks ()
	_loadFromFile ($sMenuFile)
	_addDynLinks ($oDom)
	_checkRights ($oDom)
	_checkGroups ($oDom)
	_copyAttributes ($oDomElemTo, $oDomElemFrom)
	_mergeNodes ($oDomElemTo, $oDomElemFrom, $oXPathTo, $oDomDocTo, $sQueryStart)
	_merge ($oDomNew)
	_getMenuFiles ()
	_checkDynFile ($sDynFilePath)
	_getAdminUrl ()
	_hasRights ($sRights)
	_hasGroup ($sGroupId)
	_getDynMenuUrl ($iLang, $blLoadDynContents)
	_getDynMenuLang ()
Protected Attributes
	$_oDom = null
	$_sDynIncludeUrl = null

Member Function Documentation

OxNavigationTree.init ( )

Trys to load data form session, otherwise loads xml form menu.xml, user.xml and trys to get dynscreen.xml

Returns:: null

Definition at line 26 of file oxnavigationtree.php.

OxNavigationTree._addLinks ( ) [protected]

Adds links to xml nodes to resolve paths

Returns:: null

Definition at line 45 of file oxnavigationtree.php.

OxNavigationTree._loadFromFile ( $ sMenuFile ) [protected]

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

Parameters:

string

$sMenuFile whitch file to load

Returns:: null

Definition at line 73 of file oxnavigationtree.php.

OxNavigationTree._addDynLinks ( $ oDom ) [protected]

Adds to element DynTabs

Parameters:

object

$oDom dom element to add links

Returns:: null

Definition at line 89 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 162 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 195 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 229 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 247 of file oxnavigationtree.php.

OxNavigationTree._merge ( $ oDomNew ) [protected]

If oDomXML exist meges nodes

Parameters:

object

$oDomNew DOMDocument

Returns:: null

Definition at line 285 of file oxnavigationtree.php.

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

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

Parameters:

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

Returns:: DOMNodeList

Definition at line 300 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 327 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 345 of file oxnavigationtree.php.

OxNavigationTree._getMenuFiles ( ) [protected]

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

Returns:: array

Definition at line 365 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 435 of file oxnavigationtree.php.

OxNavigationTree.getDomXml ( )

Returns DomXML

Returns:: DOMDocument

Definition at line 464 of file oxnavigationtree.php.

OxNavigationTree.getListNodes ( $ aNodes )

Returns DOMNodeList of given navigation classes

Returns:: DOMNodeList

Definition at line 530 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 547 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 570 of file oxnavigationtree.php.

OxNavigationTree._getAdminUrl ( ) [protected]

Admin url getter

Returns:: string

Definition at line 603 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 622 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 634 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 646 of file oxnavigationtree.php.

OxNavigationTree.getShopVersionNr ( )

Definition at line 663 of file oxnavigationtree.php.

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

Definition at line 687 of file oxnavigationtree.php.

OxNavigationTree._getDynMenuLang ( ) [protected]

Definition at line 709 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.$_sDynIncludeUrl = null [protected]

Definition at line 18 of file oxnavigationtree.php.

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

admin/oxnavigationtree.php

OxNavigationTree Class Reference

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

Member Data Documentation