kernel/classes/ezcontentobjecttreenode.php
File containing the eZContentObjectTreeNode class.
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Package
- kernel
- Version
- 4.6.0
\eZContentObjectTreeNode
File containing the eZContentObjectTreeNode class.
- Parent(s)
- \eZPersistentObject
- Children
- \eZContentObjectTrashNode
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Version
- 4.6.0
Constants
Properties


$PersistentDataDirty= ''
- Type
- n/a
- Inherited_from
- \eZPersistentObject::$$PersistentDataDirty
Methods


addChild(
$contentobjectID, $asObject
=
false, $contentObjectVersion
=
false
)
:
void
Name | Type | Description |
---|---|---|
$contentobjectID | ||
$asObject | ||
$contentObjectVersion |


addChildTo(
$contentobjectID, $nodeID, $asObject
=
false, $contentObjectVersion
=
false
)
:
void
Name | Type | Description |
---|---|---|
$contentobjectID | ||
$nodeID | ||
$asObject | ||
$contentObjectVersion |


adjustPathElement(
$element, $useParentFromNodeObject
=
false
)
:
void
Name | Type | Description |
---|---|---|
$element | ||
$useParentFromNodeObject |


assignSectionToSubTree(
$nodeID, $sectionID, $oldSectionID
=
false
)
:
void
Name | Type | Description |
---|---|---|
$nodeID | ||
$sectionID | ||
$oldSectionID |


attribute(
$attr, $noFunction
=
false
)
:
void
Name | Type | Description |
---|---|---|
$attr | ||
$noFunction |


availableClassListJsArray(
$parameters
=
false
)
:
void
Name | Type | Description |
---|---|---|
$parameters |


calendar(
$params
=
false, $nodeID
=
0
)
:
void
Name | Type | Description |
---|---|---|
$params | ||
$nodeID |


canCreateClassList(
$asObject
=
false, $includeFilter
=
true, $groupList
=
false, $fetchID
=
false
)
:
void
Name | Type | Description |
---|---|---|
$asObject | ||
$includeFilter | ||
$groupList | ||
$fetchID |


checkAccess(
$functionName, $originalClassID
=
false, $parentClassID
=
false, $returnAccessList
=
false, $language
=
false
)
:
void
Name | Type | Description |
---|---|---|
$functionName | ||
$originalClassID | ||
$parentClassID | ||
$returnAccessList | ||
$language |


classAttributeIDByIdentifier(
$identifier
)
:
void
Name | Type | Description |
---|---|---|
$identifier |


classListFromPolicy(
$policy, $allowedLanguageCodes
=
false
)
:
void
Name | Type | Description |
---|---|---|
$policy | ||
$allowedLanguageCodes |


clearViewCacheForSubtree(
$node, $clearForRootNode
=
true
)
:
void
Name | Type | Description |
---|---|---|
$node | ||
$clearForRootNode |


count(
$def, $conds
=
null, $field
=
null
)
:
void
Name | Type | Description |
---|---|---|
$def | ||
$conds | ||
$field |


create(
$parentNodeID
=
null, $contentObjectID
=
null, $contentObjectVersion
=
0, $sortField
=
0, $sortOrder
=
true
)
:
void
Name | Type | Description |
---|---|---|
$parentNodeID | ||
$contentObjectID | ||
$contentObjectVersion | ||
$sortField | ||
$sortOrder |


createAttributeFilterSQLStrings(
$attributeFilter, $sortingInfo
=
array( 'sortCount' => 0, 'attributeJoinCount' => 0 )
)
:
void
Name | Type | Description |
---|---|---|
$attributeFilter | ||
$sortingInfo |


createClassFilteringSQLString(
$classFilterType, $classFilterArray
)
:
void
Name | Type | Description |
---|---|---|
$classFilterType | ||
$classFilterArray |


createExtendedAttributeFilterSQLStrings(
$extendedAttributeFilter
)
:
void
Name | Type | Description |
---|---|---|
$extendedAttributeFilter |


createGroupBySQLStrings(
$outGroupBySelectText, $outGroupByText, $groupBy
)
:
void
Name | Type | Description |
---|---|---|
$outGroupBySelectText | ||
$outGroupByText | ||
$groupBy |


createMainNodeConditionSQLString(
$mainNodeOnly
)
:
void
Name | Type | Description |
---|---|---|
$mainNodeOnly |


createNodesConditionSQLStringFromPath(
$nodePath, $includingLastNodeInThePath, $limit
=
false
)
:
void
Name | Type | Description |
---|---|---|
$nodePath | ||
$includingLastNodeInThePath | ||
$limit |


createNotEqParentSQLString(
$nodeID, $depth
=
false, $depthOperator
=
'le'
)
:
void
Name | Type | Description |
---|---|---|
$nodeID | ||
$depth | ||
$depthOperator |


createObject(
$contentClassID, $parentNodeID
=
2
)
:
void
Name | Type | Description |
---|---|---|
$contentClassID | ||
$parentNodeID |


createObjectNameFilterConditionSQLString(
$filter
)
:
void
Name | Type | Description |
---|---|---|
$filter |


createPathConditionAndNotEqParentSQLStrings(
$outPathConditionStr, $outNotEqParentStr, $nodeID, $depth
=
false, $depthOperator
=
'le'
)
:
void
Name | Type | Description |
---|---|---|
$outPathConditionStr | ||
$outNotEqParentStr | ||
$nodeID | ||
$depth | ||
$depthOperator |


createPathConditionSQLString(
$nodePath, $nodeDepth, $depth
=
false, $depthOperator
=
'le'
)
:
void
Name | Type | Description |
---|---|---|
$nodePath | ||
$nodeDepth | ||
$depth | ||
$depthOperator |


createPermissionCheckingSQL(
$limitationList, $treeTableName
=
'ezcontentobject_tree', $tableAliasName
=
'ezcontentobject_tree'
)
:
void
Name | Type | Description |
---|---|---|
$limitationList | ||
$treeTableName | ||
$tableAliasName |


createPermissionCheckingSQLString(
$limitationList
)
:
void
Name | Type | Description |
---|---|---|
$limitationList |


createShowInvisibleSQLString(
$useSettings, $fetchHidden
=
true
)
:
void
Name | Type | Description |
---|---|---|
$useSettings | ||
$fetchHidden |


createSortingSQLStrings(
$sortList, $treeTableName
=
'ezcontentobject_tree', $allowCustomColumns
=
false
)
:
void
Name | Type | Description |
---|---|---|
$sortList | ||
$treeTableName | ||
$allowCustomColumns |


createVersionNameJoinsSQLString(
$useVersionName, $includeAnd
=
true, $onlyTranslated
=
false, $lang
=
false, $treeTableName
=
'ezcontentobject_tree'
)
:
void
Name | Type | Description |
---|---|---|
$useVersionName | ||
$includeAnd | ||
$onlyTranslated | ||
$lang | ||
$treeTableName |


createVersionNameTablesSQLString(
$useVersionName
)
:
void
Name | Type | Description |
---|---|---|
$useVersionName |


createVersionNameTargetsSQLString(
$useVersionName
)
:
void
Name | Type | Description |
---|---|---|
$useVersionName |


dataTypeByClassAttributeID(
$classAttributeID
)
:
void
Name | Type | Description |
---|---|---|
$classAttributeID |


eZPersistentObject(
$row
)
:
void
Name | Type | Description |
---|---|---|
$row |


fetch(
int | array $nodeID
=
false, string $lang
=
false, bool $asObject
=
true, array $conditions
=
false
)
:
\eZContentObjectTreeNode
Fetches a node by ID
Name | Type | Description |
---|---|---|
$nodeID | int | array | Either a node ID or array of node IDs |
$lang | string | language code to fetch the node in. If not provided, the prioritized language list is used |
$asObject | bool | True to fetch the node as an eZContentObjectTreeNode, false to fetch its attributes as an array |
$conditions | array | An associative array (field => value) of fetch conditions. Will be applied as is to the SQL query |
Type | Description |
---|---|
\eZContentObjectTreeNode |


fetchAliasesFromNodeList(
\array(int) $nodeList
)
:
array
Fetches path_identification_string for a list of nodes
Name | Type | Description |
---|---|---|
$nodeList | \array(int) |
Type | Description |
---|---|
array | Associative array |


fetchByContentObjectID(
$contentObjectID, $asObject
=
true, $contentObjectVersion
=
false
)
:
void
Name | Type | Description |
---|---|---|
$contentObjectID | ||
$asObject | ||
$contentObjectVersion |


fetchByPath(
$pathString, $asObject
=
true
)
:
void
Name | Type | Description |
---|---|---|
$pathString | ||
$asObject |


fetchByRemoteID(
$remoteID, $asObject
=
true
)
:
void
Name | Type | Description |
---|---|---|
$remoteID | ||
$asObject |


fetchByURLPath(
$pathString, $asObject
=
true
)
:
void
Name | Type | Description |
---|---|---|
$pathString | ||
$asObject |


fetchClassIdentifierListByPathString(
$nodePath, $withLastNode, $limit
=
false
)
:
void
Name | Type | Description |
---|---|---|
$nodePath | ||
$withLastNode | ||
$limit |


fetchList(
$asObject
=
true, $offset
=
false, $limit
=
false
)
:
void
Name | Type | Description |
---|---|---|
$asObject | ||
$offset | ||
$limit |


fetchNode(
$contentObjectID, $parentNodeID
)
:
void
Name | Type | Description |
---|---|---|
$contentObjectID | ||
$parentNodeID |


fetchNodesByPathString(
$nodePath, $withLastNode
=
false, $asObjects
=
true, $limit
=
false
)
:
void
Name | Type | Description |
---|---|---|
$nodePath | ||
$withLastNode | ||
$asObjects | ||
$limit |


fetchObject(
$def, $field_filters, $conds, $asObject
=
true, $grouping
=
null, $custom_fields
=
null
)
:
void
Name | Type | Description |
---|---|---|
$def | ||
$field_filters | ||
$conds | ||
$asObject | ||
$grouping | ||
$custom_fields |


fetchObjectList(
$def, $field_filters
=
null, $conds
=
null, $sorts
=
null, $limit
=
null, $asObject
=
true, $grouping
=
false, $custom_fields
=
null, $custom_tables
=
null, $custom_conds
=
null
)
:
void
Name | Type | Description |
---|---|---|
$def | ||
$field_filters | ||
$conds | ||
$sorts | ||
$limit | ||
$asObject | ||
$grouping | ||
$custom_fields | ||
$custom_tables | ||
$custom_conds |


fill(
$row
)
:
void
Name | Type | Description |
---|---|---|
$row |


findMainNode(
int $objectID, boolean $asObject
=
false
)
:
int | null
Get Main Node Id ( or Main Node if $asObject = true ) by Content Object Id.
Name | Type | Description |
---|---|---|
$objectID | int | |
$asObject | boolean |
Type | Description |
---|---|
int | null |


findMainNodeArray(
\array(int) $objectIDArray, bool $asObject
=
true
)
:
\array(array | \eZContentObjectTreeNode)
Fetches the main nodes for an array of object id's
Name | Type | Description |
---|---|---|
$objectIDArray | \array(int) | an array of object IDs |
$asObject | bool | Wether to return the result as an array of eZContentObjectTreeNode (true) or as an array of associative arrays (false) |
Type | Description |
---|---|
\array(array | \eZContentObjectTreeNode) |


findNode(
$parentNode, $id, $asObject
=
false, $remoteID
=
false
)
:
void
Name | Type | Description |
---|---|---|
$parentNode | ||
$id | ||
$asObject | ||
$remoteID |


getClassesJsArray(
$node
=
false, $includeFilter
=
true, $groupList
=
false, $fetchID
=
false, $classes
=
false
)
:
void
Name | Type | Description |
---|---|---|
$node | ||
$includeFilter | ||
$groupList | ||
$fetchID | ||
$classes |


getParentNodeIdListByContentObjectID(
int | array $objectIDs, bool $groupByObjectId
=
false, bool $onlyMainNode
=
false
)
:
array
Get parent node id's by content object id's.
Name | Type | Description |
---|---|---|
$objectIDs | int | array | |
$groupByObjectId | bool | groups parent node ids by object id they belong to. |
$onlyMainNode | bool | limits result to parent node id of main node. |
Type | Description |
---|---|
array | Returns array of parent node id's |
- Since
- Version 4.1
- Static


getShortAttributeName(
$db, $def, $attrName
)
:
void
Name | Type | Description |
---|---|---|
$db | ||
$def | ||
$attrName |


handleRows(
$rows, $class_name, $asObject
)
:
void
Name | Type | Description |
---|---|---|
$rows | ||
$class_name | ||
$asObject |


hasAttribute(
$attr
)
:
void
Name | Type | Description |
---|---|---|
$attr |


hasCurrentSubtreeLimitation(
array $policy
)
:
bool
Checks if provided policy array has a limitation on current subtree
Name | Type | Description |
---|---|---|
$policy | array |
Type | Description |
---|---|
bool |


hideSubTree(
$node, $modifyRootNode
=
true
)
:
void
Name | Type | Description |
---|---|---|
$node | ||
$modifyRootNode |


makeObjectsArray(
$array, $with_contentobject
=
true
)
:
void
Name | Type | Description |
---|---|---|
$array | ||
$with_contentobject |


move(
$newParentNodeID, $nodeID
=
0
)
:
void
Name | Type | Description |
---|---|---|
$newParentNodeID | ||
$nodeID |


newObjectOrder(
$def, $orderField, $conditions
)
:
void
Name | Type | Description |
---|---|---|
$def | ||
$orderField | ||
$conditions |


pathWithNames(
$regenerateCurrent
=
false
)
:
void
Name | Type | Description |
---|---|---|
$regenerateCurrent |


remove(
$conditions
=
null, $extraConditions
=
null
)
:
void
Name | Type | Description |
---|---|---|
$conditions | ||
$extraConditions |


removeObject(
$def, $conditions
=
null, $extraConditions
=
null
)
:
void
Name | Type | Description |
---|---|---|
$def | ||
$conditions | ||
$extraConditions |


removeSubtrees(
$deleteIDArray, $moveToTrash
=
true, $infoOnly
=
false
)
:
void
Name | Type | Description |
---|---|---|
$deleteIDArray | ||
$moveToTrash | ||
$infoOnly |


reorderObject(
$def, $orderField, $conditions, $down
=
true
)
:
void
Name | Type | Description |
---|---|---|
$def | ||
$orderField | ||
$conditions | ||
$down |


replaceFieldsWithShortNames(
$db, $fieldDefs, $fields
)
:
void
Name | Type | Description |
---|---|---|
$db | ||
$fieldDefs | ||
$fields |


serialize(
$options, $contentNodeIDArray, $topNodeIDArray
)
:
void
Name | Type | Description |
---|---|---|
$options | ||
$contentNodeIDArray | ||
$topNodeIDArray |


setAttribute(
$attr, $val
)
:
void
Name | Type | Description |
---|---|---|
$attr | ||
$val |


setHasDirtyData(
$hasDirtyData
)
:
void
Name | Type | Description |
---|---|---|
$hasDirtyData |


setVersionByObjectID(
$objectID, $newVersion
)
:
void
Name | Type | Description |
---|---|---|
$objectID | ||
$newVersion |


sortArrayBySortFieldAndSortOrder(
$sortField, $sortOrder
)
:
void
Name | Type | Description |
---|---|---|
$sortField | ||
$sortOrder |


sortKeyByClassAttributeID(
$classAttributeID
)
:
void
Name | Type | Description |
---|---|---|
$classAttributeID |


storeObject(
$obj, $fieldFilters
=
null
)
:
void
Name | Type | Description |
---|---|---|
$obj | ||
$fieldFilters |


subTreeByNodeID(
$params
=
false, $nodeID
=
0
)
:
void
Name | Type | Description |
---|---|---|
$params | ||
$nodeID |


subTreeCountByNodeID(
$params
=
array(), $nodeID
)
:
void
Name | Type | Description |
---|---|---|
$params | ||
$nodeID |


subTreeGroupByDateField(
$field, $type
)
:
void
Name | Type | Description |
---|---|---|
$field | ||
$type |


subTreeMultiPaths(
$nodesParams, $listParams
=
NULL
)
:
void
Name | Type | Description |
---|---|---|
$nodesParams | ||
$listParams |


subtreeRemovalInformation(
$deleteIDArray
)
:
void
Name | Type | Description |
---|---|---|
$deleteIDArray |


swapRow(
$table, $keys, $order_id, $rows, $id1, $id2
)
:
void
Name | Type | Description |
---|---|---|
$table | ||
$keys | ||
$order_id | ||
$rows | ||
$id1 | ||
$id2 |


sync(
$fieldFilters
=
null
)
:
void
Name | Type | Description |
---|---|---|
$fieldFilters |


unhideSubTree(
$node, $modifyRootNode
=
true
)
:
void
Name | Type | Description |
---|---|---|
$node | ||
$modifyRootNode |


unserialize(
$contentNodeDOMNode, $contentObject, $version, $isMain, $nodeList, $options, $handlerType
=
'ezcontentobject'
)
:
void
Name | Type | Description |
---|---|---|
$contentNodeDOMNode | ||
$contentObject | ||
$version | ||
$isMain | ||
$nodeList | ||
$options | ||
$handlerType |


updateMainNodeID(
$mainNodeID, $objectID, $version
=
false, $parentMainNodeID, $updateSection
=
true
)
:
void
Name | Type | Description |
---|---|---|
$mainNodeID | ||
$objectID | ||
$version | ||
$parentMainNodeID | ||
$updateSection |


updateNodeVisibility(
$node, $parentNode, $recursive
=
true
)
:
void
Name | Type | Description |
---|---|---|
$node | ||
$parentNode | ||
$recursive |


updatePathIdentificationString(
$pathIdentificationName
)
:
void
Name | Type | Description |
---|---|---|
$pathIdentificationName |


updateSubTreePath(
$updateParent
=
true, $nodeMove
=
false
)
:
void
Name | Type | Description |
---|---|---|
$updateParent | ||
$nodeMove |