eZPublish(LegacyStack)  5.1
eZContentObjectTrashNode Class Reference

The class eZContentObjectTrashNode. More...

+ Inheritance diagram for eZContentObjectTrashNode:
+ Collaboration diagram for eZContentObjectTrashNode:

Public Member Functions

 eZContentObjectTrashNode ($row=array())
 
 originalParent ()
 
 originalParentPathIdentificationString ()
 
 storeToTrash ()
 
- Public Member Functions inherited from eZContentObjectTreeNode
 addChild ($contentobjectID, $asObject=false, $contentObjectVersion=false)
 
 adjustPathElement ($element, $useParentFromNodeObject=false)
 
 availableClassesJsArray ()
 
 canAddLocation ()
 
 canCreate ()
 
 canCreateClassList ($asObject=false, $includeFilter=true, $groupList=false, $fetchID=false)
 
 canEdit ()
 
 canHide ()
 
 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)
 
 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)
 
 url ()
 
 urlAlias ()
 
 viewCount ()
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 Returns the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched. More...
 
 attributes ()
 Returns the attributes for this object, taken from the definition fields and function attributes. More...
 
 eZPersistentObject ($row)
 Initializes the object with the $row. More...
 
 fill ($row)
 Tries to fill in the data in the object by using the object definition which is returned by the function definition() and the database row data $row. More...
 
 hasAttribute ($attr)
 Checks if $attr is part of the definition fields or function attributes. More...
 
 hasDirtyData ()
 Returns true if the data is considered dirty and needs to be stored. More...
 
 remove ($conditions=null, $extraConditions=null)
 Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. More...
 
 setAttribute ($attr, $val)
 Sets the attribute $attr to the value $val. More...
 
 setHasDirtyData ($hasDirtyData)
 Sets whether the object has dirty data or not. More...
 
 store ($fieldFilters=null)
 Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it. More...
 
 sync ($fieldFilters=null)
 Makes sure data is stored if the data is considered dirty. More...
 

Static Public Member Functions

static createFromNode ($node)
 
static definition ()
 
static fetchByContentObjectID ($contentObjectID, $asObject=true, $contentObjectVersion=false)
 
static purgeForObject ($contentObjectID)
 
static trashList ($params=false, $asCount=false)
 
static trashListCount ($params=false)
 
- Static Public Member Functions inherited from eZContentObjectTreeNode
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), $language=false)
 
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 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)
 Fetches a node by ID. More...
 
static fetchAliasesFromNodeList ($nodeList)
 Fetches path_identification_string for a list of nodes. More...
 
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)
 Get Main Node Id ( or Main Node if $asObject = true ) by Content Object Id. More...
 
static findMainNodeArray ($objectIDArray, $asObject=true)
 Fetches the main nodes for an array of object id's. More...
 
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. More...
 
static hideSubTree (eZContentObjectTreeNode $node, $modifyRootNode=true)
 
static makeObjectsArray ($array, $with_contentobject=true, array $propertiesOverride=null)
 
static parentDepthLimitationList ()
 
static removeNode ($nodeID=0)
 
static removeSubtrees ($deleteIDArray, $moveToTrash=true, $infoOnly=false)
 
static setUseCurrentUserDraft ($enable)
 Enables / disables Use current user draft mode for data map. More...
 
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)
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 Calls conditionTextByRow with an empty row and $conditions. More...
 
static conditionTextByRow ($conditions, $row)
 Generates an SQL sentence from the conditions $conditions and row data $row. More...
 
static count ($def, $conds=null, $field=null)
 Fetches the number of rows by using the object definition. More...
 
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array. More...
 
static escapeArray ($array)
 Escapes strings in an array with the help of eZDBInterface::escapeString(). More...
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 Fetches and returns an object based on the given parameters and returns is either as an object or as an array. More...
 
static fetchObjectList ($def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null, $custom_tables=null, $custom_conds=null)
 Creates an SQL query out of the different parameters and returns an array with the result. More...
 
static getShortAttributeName ($db, $def, $attrName)
 Returns the short attribute name (alias) if it's defined, given attribute name otherwise. More...
 
static handleRows ($rows, $class_name, $asObject)
 Creates PHP objects out of the database rows $rows. More...
 
static newObjectOrder ($def, $orderField, $conditions)
 Returns an order value which can be used for new items in table, for instance placement. More...
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 Deletes the object from the table defined in $def with conditions $conditions and extra conditions $extraConditions. More...
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 Moves a row in a database table. More...
 
static replaceFieldsWithShortNames ($db, $fieldDefs, &$fields)
 For the given array $fields treats its keys (for associative array) or values (for non-associative array) as table fields names and replaces them with short names (aliases) found in $fieldDefs. More...
 
static storeObject ($obj, $fieldFilters=null)
 Stores the data in $obj to database. More...
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 Sets row id $id2 to have the placement of row id $id1. More...
 
static updateObjectList ($parameters)
 Updates rows matching the given parameters. More...
 

Protected Attributes

 $originalNodeParent = 0
 
 $pathArray = 0
 
- Protected Attributes inherited from eZContentObjectTreeNode
 $ClassIsContainer = null
 

Additional Inherited Members

- Public Attributes inherited from eZContentObjectTreeNode
 $ClassIdentifier = null
 Contains the cached value of the class identifier. More...
 
 $ClassName = null
 
 $CurrentLanguage = false
 The current language for the node. More...
 
 $Name
 Name of the node. More...
 
const SORT_FIELD_CLASS_IDENTIFIER = 6
 
const SORT_FIELD_CLASS_NAME = 7
 
const SORT_FIELD_CONTENTOBJECT_ID = 12
 
const SORT_FIELD_DEPTH = 5
 
const SORT_FIELD_MODIFIED = 3
 
const SORT_FIELD_MODIFIED_SUBNODE = 10
 
const SORT_FIELD_NAME = 9
 
const SORT_FIELD_NODE_ID = 11
 
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
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 
- Protected Member Functions inherited from eZContentObjectTreeNode
 hasCurrentSubtreeLimitation (array $policy)
 Checks if provided policy array has a limitation on current subtree. More...
 
- Static Protected Attributes inherited from eZContentObjectTreeNode
static $useCurrentUserDraft = false
 

Detailed Description

Member Function Documentation

static eZContentObjectTrashNode::createFromNode (   $node)
static
static eZContentObjectTrashNode::definition ( )
static
eZContentObjectTrashNode::eZContentObjectTrashNode (   $row = array())

Constructor

Referenced by createFromNode(), and trashList().

static eZContentObjectTrashNode::fetchByContentObjectID (   $contentObjectID,
  $asObject = true,
  $contentObjectVersion = false 
)
static
Parameters
$contentObjectID
bool$asObject
bool$contentObjectVersion
Returns
eZContentObjectTrashNode|null
eZContentObjectTrashNode::originalParent ( )
Returns
eZContentObjectTreeNode|null

Referenced by originalParentPathIdentificationString().

eZContentObjectTrashNode::originalParentPathIdentificationString ( )
static eZContentObjectTrashNode::purgeForObject (   $contentObjectID)
static

Referenced by eZContentObject\purge().

eZContentObjectTrashNode::storeToTrash ( )
static eZContentObjectTrashNode::trashList (   $params = false,
  $asCount = false 
)
static
static eZContentObjectTrashNode::trashListCount (   $params = false)
static

Member Data Documentation

eZContentObjectTrashNode::$originalNodeParent = 0
protected

Referenced by originalParent().

eZContentObjectTrashNode::$pathArray = 0
protected

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