The class eZContentObjectTreeNode does. More...

Inheritance diagram for eZContentObjectTreeNode:

Collaboration diagram for eZContentObjectTreeNode:

Public Member Functions
	addChild ($contentobjectID, $asObject=false, $contentObjectVersion=false)
	adjustPathElement ($element, $useParentFromNodeObject=false)
	availableClassesJsArray ()
	canAddLocation ()
	canCreate ()
	canCreateClassList ($asObject=false, $includeFilter=true, $groupList=false, $fetchID=false)
	canEdit ()
	canHide ()
	canMove ()
	canMoveFrom ()
	canMoveTo ($classID=false)
	canPdf ()
	canRead ()
	canRemove ()
	canRemoveLocation ()
	canSwap ()
	canViewEmbed ()
	checkAccess ($functionName, $originalClassID=false, $parentClassID=false, $returnAccessList=false, $language=false)
	checkPath ($path)
	children ()
	childrenByName ($name)
	childrenCount ($checkPolicies=true)
	classIdentifier ()
	classIsContainer ()
	classListFromPolicy ($policy, $allowedLanguageCodes=false)
	className ()
	contentObjectVersionObject ($asObject=true)
	createObject ($contentClassID, $parentNodeID=2)
	creator ()
	currentLanguage ()
	dataMap ()
	eZContentObjectTreeNode ($row=array())
	fetchByCRC ($pathStr)
	fetchParent ()
	fetchPath ()
	getName ($language=false)
	hasContentObject ()
	hiddenInvisibleString ()
	hiddenStatusString ()
	isMain ()
	move ($newParentNodeID, $nodeID=0)
	object ()
	pathArray ()
	pathWithNames ($regenerateCurrent=false)
	remoteID ()
	removeNodeFromTree ($moveToTrash=true)
	removeThis ()
	serialize ($options, $contentNodeIDArray, $topNodeIDArray)
	setContentObject ($object)
	setCurrentLanguage ($languageCode)
	setName ($name)
	sortArray ()
	store ($fieldFilters=null)
	subTree ($params=false)
	subTreeCount ($params=array())
	subtreeSoleNodeCount ($params=array())
	updateAndStoreModified ()
	updateSubTreePath ($updateParent=true, $nodeMove=false)
	updateURLAlias ()
	url ()
	urlAlias ()
	viewCount ()
Static Public Member Functions
static	addChildTo ($contentobjectID, $nodeID, $asObject=false, $contentObjectVersion=false)
static	assignSectionToSubTree ($nodeID, $sectionID, $oldSectionID=false)
static	availableClassListJsArray ($parameters=false)
static	calendar ($params=false, $nodeID=0)
static	classAttributeIDByIdentifier ($identifier)
static	classIDByIdentifier ($identifier)
static	clearViewCacheForSubtree (eZContentObjectTreeNode $node, $clearForRootNode=true)
static	create ($parentNodeID=null, $contentObjectID=null, $contentObjectVersion=0, $sortField=0, $sortOrder=true)
static	createAttributeFilterSQLStrings (&$attributeFilter, &$sortingInfo=array( 'sortCount'=> 0, 'attributeJoinCount'=> 0))
static	createClassFilteringSQLString ($classFilterType, &$classFilterArray)
static	createExtendedAttributeFilterSQLStrings (&$extendedAttributeFilter)
static	createGroupBySQLStrings (&$outGroupBySelectText, &$outGroupByText, $groupBy)
static	createMainNodeConditionSQLString ($mainNodeOnly)
static	createNodesConditionSQLStringFromPath ($nodePath, $includingLastNodeInThePath, $limit=false)
static	createNotEqParentSQLString ($nodeID, $depth=false, $depthOperator= 'le')
static	createObjectNameFilterConditionSQLString ($filter)
static	createPathConditionAndNotEqParentSQLStrings (&$outPathConditionStr, &$outNotEqParentStr, $nodeID, $depth=false, $depthOperator= 'le')
static	createPathConditionSQLString ($nodePath, $nodeDepth, $depth=false, $depthOperator= 'le')
static	createPermissionCheckingSQL ($limitationList, $treeTableName= 'ezcontentobject_tree', $tableAliasName= 'ezcontentobject_tree')
static	createPermissionCheckingSQLString ($limitationList)
static	createShowInvisibleSQLString ($useSettings, $fetchHidden=true)
static	createSortingSQLStrings ($sortList, $treeTableName= 'ezcontentobject_tree', $allowCustomColumns=false)
static	createVersionNameJoinsSQLString ($useVersionName, $includeAnd=true, $onlyTranslated=false, $lang=false, $treeTableName= 'ezcontentobject_tree')
static	createVersionNameTablesSQLString ($useVersionName)
static	createVersionNameTargetsSQLString ($useVersionName)
static	dataTypeByClassAttributeID ($classAttributeID)
static	definition ()
static	deleteNodeWhereParent ($node, $id)
static	fetch ($nodeID=false, $lang=false, $asObject=true, $conditions=false)
static	fetchAliasesFromNodeList ($nodeList)
	Fetches path_identification_string for a list of nodes.
static	fetchByContentObjectID ($contentObjectID, $asObject=true, $contentObjectVersion=false)
static	fetchByPath ($pathString, $asObject=true)
static	fetchByRemoteID ($remoteID, $asObject=true)
static	fetchByURLPath ($pathString, $asObject=true)
static	fetchClassIdentifierListByPathString ($nodePath, $withLastNode, $limit=false)
static	fetchList ($asObject=true, $offset=false, $limit=false)
static	fetchListCount ()
static	fetchNode ($contentObjectID, $parentNodeID)
static	fetchNodesByPathString ($nodePath, $withLastNode=false, $asObjects=true, $limit=false)
static	findMainNode ($objectID, $asObject=false)
static	findMainNodeArray ($objectIDArray, $asObject=true)
	Fetches the main nodes for an array of object id's.
static	findNode ($parentNode, $id, $asObject=false, $remoteID=false)
static	getClassesJsArray ($node=false, $includeFilter=true, $groupList=false, $fetchID=false, $classes=false)
static	getLimitationList (&$limitation)
static	getParentNodeId ($nodeID)
static	getParentNodeIdListByContentObjectID ($objectIDs, $groupByObjectId=false, $onlyMainNode=false)
	Get parent node id's by content object id's.
static	hideSubTree (eZContentObjectTreeNode $node, $modifyRootNode=true)
static	makeObjectsArray ($array, $with_contentobject=true)
static	parentDepthLimitationList ()
static	removeNode ($nodeID=0)
static	removeSubtrees ($deleteIDArray, $moveToTrash=true, $infoOnly=false)
static	setVersionByObjectID ($objectID, $newVersion)
static	showInvisibleNodes ()
static	sortArrayBySortFieldAndSortOrder ($sortField, $sortOrder)
static	sortFieldID ($sortFieldName)
static	sortFieldName ($sortFieldID)
static	sortKeyByClassAttributeID ($classAttributeID)
static	subTreeByNodeID ($params=false, $nodeID=0)
static	subTreeCountByNodeID ($params=array(), $nodeID)
static	subTreeGroupByDateField ($field, $type)
static	subTreeMultiPaths ($nodesParams, $listParams=NULL)
static	subtreeRemovalInformation ($deleteIDArray)
static	unhideSubTree (eZContentObjectTreeNode $node, $modifyRootNode=true)
static	unserialize ($contentNodeDOMNode, $contentObject, $version, $isMain, &$nodeList, &$options, $handlerType= 'ezcontentobject')
static	updateMainNodeID ($mainNodeID, $objectID, $version=false, $parentMainNodeID, $updateSection=true)
static	updateNodeVisibility ($node, $parentNode, $recursive=true)
Public Attributes
	$ClassIdentifier = null
	Contains the cached value of the class identifier.
	$ClassName = null
	$CurrentLanguage = false
	The current language for the node.
	$Name
	Name of the node.
const	SORT_FIELD_CLASS_IDENTIFIER = 6
const	SORT_FIELD_CLASS_NAME = 7
const	SORT_FIELD_DEPTH = 5
const	SORT_FIELD_MODIFIED = 3
const	SORT_FIELD_MODIFIED_SUBNODE = 10
const	SORT_FIELD_NAME = 9
const	SORT_FIELD_PATH = 1
const	SORT_FIELD_PRIORITY = 8
const	SORT_FIELD_PUBLISHED = 2
const	SORT_FIELD_SECTION = 4
const	SORT_ORDER_ASC = 1
const	SORT_ORDER_DESC = 0
Protected Attributes
	$ClassIsContainer = null
Private Member Functions
	updatePathIdentificationString ($pathIdentificationName)
Static Private Member Functions
static	reverseRelatedCount ($nodeIDArray)

Detailed Description

The class eZContentObjectTreeNode does.


Some algorithms
----------
1. Adding new Node
Enter  1 - parent_node
       2 - contentobject_id,  ( that is like a node value )

(a) - get path_string, depth for parent node to built path_string  and to count depth for new one
(c) - calculating attributes for new node and inserting it
Returns node_id for added node


2. Deleting node ( or subtree )
Enter - node_id

3. Move subtree in tree
Enter node_id,new_parent_id


4. fetching subtree

Definition at line 64 of file ezcontentobjecttreenode.php.

Member Function Documentation

eZContentObjectTreeNode::addChild	(	$	contentobjectID,
		$	asObject = `false`,
		$	contentObjectVersion = `false`
	)

Add a child for this node to the object tree.

Parameters:

$contentobjectID	The ID of the contentobject the child-node should point to.
$asObject	If true it will return the new child-node as an object, if not it returns the ID.
$contentObjectVersion	The version to use on the newly created child-node, if false it uses the current_version of the specified object.

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 3235 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::addChildTo	(	$	contentobjectID,
		$	nodeID,
		$	asObject = `false`,
		$	contentObjectVersion = `false`
	)		`[static]`

Add a child to the object tree.

Parameters:

$contentobjectID	The ID of the contentobject the child-node should point to.
$nodeID	The ID of the parent-node to add child-node to.
$asObject	If true it will return the new child-node as an object, if not it returns the ID.
$contentObjectVersion	The version to use on the newly created child-node, if false it uses the current_version of the specified object.

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 3250 of file ezcontentobjecttreenode.php.

Referenced by addChild(), eZContentObject\addLocation(), and createObject().

eZContentObjectTreeNode::adjustPathElement	(	$	element,
		$	useParentFromNodeObject = `false`
	)

Checks the path element $element against reserved words and existing elements. If the path element is already used, it will append a number and try again.

The adjusted path element is returned.

Parameters:

$element	The desired url element name
$useParentFromNodeObject	Use the parent from node object as a base for checking name collisions. This is needed when moving nodes, and the url entries are not updated yet.

     echo $node->adjustPathElement( 'Content' ); // outputs Content1

Definition at line 3403 of file ezcontentobjecttreenode.php.

Referenced by checkPath(), and updateSubTreePath().

static eZContentObjectTreeNode::assignSectionToSubTree	(	$	nodeID,
		$	sectionID,
		$	oldSectionID = `false`
	)		`[static]`

Will assign a section to the current node and all child objects. Only main node assignments will be updated.

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 2688 of file ezcontentobjecttreenode.php.

Referenced by eZContentObjectTreeNodeOperations\move(), eZSiteInstaller\setSection(), eZSiteInstaller\swapNodes(), and updateMainNodeID().

eZContentObjectTreeNode::availableClassesJsArray ( )

Definition at line 5935 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::availableClassListJsArray ( $ parameters = false ) [static]

Definition at line 5944 of file ezcontentobjecttreenode.php.

Referenced by availableClassesJsArray(), eZContentStructureTreeOperator\createContentStructureNode(), and eZContentStructureTreeOperator\initContentStructureTree().

static eZContentObjectTreeNode::calendar	(	$	params = `false`,
		$	nodeID = `0`
	)		`[static]`

Returns:: The date/time list when object were published

Definition at line 2415 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::canAddLocation ( )

Returns:: true if current user can add object locations to current node.

See also:: checkAccess()

Definition at line 449 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::canCreate ( )

Returns:: true if the current user can create a new node as child of this node.

See also:: checkAccess().

Definition at line 372 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::canCreateClassList	(	$	asObject = `false`,
		$	includeFilter = `true`,
		$	groupList = `false`,
		$	fetchID = `false`
	)

Finds all classes that the current user can create objects from and returns. It is also possible to filter the list event more with $includeFilter and $groupList.

Parameters:

$asObject	If `true` then it return eZContentClass objects, if not it will be an associative array with `name` and `id` keys.
$includeFilter	If `true` then it will include only from class groups defined in $groupList, if not it will exclude those groups.
$groupList	An array with class group IDs that should be used in filtering, use `false` if you do not wish to filter at all.
$fetchID	A unique name for the current fetch, this must be supplied when filtering is used if you want caching to work.

Definition at line 4912 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::canEdit ( )

Returns:: true if the node can be edited by the current user.

See also:: checkAccess().

Definition at line 334 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::canHide ( )

Returns:: true if the node can be hidden by the current user.

See also:: checkAccess().

Definition at line 359 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::canMove ( )

Check if the node can be moved. (actually checks 'edit' and 'remove' permissions)

Returns:: true if the node can be moved by the current user.

See also:: checkAccess().

Deprecated:: The function canMove() is preferred since its naming is clearer.

Definition at line 400 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::canMoveFrom ( )

Check if the node can be moved. (actually checks 'edit' and 'remove' permissions)

Returns:: true if the node can be moved by the current user.

See also:: checkAccess().

Definition at line 410 of file ezcontentobjecttreenode.php.

Referenced by canMove().

eZContentObjectTreeNode::canMoveTo ( $ classID = false )

Returns:: true if a node of class $classID can be moved to the current node by the current user.

See also:: checkAccess().

Definition at line 423 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::canPdf ( )

Returns:: true if the current user can create a pdf of this content object.

Definition at line 307 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::canRead ( )

Returns:: true if the node can be read by the current user.

See also:: checkAccess().

Definition at line 295 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::canRemove ( )

Returns:: true if the node can be removed by the current user.

See also:: checkAccess().

Definition at line 385 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::canRemoveLocation ( )

Returns:: true if current user can add object locations to current node.

Definition at line 461 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::canSwap ( )

Returns:: true if a node can be swaped by the current user.

See also:: checkAccess().

Definition at line 436 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::canViewEmbed ( )

Returns:: true if the node can be viewed as embeded object by the current user.

See also:: checkAccess().

Definition at line 321 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::checkAccess	(	$	functionName,
		$	originalClassID = `false`,
		$	parentClassID = `false`,
		$	returnAccessList = `false`,
		$	language = `false`
	)

Definition at line 4236 of file ezcontentobjecttreenode.php.

Referenced by canAddLocation(), canCreate(), canEdit(), canHide(), canMoveFrom(), canMoveTo(), canPdf(), canRead(), canRemove(), canRemoveLocation(), canSwap(), and canViewEmbed().

eZContentObjectTreeNode::checkPath ( $ path )

Check if a node with the same name already exists. If so create a $name + __x value.

Definition at line 3379 of file ezcontentobjecttreenode.php.

Referenced by pathWithNames().

eZContentObjectTreeNode::children ( )

Returns the first level children in sorted order.

Definition at line 2563 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::childrenByName ( $ name )

Returns:: the children(s) of the current node as an array of eZContentObjectTreeNode objects

Definition at line 2518 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::childrenCount ( $ checkPolicies = true )

Returns the number of children for the current node. $checkPolicies If true it will only include nodes which can be read using the current policies, if false all nodes are included in count.

Definition at line 2575 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::classAttributeIDByIdentifier ( $ identifier ) [static]

Returns:: the ID of the class attribute with the given ID. False is returned if no class/attribute by that identifier is found. If multiple classes have the same identifier, the first found is returned.

Definition at line 276 of file ezcontentobjecttreenode.php.

Referenced by createAttributeFilterSQLStrings(), and createSortingSQLStrings().

static eZContentObjectTreeNode::classIDByIdentifier ( $ identifier ) [static]

Returns:: the ID of the class with the given ID. False is returned if no class by that identifier is found. If multiple classes have the same identifier, the first found is returned.

Definition at line 286 of file ezcontentobjecttreenode.php.

Referenced by createClassFilteringSQLString(), and subTreeCountByNodeID().

eZContentObjectTreeNode::classIdentifier ( )

Returns:: the cached value of the class identifier if it exists, if not it's fetched dynamically

Definition at line 5621 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::classIsContainer ( )

Returns:: the cached value of the class is_container flag if it exists, if not it's fetched dynamically

Definition at line 5650 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::classListFromPolicy	(	$	policy,
		$	allowedLanguageCodes = `false`
	)

Definition at line 4701 of file ezcontentobjecttreenode.php.

Referenced by canCreateClassList().

eZContentObjectTreeNode::className ( )

Returns:: the cached value of the class name if it exists, if not it's fetched dynamically

Definition at line 5635 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::clearViewCacheForSubtree	(	eZContentObjectTreeNode $	node,
		$	clearForRootNode = `true`
	)		`[static]`

static

Returns:: true on success, false otherwise

Definition at line 5851 of file ezcontentobjecttreenode.php.

Referenced by hideSubTree(), and unhideSubTree().

eZContentObjectTreeNode::contentObjectVersionObject ( $ asObject = true )

Definition at line 5560 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::create	(	$	parentNodeID = `null`,
		$	contentObjectID = `null`,
		$	contentObjectVersion = `0`,
		$	sortField = `0`,
		$	sortOrder = `true`
	)		`[static]`

Creates a new tree node and returns it.

Parameters:

$parentNodeID	The ID of the parent or `null` if the node is not known yet.
$contentObjectID	The ID of the object it points to or `null` if it is not known yet.
$contentObjectVersion	The version of the object or `0` if not known yet.
$sortField	Number describing the field to sort by, or `0` if not known yet.
$sortOrder	Which way to sort, `true` means ascending while `false` is descending.

Note:: The attribute remote_id will get an automatic and unique value.

Definition at line 213 of file ezcontentobjecttreenode.php.

Referenced by addChildTo(), createSortingSQLStrings(), and unserialize().

static eZContentObjectTreeNode::createAttributeFilterSQLStrings	(	&$	attributeFilter,
		&$	sortingInfo = `array( 'sortCount' => 0, 'attributeJoinCount' => 0 )`
	)		`[static]`

static

Definition at line 887 of file ezcontentobjecttreenode.php.

Referenced by calendar(), subTreeByNodeID(), subTreeCountByNodeID(), subTreeMultiPaths(), and eZContentObjectTrashNode\trashList().

static eZContentObjectTreeNode::createClassFilteringSQLString	(	$	classFilterType,
		&$	classFilterArray
	)		`[static]`

static

Definition at line 733 of file ezcontentobjecttreenode.php.

Referenced by calendar(), eZContentStructureTreeOperator\subTree(), subTreeByNodeID(), and subTreeMultiPaths().

static eZContentObjectTreeNode::createExtendedAttributeFilterSQLStrings ( &$ extendedAttributeFilter ) [static]

static

Definition at line 790 of file ezcontentobjecttreenode.php.

Referenced by calendar(), subTreeByNodeID(), subTreeCountByNodeID(), and subTreeMultiPaths().

static eZContentObjectTreeNode::createGroupBySQLStrings	(	&$	outGroupBySelectText,
		&$	outGroupByText,
		$	groupBy
	)		`[static]`

static

Definition at line 1434 of file ezcontentobjecttreenode.php.

Referenced by calendar(), subTreeByNodeID(), and subTreeMultiPaths().

static eZContentObjectTreeNode::createMainNodeConditionSQLString ( $ mainNodeOnly ) [static]

static

Definition at line 848 of file ezcontentobjecttreenode.php.

Referenced by calendar(), subTreeByNodeID(), and subTreeMultiPaths().

static eZContentObjectTreeNode::createNodesConditionSQLStringFromPath	(	$	nodePath,
		$	includingLastNodeInThePath,
		$	limit = `false`
	)		`[static]`

static

Parameters:

$limit maximum number of nodes in the path to use, starting from last node

Definition at line 1686 of file ezcontentobjecttreenode.php.

Referenced by fetchNodesByPathString().

static eZContentObjectTreeNode::createNotEqParentSQLString	(	$	nodeID,
		$	depth = `false`,
		$	depthOperator = `'le'`
	)		`[static]`

static

Definition at line 1264 of file ezcontentobjecttreenode.php.

Referenced by createPathConditionAndNotEqParentSQLStrings().

eZContentObjectTreeNode::createObject	(	$	contentClassID,
		$	parentNodeID = `2`
	)

Deprecated:: This function should no longer be used, use the eZContentClass::instantiate and eZNodeAssignment::create instead.

Definition at line 3204 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::createObjectNameFilterConditionSQLString ( $ filter ) [static]

static

Definition at line 863 of file ezcontentobjecttreenode.php.

Referenced by subTreeByNodeID(), subTreeCountByNodeID(), and eZContentObjectTrashNode\trashList().

static eZContentObjectTreeNode::createPathConditionAndNotEqParentSQLStrings	(	&$	outPathConditionStr,
		&$	outNotEqParentStr,
		$	nodeID,
		$	depth = `false`,
		$	depthOperator = `'le'`
	)		`[static]`

static

Definition at line 1321 of file ezcontentobjecttreenode.php.

Referenced by calendar(), eZContentStructureTreeOperator\subTree(), subTreeByNodeID(), subTreeCountByNodeID(), and subTreeMultiPaths().

static eZContentObjectTreeNode::createPathConditionSQLString	(	$	nodePath,
		$	nodeDepth,
		$	depth = `false`,
		$	depthOperator = `'le'`
	)		`[static]`

static

Definition at line 1278 of file ezcontentobjecttreenode.php.

Referenced by createPathConditionAndNotEqParentSQLStrings().

static eZContentObjectTreeNode::createPermissionCheckingSQL	(	$	limitationList,
		$	treeTableName = `'ezcontentobject_tree'`,
		$	tableAliasName = `'ezcontentobject_tree'`
	)		`[static]`

static

Definition at line 1526 of file ezcontentobjecttreenode.php.

Referenced by calendar(), createPermissionCheckingSQLString(), eZContentStructureTreeOperator\subTree(), subTreeByNodeID(), subTreeCountByNodeID(), subTreeMultiPaths(), and eZContentObjectTrashNode\trashList().

static eZContentObjectTreeNode::createPermissionCheckingSQLString ( $ limitationList ) [static]

static Deprecated. Use 'createPermissionCheckingSQL' instead.

Definition at line 1517 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::createShowInvisibleSQLString	(	$	useSettings,
		$	fetchHidden = `true`
	)		`[static]`

static If $useSettings is true $fetchHidden will be ignored. If $useSettings is false $fetchHidden will be used.

Definition at line 1725 of file ezcontentobjecttreenode.php.

Referenced by calendar(), eZContentStructureTreeOperator\subTree(), subTreeByNodeID(), subTreeCountByNodeID(), and subTreeMultiPaths().

static eZContentObjectTreeNode::createSortingSQLStrings	(	$	sortList,
		$	treeTableName = `'ezcontentobject_tree'`,
		$	allowCustomColumns = `false`
	)		`[static]`

static

Definition at line 529 of file ezcontentobjecttreenode.php.

Referenced by eZContentObject\relatedObjects(), eZContentStructureTreeOperator\subTree(), subTreeByNodeID(), subTreeMultiPaths(), and eZContentObjectTrashNode\trashList().

static eZContentObjectTreeNode::createVersionNameJoinsSQLString	(	$	useVersionName,
		$	includeAnd = `true`,
		$	onlyTranslated = `false`,
		$	lang = `false`,
		$	treeTableName = `'ezcontentobject_tree'`
	)		`[static]`

static

Definition at line 1497 of file ezcontentobjecttreenode.php.

Referenced by calendar(), fetchNodesByPathString(), eZContentStructureTreeOperator\subTree(), subTreeByNodeID(), subTreeCountByNodeID(), subTreeMultiPaths(), and eZContentObjectTrashNode\trashList().

static eZContentObjectTreeNode::createVersionNameTablesSQLString ( $ useVersionName ) [static]

static

Definition at line 1466 of file ezcontentobjecttreenode.php.

Referenced by calendar(), fetchNodesByPathString(), eZContentStructureTreeOperator\subTree(), subTreeByNodeID(), subTreeCountByNodeID(), subTreeMultiPaths(), and eZContentObjectTrashNode\trashList().

static eZContentObjectTreeNode::createVersionNameTargetsSQLString ( $ useVersionName ) [static]

static

Definition at line 1481 of file ezcontentobjecttreenode.php.

Referenced by fetchNodesByPathString(), eZContentStructureTreeOperator\subTree(), subTreeByNodeID(), subTreeCountByNodeID(), subTreeMultiPaths(), and eZContentObjectTrashNode\trashList().

eZContentObjectTreeNode::creator ( )

Returns:: the creator of the version published in the node.

Definition at line 5547 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::currentLanguage ( )

Definition at line 5897 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::dataMap ( )

Returns:: a map with all the content object attributes where the keys are the attribute identifiers.

See also:: eZContentObject::fetchDataMap

Definition at line 241 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::dataTypeByClassAttributeID ( $ classAttributeID ) [static]

Definition at line 483 of file ezcontentobjecttreenode.php.

Referenced by createSortingSQLStrings().

static eZContentObjectTreeNode::definition ( ) [static]

Returns:: the definition for the object, the default implementation is to return an empty array. It's upto each inheriting class to return a proper definition array.

The definition array is an associative array consists of these keys:

fields - an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
keys - an array of fields which is used for uniquely identifying the object in the table.
function_attributes - an associative array of attributes which maps to member functions, used for fetching data with functions.
set_functions - an associative array of attributes which maps to member functions, used for setting data with functions.
increment_key - the field which is incremented on table inserts.
class_name - the classname which is used for instantiating new objecs when fetching from the database.
sort - an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either asc or desc.
name - the name of the database table

Example:

static function definition()
{
    return array( "fields" => array( "id" => "ID",
                                     "version" => "Version",
                                     "name" => "Name" ),
                  "keys" => array( "id", "version" ),
                  "function_attributes" => array( "current" => "currentVersion",
                                                  "class_name" => "className" ),
                  "increment_key" => "id",
                  "class_name" => "eZContentClass",
                  "sort" => array( "id" => "asc" ),
                  "name" => "ezcontentclass" );
}

Reimplemented from eZPersistentObject.

Reimplemented in eZContentObjectTrashNode.

Definition at line 88 of file ezcontentobjecttreenode.php.

Referenced by eZSSLZone\checkNodeID(), eZSSLZone\checkObject(), and fetchByContentObjectID().

static eZContentObjectTreeNode::deleteNodeWhereParent	(	$	node,
		$	id
	)		`[static]`

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 5197 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::eZContentObjectTreeNode ( $ row = array() )

Constructor

Definition at line 83 of file ezcontentobjecttreenode.php.

Referenced by create(), fetchList(), and makeObjectsArray().

static eZContentObjectTreeNode::fetch	(	$	nodeID = `false`,
		$	lang = `false`,
		$	asObject = `true`,
		$	conditions = `false`
	)		`[static]`

Fetch node by $nodeID. If $nodeID is an array of ids then list of nodes will be returned.

Definition at line 2953 of file ezcontentobjecttreenode.php.

Referenced by eZContentObjectPackageHandler\add(), addChildTo(), eZPolicyLimitation\allValuesAsArrayWithNames(), assignSectionToSubTree(), availableClassListJsArray(), eZContentUpload\checkAccess(), checkAccess(), classListFromPolicy(), eZSubtreeCache\cleanupByNodeIDs(), eZNodeviewfunctions\contentViewGenerate(), copyPublishContentObject(), eZContentFunctions\createAndPublishObject(), eZObjectRelationListType\createNewObject(), createObject(), createPathConditionAndNotEqParentSQLStrings(), creator(), eZSimplifiedXMLEditOutput\eznodeHref(), fetchByPath(), fetchByRemoteID(), fetchByURLPath(), eZWebDAVContentServer\fetchNodeByTranslation(), eZWebDAVContentBackend\fetchNodeByTranslation(), eZSubtreeNotificationRule\fetchNodesForUserID(), fetchParent(), eZWebDAVContentServer\fetchParentNodeByTranslation(), eZWebDAVContentBackend\fetchParentNodeByTranslation(), eZContentObjectPackageHandler\generateFetchAliasArray(), eZContentCacheManager\generateObjectViewCache(), eZContentObjectPackageHandler\generatePackage(), eZContentObjectPackageCreator\generatePackageInformation(), eZSSLZone\getSSLZones(), eZContentObjectPackageHandler\handleParameters(), eZHTTPHeader\headerOverrideArray(), importRSSItem(), eZContentStructureTreeOperator\initContentStructureTree(), eZObjectRelationListType\initializeObjectAttribute(), eZContentObjectPackageInstaller\initializeTopNodes(), eZTreeMenuOperator\modify(), eZContentObjectTreeNodeOperations\move(), move(), eZSubtreeNotificationRule\node(), eZContentUpload\nodeAliasID(), eZContentObjectAssignmentHandler\nodeID(), object(), eZContentObjectTrashNode\originalParent(), eZXMLOutputHandler\prefetch(), eZSimplifiedXMLInputParser\publishHandlerEmbed(), eZSimplifiedXMLInputParser\publishHandlerLink(), removeNode(), removeSubtrees(), reverseRelatedCount(), eZContentObjectAssignmentHandler\setupAssignments(), eZContentStructureTreeOperator\subTree(), eZSiteInstaller\swapNodes(), eZXMLTextType\transformLinksToRemoteLinks(), eZXMLTextType\transformRemoteLinksToLinks(), updateMainNodeID(), and viewCount().

static eZContentObjectTreeNode::fetchAliasesFromNodeList ( $ nodeList ) [static]

Fetches path_identification_string for a list of nodes.

Parameters:

array(int) $nodeList

Returns:: array Associative array

Definition at line 2855 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::fetchByContentObjectID	(	$	contentObjectID,
		$	asObject = `true`,
		$	contentObjectVersion = `false`
	)		`[static]`

Definition at line 2812 of file ezcontentobjecttreenode.php.

Referenced by eZWishList\discountPercent(), eZRole\fetchByUser(), eZLDAPUser\publishNewUserGroup(), eZContentObjectVersion\serialize(), and eZContentObject\setAlwaysAvailableLanguageID().

eZContentObjectTreeNode::fetchByCRC ( $ pathStr )

Definition at line 2806 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::fetchByPath	(	$	pathString,
		$	asObject = `true`
	)		`[static]`

Definition at line 2832 of file ezcontentobjecttreenode.php.

Referenced by eZPolicyLimitation\allValuesAsArrayWithNames().

static eZContentObjectTreeNode::fetchByRemoteID	(	$	remoteID,
		$	asObject = `true`
	)		`[static]`

Definition at line 2827 of file ezcontentobjecttreenode.php.

Referenced by eZContentObjectPackageHandler\installFetchAliases(), eZContentObjectPackageHandler\installOverrides(), eZContentObjectPackageHandler\installSuspendedNodeAssignment(), eZXMLTextType\transformRemoteLinksToLinks(), and unserialize().

static eZContentObjectTreeNode::fetchByURLPath	(	$	pathString,
		$	asObject = `true`
	)		`[static]`

Definition at line 2837 of file ezcontentobjecttreenode.php.

Referenced by eZStaticCache\generateNodeListCache(), eZContentObjectPackageHandler\handleParameters(), eZContentUpload\nodeAliasID(), eZSiteInstaller\nodeByUrl(), eZSimplifiedXMLInputParser\publishHandlerEmbed(), and eZSimplifiedXMLInputParser\publishHandlerLink().

static eZContentObjectTreeNode::fetchClassIdentifierListByPathString	(	$	nodePath,
		$	withLastNode,
		$	limit = `false`
	)		`[static]`

Extracts each node that in the path from db and returns an array of class identifiers

Parameters:

$nodePath	A string containing the path of the node, it consists of node IDs starting from the root and delimited by / (slash).
$withLastNode	If `true` the last node in the path is included in the list. The last node is the node which the path was fetched from.
$limit	maximum number of nodes in the path to use, starting from last node

Returns:: An array with class identifier and node ID.

Example

     $list = fetchClassIdentifierListByPathString( '/2/10/', false );

Definition at line 3187 of file ezcontentobjecttreenode.php.

Referenced by eZContentCacheManager\nodeListForObject().

static eZContentObjectTreeNode::fetchList	(	$	asObject = `true`,
		$	offset = `false`,
		$	limit = `false`
	)		`[static]`

Fetches a list of nodes and returns it. Offset and limitation can be set if needed.

Definition at line 503 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::fetchListCount ( ) [static]

Fetches the number of nodes which exists in the system.

Definition at line 492 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::fetchNode	(	$	contentObjectID,
		$	parentNodeID
	)		`[static]`

Finds the node for the object $contentObjectID which placed as child of node $parentNodeID.

Returns:: An eZContentObjectTreeNode object or null if no node was found.

Definition at line 3067 of file ezcontentobjecttreenode.php.

Referenced by eZContentObjectTreeNodeOperations\move(), eZLDAPUser\publishUpdateUser(), and eZContentObject\unserialize().

static eZContentObjectTreeNode::fetchNodesByPathString	(	$	nodePath,
		$	withLastNode = `false`,
		$	asObjects = `true`,
		$	limit = `false`
	)		`[static]`

Returns:: An array with content node objects that is present in the node path $nodePath.

Parameters:

$withLastNode	If `true` the last node in the path is included in the list. The last node is the node which the path was fetched from.
$asObjects	If `true` then return PHP objects, if not return raw row data.
$limit	maximum number of nodes in the path to use, starting from last node

Definition at line 3131 of file ezcontentobjecttreenode.php.

Referenced by fetchClassIdentifierListByPathString(), and fetchPath().

eZContentObjectTreeNode::fetchParent ( )

Definition at line 3097 of file ezcontentobjecttreenode.php.

Referenced by removeThis(), updatePathIdentificationString(), and updateSubTreePath().

eZContentObjectTreeNode::fetchPath ( )

Definition at line 3116 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::findMainNode	(	$	objectID,
		$	asObject = `false`
	)		`[static]`

Definition at line 2867 of file ezcontentobjecttreenode.php.

Referenced by eZContentObject\mainNode(), and eZContentObject\mainNodeID().

static eZContentObjectTreeNode::findMainNodeArray	(	$	objectIDArray,
		$	asObject = `true`
	)		`[static]`

Fetches the main nodes for an array of object id's.

Parameters:

	array(int)	$objectIDArray an array of object IDs
bool	$asObject	Wether to return the result as an array of eZContentObjectTreeNode (true) or as an array of associative arrays (false)

Returns:: array(array|eZContentObjectTreeNode)

Definition at line 2914 of file ezcontentobjecttreenode.php.

Referenced by eZKeyword\relatedObjects().

static eZContentObjectTreeNode::findNode	(	$	parentNode,
		$	id,
		$	asObject = `false`,
		$	remoteID = `false`
	)		`[static]`

Definition at line 5203 of file ezcontentobjecttreenode.php.

Referenced by deleteNodeWhereParent().

static eZContentObjectTreeNode::getClassesJsArray	(	$	node = `false`,
		$	includeFilter = `true`,
		$	groupList = `false`,
		$	fetchID = `false`,
		$	classes = `false`
	)		`[static]`

Definition at line 6034 of file ezcontentobjecttreenode.php.

Referenced by availableClassListJsArray().

static eZContentObjectTreeNode::getLimitationList ( &$ limitation ) [static]

static

Definition at line 1761 of file ezcontentobjecttreenode.php.

Referenced by calendar(), eZContentStructureTreeOperator\subTree(), subTreeByNodeID(), subTreeCountByNodeID(), subTreeMultiPaths(), and eZContentObjectTrashNode\trashList().

eZContentObjectTreeNode::getName ( $ language = false )

Definition at line 5268 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::getParentNodeId ( $ nodeID ) [static]

Get parent node id by node id

Parameters:

$nodeID the node id you want parent node id for.

Definition at line 5124 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::getParentNodeIdListByContentObjectID	(	$	objectIDs,
		$	groupByObjectId = `false`,
		$	onlyMainNode = `false`
	)		`[static]`

Get parent node id's by content object id's.

Since:: Version 4.1

Parameters:

int \| array	$objectIDs
bool	$groupByObjectId	groups parent node ids by object id they belong to.
bool	$onlyMainNode	limits result to parent node id of main node.

Returns:: array Returns array of parent node id's

Definition at line 5150 of file ezcontentobjecttreenode.php.

Referenced by eZContentObject\checkGroupLimitationAccess(), eZContentObject\mainParentNodeID(), and eZContentObject\parentNodes().

eZContentObjectTreeNode::hasContentObject ( )

Definition at line 5528 of file ezcontentobjecttreenode.php.

Referenced by object(), and setCurrentLanguage().

eZContentObjectTreeNode::hiddenInvisibleString ( )

Returns:: combined string representation of both "is_hidden" and "is_invisible" attributes Used in the node view templates. FIXME: this method probably should be removed in the future.

Definition at line 5666 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::hiddenStatusString ( )

Returns:: combined string representation of both "is_hidden" and "is_invisible" attributes Used in the limitation handling templates.

Definition at line 5675 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::hideSubTree	(	eZContentObjectTreeNode $	node,
		$	modifyRootNode = `true`
	)		`[static]`

static

Parameters:

$node	Root node of the subtree
$modifyRootNode	Whether to modify the root node (true/false)

Hide algorithm: if ( root node of the subtree is visible ) { 1) Mark root node as hidden and invisible 2) Recursively mark child nodes as invisible except for ones which have been previously marked as invisible } else { Mark root node as hidden }

In some cases we don't want to touch the root node when (un)hiding a subtree, for example after content/move or content/copy. That's why $modifyRootNode argument is used.

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 5712 of file ezcontentobjecttreenode.php.

Referenced by updateNodeVisibility().

eZContentObjectTreeNode::isMain ( )

Returns:: true if this node is the main node.

Definition at line 266 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::makeObjectsArray	(	$	array,
		$	with_contentobject = `true`
	)		`[static]`

Definition at line 5045 of file ezcontentobjecttreenode.php.

Referenced by eZContentObject\assignedNodes(), childrenByName(), fetch(), fetchNode(), fetchNodesByPathString(), findMainNode(), findMainNodeArray(), findNode(), subTreeByNodeID(), and subTreeMultiPaths().

eZContentObjectTreeNode::move	(	$	newParentNodeID,
		$	nodeID = `0`
	)

Moves the node to the given node.

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

role system clean up

Definition at line 4128 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::object ( )

Definition at line 5515 of file ezcontentobjecttreenode.php.

Referenced by classIdentifier(), classIsContainer(), className(), dataMap(), removeNodeFromTree(), removeThis(), and updateSubTreePath().

static eZContentObjectTreeNode::parentDepthLimitationList ( ) [static]

Definition at line 5915 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::pathArray ( )

Definition at line 3102 of file ezcontentobjecttreenode.php.

Referenced by pathWithNames().

eZContentObjectTreeNode::pathWithNames ( $ regenerateCurrent = false )

Returns:: an url alias for the current node. It will generate a unique alias.

Definition at line 3308 of file ezcontentobjecttreenode.php.

Referenced by urlAlias().

eZContentObjectTreeNode::remoteID ( )

Get remote id of content node, the remote ID is often used to synchronise imports and exports. If there is no remote ID a new unique one will be generated.

Definition at line 250 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::removeNode ( $ nodeID = 0 ) [static]

See also:: removeThis

Definition at line 3610 of file ezcontentobjecttreenode.php.

Referenced by deleteNodeWhereParent(), and eZContentObject\removeThis().

eZContentObjectTreeNode::removeNodeFromTree ( $ moveToTrash = true )

Will check if you are removing the main node in which case it relocates the main node before removing it. It will also remove the object if there no more node assignments for it.

Parameters:

$moveToTrash If true it will move the object to trash, if false the object will be purged from the system.

Note:: This uses remove() to do the actual node removal but has some extra logic; Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 3989 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::removeSubtrees	(	$	deleteIDArray,
		$	moveToTrash = `true`,
		$	infoOnly = `false`
	)		`[static]`

Will remove the nodes in the subtrees defined in $deleteIDArray, it will only remove the nodes unless there are no more nodes for an object in which case the object is removed too.

Parameters:

$moveToTrash	If `true` it will move the object to trash, if `false` the object will be purged from the system.
$infoOnly	If set to `true` then it will not remove the subtree but instead return information on what will happen if it is removed. See subtreeRemovalInformation() for the returned structure.

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 3753 of file ezcontentobjecttreenode.php.

Referenced by eZContentObjectOperations\remove(), subtreeRemovalInformation(), and eZContentObjectPackageHandler\uninstall().

eZContentObjectTreeNode::removeThis ( )

Removes the current node.

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 3627 of file ezcontentobjecttreenode.php.

Referenced by removeNodeFromTree().

static eZContentObjectTreeNode::reverseRelatedCount ( $ nodeIDArray ) [static, private]

Return reverse related count for specified node

Parameters:

$nodeIDArray,array of node id's

Returns:: reverse related count.

Definition at line 3940 of file ezcontentobjecttreenode.php.

Referenced by removeSubtrees().

eZContentObjectTreeNode::serialize	(	$	options,
		$	contentNodeIDArray,
		$	topNodeIDArray
	)

Serialize ContentObjectTreeNode

$options contentNodeIDArray topNodeIDArray

Definition at line 5451 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::setContentObject ( $ object )

Sets the current content object for this node.

Definition at line 5539 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::setCurrentLanguage ( $ languageCode )

Definition at line 5902 of file ezcontentobjecttreenode.php.

eZContentObjectTreeNode::setName ( $ name )

Definition at line 5303 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::setVersionByObjectID	(	$	objectID,
		$	newVersion
	)		`[static]`

Definition at line 5891 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::showInvisibleNodes ( ) [static]

static

Returns:: true if we should show invisible nodes (determined by ini setting), false otherwise.

Definition at line 1743 of file ezcontentobjecttreenode.php.

Referenced by eZNodeviewfunctions\contentViewGenerate(), and createShowInvisibleSQLString().

eZContentObjectTreeNode::sortArray ( )

Returns:: an array which defines the sorting method for this node. The array will contain one element which is an array with sort field and sort order.

Definition at line 2664 of file ezcontentobjecttreenode.php.

Referenced by children().

static eZContentObjectTreeNode::sortArrayBySortFieldAndSortOrder	(	$	sortField,
		$	sortOrder
	)		`[static]`

Returns:: an array which defines the sorting method for this node. The array will contain one element which is an array with sort field and sort order.

Definition at line 2676 of file ezcontentobjecttreenode.php.

Referenced by eZContentStructureTreeOperator\createContentStructureNode(), and sortArray().

static eZContentObjectTreeNode::sortFieldID ( $ sortFieldName ) [static]

Returns:: the numeric sort field ID for the sort field name $sortFieldName. Gives a warning if the name is unknown and returns self::SORT_FIELD_PATH.

Definition at line 2630 of file ezcontentobjecttreenode.php.

Referenced by eZContentClassPackageHandler\install(), and unserialize().

static eZContentObjectTreeNode::sortFieldName ( $ sortFieldID ) [static]

Returns:: the sort field name for the numeric sort field ID $sortFieldID. Gives a warning if the ID is unknown and returns 'path'.

Definition at line 2597 of file ezcontentobjecttreenode.php.

Referenced by eZContentClassPackageHandler\classDOMTree(), serialize(), and sortArrayBySortFieldAndSortOrder().

static eZContentObjectTreeNode::sortKeyByClassAttributeID ( $ classAttributeID ) [static]

Returns:: the sort key for the given classAttributeID. int|string is returend. False is returned if unsuccessful.

Definition at line 475 of file ezcontentobjecttreenode.php.

Referenced by createAttributeFilterSQLStrings(), and createSortingSQLStrings().

eZContentObjectTreeNode::store ( $ fieldFilters = null )

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Reimplemented from eZPersistentObject.

Definition at line 5505 of file ezcontentobjecttreenode.php.

Referenced by eZContentObjectTrashNode\storeToTrash().

eZContentObjectTreeNode::subTree ( $ params = false )

Definition at line 1982 of file ezcontentobjecttreenode.php.

Referenced by children(), and clearViewCacheForSubtree().

static eZContentObjectTreeNode::subTreeByNodeID	(	$	params = `false`,
		$	nodeID = `0`
	)		`[static]`

See also:: subTree

Definition at line 1798 of file ezcontentobjecttreenode.php.

Referenced by eZContentObjectPackageHandler\addNode(), eZContentCacheManager\appendSiblingsNodeIDs(), eZObjectRelationType\fetchObjectAttributeHTTPInput(), eZLDAPUser\goAndPublishGroups(), eZTreeMenuOperator\modify(), and subTree().

eZContentObjectTreeNode::subTreeCount ( $ params = array() )

Count number of subnodes

Parameters:

params array

Definition at line 2407 of file ezcontentobjecttreenode.php.

Referenced by childrenCount(), and clearViewCacheForSubtree().

static eZContentObjectTreeNode::subTreeCountByNodeID	(	$	params = `array()`,
		$	nodeID
	)		`[static]`

See also:: subTreeCount

Definition at line 2253 of file ezcontentobjecttreenode.php.

Referenced by subTreeCount().

static eZContentObjectTreeNode::subTreeGroupByDateField	(	$	field,
		$	type
	)		`[static]`

Definition at line 2207 of file ezcontentobjecttreenode.php.

Referenced by createGroupBySQLStrings().

static eZContentObjectTreeNode::subTreeMultiPaths	(	$	nodesParams,
		$	listParams = `NULL`
	)		`[static]`

Retrieve subtrees from multiple paths.

This method composes a list of objects retrieved from various node paths, sorted by criteria that are globally applied to the whole list.

It is for example useful for an RSS feed that serves content from several node paths. The respective subtrees need to be amalgated and the resulting object listed sorted by publishing date to show the latest entries in chronological order.

The first parameter is a multi-dimensional array containing the node IDs and filter criteria assigned to each of the nodes:

array( [node_1] => array( 'ClassFilterType' => [filter_type], 'ClassFilterArray' => [filter_array] ), [node_2] => array( 'ClassFilterType' => [filter_type], 'ClassFilterArray' => [filter_array] ) )

The second parameter is a single-dimensional array with criteria applied to the list of objects retrieved from the various subtrees:

array( 'SortBy' => [sorting-criteria] )

Definition at line 2019 of file ezcontentobjecttreenode.php.

Referenced by eZRSSExportItem\fetchNodeList().

static eZContentObjectTreeNode::subtreeRemovalInformation ( $ deleteIDArray ) [static]

Returns information on what will happen if all subtrees in $deleteIDArray is removed. The returned structure is:

move_to_trash - true if removed objects can be moved to trash, some objects are not allowed to be in trash (e.g user).
total_child_count - The total number of children for all delete items
can_remove_all - Will be set to true if all selected items can be removed, false otherwise
delete_list - A list of all subtrees that should be removed, structure: -- node - The content node -- object - The content object -- class - The content class -- node_name - The name of the node -- child_count - Total number of child items below the node -- can_remove - Boolean which tells if the user has permission to remove the node -- can_remove_subtree - Boolean which tells if the user has permission to remove items in the subtree -- new_main_node_id - The new main node ID for the node if it needs to be moved, or false if not -- object_node_count - The number of nodes the object has (before removal) -- sole_node_count - The number of nodes in the subtree (excluding current) that does not have multiple locations.

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 3732 of file ezcontentobjecttreenode.php.

Referenced by eZContentObjectPackageHandler\uninstall().

eZContentObjectTreeNode::subtreeSoleNodeCount ( $ params = array() )

Returns:: The number of nodes in the current subtree that have no other placements.

Definition at line 4056 of file ezcontentobjecttreenode.php.

static eZContentObjectTreeNode::unhideSubTree	(	eZContentObjectTreeNode $	node,
		$	modifyRootNode = `true`
	)		`[static]`

static

Parameters:

$node	Root node of the subtree
$modifyRootNode	Whether to modify the root node (true/false)

Unhide algorithm: if ( parent node is visible ) { 1) Mark root node as not hidden and visible. 2) Recursively mark child nodes as visible (except for nodes previosly marked as hidden, and all their children). } else { Mark root node as not hidden. }

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 5764 of file ezcontentobjecttreenode.php.

Referenced by updateNodeVisibility().

static eZContentObjectTreeNode::unserialize	(	$	contentNodeDOMNode,
		$	contentObject,
		$	version,
		$	isMain,
		&$	nodeList,
		&$	options,
		$	handlerType = `'ezcontentobject'`
	)		`[static]`

Creates propper nodeassigment from contentNodeDOMNode specification

Parameters:

contentobjecttreenode	DOMNode
contentobject.
version
isMain
options

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 5321 of file ezcontentobjecttreenode.php.

Referenced by checkAccess(), and classListFromPolicy().

eZContentObjectTreeNode::updateAndStoreModified ( )

Update and store modified_subnode value for this node and all super nodes.

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 5489 of file ezcontentobjecttreenode.php.

Referenced by hideSubTree(), store(), and unhideSubTree().

static eZContentObjectTreeNode::updateMainNodeID	(	$	mainNodeID,
		$	objectID,
		$	version = `false`,
		$	parentMainNodeID,
		$	updateSection = `true`
	)		`[static]`

Updates the main node selection for the content object $objectID.

Parameters:

$mainNodeID	The ID of the node that should be that main node
$objectID	The ID of the object that all nodes belong to
$version	The version of the object to update node assignments, use `false` for currently published version.
$parentMainNodeID	The ID of the parent node of the new main placement

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 2776 of file ezcontentobjecttreenode.php.

Referenced by eZContentObjectPackageHandler\installSuspendedNodeAssignment(), eZLDAPUser\publishUpdateUser(), removeNodeFromTree(), and eZContentObject\unserialize().

static eZContentObjectTreeNode::updateNodeVisibility	(	$	node,
		$	parentNode,
		$	recursive = `true`
	)		`[static]`

static Depending on the new parent node visibility, recompute "is_invisible" attribute for the given node and its children. (used after content/move or content/copy)

Definition at line 5812 of file ezcontentobjecttreenode.php.

Referenced by eZWebDAVContentBackend\copyObject(), eZWebDAVContentBackend\copyObjectSameDirectory(), copyPublishContentObject(), and move().

eZContentObjectTreeNode::updatePathIdentificationString ( $ pathIdentificationName ) [private]

Updates the path_identification_string field in ezcontentobject_tree by fetching the value from the parent and appending $pathIdentificationName.

Note:: This stores the current object to the database

Definition at line 3576 of file ezcontentobjecttreenode.php.

Referenced by updateSubTreePath().

eZContentObjectTreeNode::updateSubTreePath	(	$	updateParent = `true`,
		$	nodeMove = `false`
	)

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Definition at line 3443 of file ezcontentobjecttreenode.php.

Referenced by updateURLAlias().

eZContentObjectTreeNode::updateURLAlias ( )

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.