eZPublish  4.7
eZContentObject Class Reference

Handles eZ Publish content objects. More...

+ Inheritance diagram for eZContentObject:
+ Collaboration diagram for eZContentObject:

Public Member Functions

 __clone ()
 
 accessList ($function)
 
 addContentObjectRelation ($toObjectID, $fromObjectVersion=false, $attributeID=0, $relationType=eZContentObject::RELATION_COMMON)
 
 addLocation ($parentNodeID, $asObject=false)
 
 allContentObjectAttributes ($contentObjectID, $asObject=true)
 
 allLanguages ()
 
 allowedAssignSectionList ()
 
 allowedAssignStateIDList (eZUser $user=null)
 Gets a list of states a user is allowed to put the content object in. More...
 
 allowedAssignStateList (eZUser $user=null)
 
 appendInputRelationList ($addingIDList, $relationType)
 
 assignDefaultStates ()
 Sets the default states of a content object. More...
 
 assignedNodes ($asObject=true)
 
 assignState (eZContentObjectState $state)
 Sets the state of a content object. More...
 
 authorArray ()
 
 availableLanguages ()
 
 availableLanguagesJsArray ()
 
 cacheInfo ($Params)
 
 canCreate ()
 
 canCreateClassList ($asObject=false, $includeFilter=true, $groupList=false, $fetchID=false)
 
 canCreateLanguages ()
 
 canDiff ()
 
 canEdit ($originalClassID=false, $parentClassID=false, $returnAccessList=false, $language=false)
 
 canEditLanguages ()
 
 canMove ()
 
 canMoveFrom ()
 
 canPdf ()
 
 canRead ()
 
 canRemove ()
 
 canTranslate ()
 
 canViewEmbed ()
 
 checkAccess ($functionName, $originalClassID=false, $parentClassID=false, $returnAccessList=false, $language=false)
 
 checkGroupLimitationAccess ($limitationValueList, $userID, $contentObjectID=false)
 
 classListFromPolicy ($policy, $allowedLanguageCodes=false)
 
 className ()
 
 cleanupInternalDrafts ($userID=false, $timeDuration=86400)
 
 commitInputRelations ($editVersion)
 
 contentActionList ()
 
 contentClass ()
 
 contentClassGroupIDList ()
 
 contentClassIdentifier ()
 
 contentObjectAttributes ($asObject=true, $version=false, $language=false, $contentObjectAttributeID=false, $distinctItemsOnly=false)
 
 contentObjectListRelatingThis ($version=false)
 
 copy ($allVersions=true)
 
 copyContentObjectRelations ($currentVersion, $newVersion, $newObjectID=false)
 
 copyRevertTo ($version, $language=false)
 
 copyVersion (&$newObject, &$version, $newVersionNumber, $contentObjectID=false, $status=eZContentObjectVersion::STATUS_DRAFT, $languageCode=false, $copyFromLanguageCode=false)
 
 createInitialVersion ($userID, $initialLanguageCode=false)
 
 createNewVersion ($copyFromVersion=false, $versionCheck=true, $languageCode=false, $copyFromLanguageCode=false, $status=eZContentObjectVersion::STATUS_DRAFT)
 
 createNewVersionIn ($languageCode, $copyFromLanguageCode=false, $copyFromVersion=false, $versionCheck=true, $status=eZContentObjectVersion::STATUS_DRAFT)
 
 createNodeAssignment ($parentNodeID, $isMain, $remoteID=false, $sortField=eZContentObjectTreeNode::SORT_FIELD_PUBLISHED, $sortOrder=eZContentObjectTreeNode::SORT_ORDER_DESC)
 
 currentLanguage ()
 
 currentLanguageObject ()
 
 currentVersion ($asObject=true)
 
 dataMap ()
 
 embeddedContentObjectCount ($fromObjectVersion=false)
 
 embeddedContentObjectList ($fromObjectVersion=false, $fromObjectID=false)
 
 eZContentObject ($row)
 
 fetchAttributesByIdentifier ($identifierArray, $version=false, $languageArray=false, $asObject=true)
 
 fetchClassAttributes ($version=0, $asObject=true)
 
 fetchDataMap ($version=false, $language=false)
 
 fetchInput ($contentObjectAttributes, $attributeDataBaseName, $customActionAttributeArray, $customActionParameters)
 
 fixupInput ($contentObjectAttributes, $attributeDataBaseName)
 
 getVersionCount ()
 
 groupedDataMap ()
 Generates a map with all the content object attributes where the keys are the attribute identifiers grouped by class attribute category. More...
 
 handleAllCustomHTTPActions ($attributeDataBaseName, $customActionAttributeArray, $customActionParameters, $objectVersion=false)
 
 handleCustomHTTPActions ($contentObjectAttribute, $attributeDataBaseName, $customActionAttributeArray, $customActionParameters)
 
 hasContentAction ($name)
 
 hasRemainingVersions ()
 
 initialLanguage ()
 
 initialLanguageCode ()
 
 isAlwaysAvailable ()
 
 languages ()
 
 linkedContentObjectCount ($fromObjectVersion=false)
 
 linkedContentObjectList ($fromObjectVersion=false, $fromObjectID=false)
 
 mainNode ()
 
 mainNodeID ()
 
 mainParentNodeID ()
 
 matchIngroupIDList ()
 
 name ($version=false, $lang=false)
 
 names ()
 
 nextVersion ()
 
 owner ()
 
 parentNodeIDArray ()
 
 parentNodes ($version=false, $asObject=true)
 
 permissions ()
 
 postUnserialize ($package)
 
 previousVersion ()
 
 publishContentObjectRelations ($version)
 
 purge ()
 
 relatedContentObjectArray ($fromObjectVersion=false, $fromObjectID=false, $attributeID=0, $params=false)
 
 relatedContentObjectCount ($fromObjectVersion=false, $attributeID=0, $params=false)
 
 relatedContentObjectList ($fromObjectVersion=false, $fromObjectID=false, $attributeID=0, $groupByAttribute=false, $params=false)
 
 relatedObjectCount ($version=false, $attributeID=0, $reverseRelatedObjects=false, $params=false)
 Fetch the number of (reverse) related objects. More...
 
 relatedObjects ($fromObjectVersion=false, $objectID=false, $attributeID=0, $groupByAttribute=false, $params=false, $reverseRelatedObjects=false)
 
 remoteID ()
 
 removeContentObjectRelation ($toObjectID=false, $fromObjectVersion=false, $attributeID=0, $relationType=eZContentObject::RELATION_COMMON)
 
 removeReverseRelations ($objectID)
 
 removeThis ($nodeID=null)
 
 removeTranslation ($languageID)
 
 rename ($newName)
 
 resetDataMap ()
 
 resetInputRelationList ()
 
 restoreObjectAttributes ()
 Restores attributes for current content object when it's being restored from trash. More...
 
 reverseEmbeddedObjectCount ($fromObjectVersion=false)
 
 reverseEmbeddedObjectList ($fromObjectVersion=false, $fromObjectID=false)
 
 reverseLinkedObjectCount ($fromObjectVersion=false)
 
 reverseLinkedObjectList ($fromObjectVersion=false, $fromObjectID=false)
 
 reverseRelatedObjectCount ($version=false, $attributeID=0, $params=false)
 
 reverseRelatedObjectList ($version=false, $attributeID=0, $groupByAttribute=false, $params=false)
 
 revertTo ($version)
 
 serialize ($package, $specificVersion=false, $options=false, $contentNodeIDArray=false, $topNodeIDArray=false)
 
 setAlwaysAvailableLanguageID ($languageID, $version=false)
 
 setCachedName ($name)
 
 setClassName ($name)
 
 setContentObjectAttributes (&$attributes, $version, $language)
 
 setCurrentLanguage ($lang)
 
 setName ($objectName, $versionNum=false, $languageCode=false)
 
 setPermissions ($permissionArray)
 
 stateIDArray ($refreshCache=false)
 Gets the current states of the content object. More...
 
 stateIdentifierArray ()
 
 store ($fieldFilters=null)
 
 storeInput ($contentObjectAttributes, $attributeInputMap)
 
 storeNodeModified ()
 
 validateInput ($contentObjectAttributes, $attributeDataBaseName, $inputParameters=false, $parameters=array())
 
 version ($version, $asObject=true)
 
 versionLanguageName ($version, $lang=false)
 
 versions ($asObject=true, $parameters=array())
 Returns an array of eZContentObjectVersion for the current object according to the conditions in $parameters. More...
 
- 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 cleanupAllInternalDrafts ($userID=false, $timeDuration=86400)
 
static clearCache ($idArray=array())
 
static create ($name, $contentclassID, $userID, $sectionID=1, $version=1, $languageCode=false)
 
static createFetchSQLString ($id)
 
static createFilterByVisibilitySQLString ($IgnoreVisibility=false, $ezcontentobjectTable= 'ezcontentobject')
 Creates the SQL for filtering objects by visibility, used by IgnoreVisibility on some fetches. More...
 
static createGroupedDataMap ($contentObjectAttributes)
 Generates a map with all the content object attributes where the keys are the attribute identifiers grouped by class attribute category. More...
 
static createWithNodeAssignment ($parentNode, $contentClassID, $languageCode, $remoteID=false)
 
static defaultLanguage ()
 
static definition ()
 
static exists ($id)
 
static expireAllCache ()
 
static expireAllViewCache ()
 
static expireComplexViewModeCache ()
 
static expireTemplateBlockCache ()
 
static expireTemplateBlockCacheIfNeeded ()
 
static fetch ($id, $asObject=true)
 Fetches a content object by ID. More...
 
static fetchByNodeID ($nodeID, $asObject=true)
 Fetches the contentobject which has a node with ID $nodeID $nodeID can also be an array of NodeIDs. More...
 
static fetchByRemoteID ($remoteID, $asObject=true)
 
static fetchFilteredList ($conditions=null, $offset=false, $limit=false, $asObject=true)
 
static fetchIDArray ($idArray, $asObject=true)
 Fetches a content object list based on an array of content object ids. More...
 
static fetchList ($asObject=true, $conditions=null, $offset=false, $limit=false)
 
static fetchListCount ($conditions=null)
 
static fetchObjectCountByUserID ($classID, $userID, $status=false)
 
static fetchSameClassList ($contentClassID, $asObject=true, $offset=false, $limit=false)
 
static fetchSameClassListCount ($contentClassID)
 
static fillNodeListAttributes ($objList, $asObject=true)
 
static fixReverseRelations ($objectID, $mode=false)
 
static isCacheExpired ($timestamp)
 
static isComplexViewMode ($viewMode)
 
static isComplexViewModeCacheExpired ($viewMode, $timestamp)
 
static isObjectRelationTyped ()
 
static recursionProtect ($id)
 
static recursionProtectionEnd ()
 
static recursionProtectionStart ()
 
static relationTypeMask ($allRelations=false)
 
static removeVersions ($versionStatus=false)
 
static setDefaultLanguage ($lang)
 
static translationList ()
 
static translationStringList ()
 
static unserialize ($package, $domNode, &$options, $ownerID=false, $handlerType= 'ezcontentobject')
 
- 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...
 

Public Attributes

 $ClassIdentifier
 Cached class identifier. More...
 
 $ClassName
 Stores the current class name. More...
 
 $ContentActionList = false
 Contains an array of the content object actions for the current object. More...
 
 $ContentObjectAttributes = array()
 Contains a cached version of the content object attributes for the given version and language. More...
 
 $CurrentLanguage
 Stores the current language. More...
 
 $DataMap = array()
 Contains the datamap for content object attributes. More...
 
 $ID
 
 $InputRelationList = array()
 Contains the arrays of relatedobject id by fetching input for this object. More...
 
 $MainNodeID = false
 Contains the main node id for this object. More...
 
 $Name
 
const PACKAGE_DELETE = 4
 
const PACKAGE_ERROR_EXISTS = 2
 
const PACKAGE_ERROR_HAS_CHILDREN = 102
 
const PACKAGE_ERROR_MODIFIED = 101
 
const PACKAGE_ERROR_NO_CLASS = 1
 
const PACKAGE_ERROR_NODE_EXISTS = 3
 
const PACKAGE_KEEP = 5
 
const PACKAGE_NEW = 3
 
const PACKAGE_REPLACE = 1
 
const PACKAGE_SKIP = 2
 
const PACKAGE_UPDATE = 6
 
const RELATION_ATTRIBUTE = 8
 
const RELATION_COMMON = 1
 
const RELATION_EMBED = 2
 
const RELATION_LINK = 4
 
const STATUS_ARCHIVED = 2
 
const STATUS_DRAFT = 0
 
const STATUS_PUBLISHED = 1
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 

Static Private Member Functions

static mapLanguage ($language, $options)
 

Private Attributes

 $StateIDArray = false
 

Detailed Description

Handles eZ Publish content objects.

It encapsulates the data for an object and provides lots of functions for dealing with versions, translations and attributes.

See Also
eZContentClass

Member Function Documentation

eZContentObject::__clone ( )
eZContentObject::accessList (   $function)

Get accesslist for specified function

Parameters
function
Returns
AccessList
eZContentObject::addContentObjectRelation (   $toObjectID,
  $fromObjectVersion = false,
  $attributeID = 0,
  $relationType = eZContentObject::RELATION_COMMON 
)

Adds a link to the given content object id.

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.

Referenced by commitInputRelations().

eZContentObject::addLocation (   $parentNodeID,
  $asObject = false 
)

Adds a new location (node) to the current object.

Parameters
$parenNodeIDThe id of the node to use as parent.
$asObjectIf true it will return the new child-node as an object, if not it returns the ID.
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.
eZContentObject::allContentObjectAttributes (   $contentObjectID,
  $asObject = true 
)
eZContentObject::allLanguages ( )
eZContentObject::allowedAssignSectionList ( )
eZContentObject::allowedAssignStateIDList ( eZUser  $user = null)

Gets a list of states a user is allowed to put the content object in.

Returns
array the IDs of all states we are allowed to set
Parameters
eZUser$userthe user to check the policies of, when omitted the currently logged in user will be used

Referenced by allowedAssignStateList().

eZContentObject::allowedAssignStateList ( eZUser  $user = null)
eZContentObject::appendInputRelationList (   $addingIDList,
  $relationType 
)
eZContentObject::assignDefaultStates ( )

Sets the default states of a content object.

This function is called upon instantiating a content object with eZContentClass::instantiate(), so should normally not be called by any other code.

eZContentObject::assignedNodes (   $asObject = true)

Returns the node assignments for the current object.

Referenced by copy(), createNewVersion(), removeTranslation(), and storeNodeModified().

eZContentObject::assignState ( eZContentObjectState  $state)

Sets the state of a content object.

Changes are stored immediately in the database, does not require a store() of the content object. Should only be called on instances of eZContentObject that have a ID (that were stored already before).

Parameters
eZContentObjectState$state
Returns
boolean true when the state was set, false if the state equals the current state
eZContentObject::authorArray ( )

Returns a list of all the authors for this object. The returned value is an array of eZ user objects.

eZContentObject::availableLanguages ( )
Returns
the languages the object has been translated into/exists in.

Returns an array with the language codes.

It uses the attribute avail_lang as the source for the language list.

Referenced by canCreateLanguages(), canEditLanguages(), copyVersion(), and ezpContentFieldSet\fromContentObject().

eZContentObject::availableLanguagesJsArray ( )
eZContentObject::cacheInfo (   $Params)
Returns
a structure with information required for caching.
eZContentObject::canCreate ( )
eZContentObject::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
$asObjectIf true then it return eZContentClass objects, if not it will be an associative array with name and id keys.
$includeFilterIf true then it will include only from class groups defined in $groupList, if not it will exclude those groups.
$groupListAn array with class group IDs that should be used in filtering, use false if you do not wish to filter at all.
$fetchIDA unique name for the current fetch, this must be supplied when filtering is used if you want caching to work.
eZContentObject::canCreateLanguages ( )
eZContentObject::canDiff ( )
Returns
true if the current user can diff this content object.
eZContentObject::canEdit (   $originalClassID = false,
  $parentClassID = false,
  $returnAccessList = false,
  $language = false 
)

Referenced by canEditLanguages().

eZContentObject::canEditLanguages ( )
eZContentObject::canMove ( )

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

Returns
true if the object can be moved by the current user.
See Also
checkAccess().
Deprecated:
The function canMove() is preferred since its naming is clearer.
eZContentObject::canMoveFrom ( )

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

Returns
true if the object can be moved by the current user.
See Also
checkAccess().

Referenced by canMove().

eZContentObject::canPdf ( )
Returns
true if the current user can create a pdf of this content object.
eZContentObject::canRead ( )
Returns
true if the current user can read this content object.
eZContentObject::canRemove ( )
eZContentObject::canTranslate ( )
eZContentObject::canViewEmbed ( )
Returns
true if the node can be viewed as embeded object by the current user.
See Also
checkAccess().
eZContentObject::checkAccess (   $functionName,
  $originalClassID = false,
  $parentClassID = false,
  $returnAccessList = false,
  $language = false 
)

Check access for the current object

Parameters
functionname ( edit, read, remove, etc. )
originalclass ID ( used to check access for object creation ), default false
parentclass id ( used to check access for object creation ), default false
returnaccess list instead of access result (optional, default false )
Returns
1 if has access, 0 if not. If returnAccessList is set to true, access list is returned

Referenced by accessList(), canCreate(), canCreateLanguages(), canDiff(), canEdit(), canMoveFrom(), canPdf(), canRead(), canRemove(), canTranslate(), canViewEmbed(), and removeTranslation().

eZContentObject::checkGroupLimitationAccess (   $limitationValueList,
  $userID,
  $contentObjectID = false 
)
eZContentObject::classListFromPolicy (   $policy,
  $allowedLanguageCodes = false 
)

Referenced by canCreateClassList().

eZContentObject::className ( )
Returns
The name of the class which this object was created from.
Note
The object will cache the class name information so multiple calls will be fast.
static eZContentObject::cleanupAllInternalDrafts (   $userID = false,
  $timeDuration = 86400 
)
static

Removes all old internal drafts by the specified user. Only internal drafts older than 1 day will be considered.

Parameters
$userIDThe ID of the user to cleanup for, if false it will use the current user.
eZContentObject::cleanupInternalDrafts (   $userID = false,
  $timeDuration = 86400 
)

Removes old internal drafts by the specified user associated with this content object. Only internal drafts older than 1 day will be considered.

Parameters
$userIDThe ID of the user to cleanup for, if false it will use the current user.
static eZContentObject::clearCache (   $idArray = array())
static
eZContentObject::commitInputRelations (   $editVersion)

Referenced by validateInput().

eZContentObject::contentActionList ( )

Returns an array of the content actions which can be performed on the current object.

eZContentObject::contentClass ( )
Returns
the content class for the current content object

Referenced by contentClassGroupIDList(), copyVersion(), matchIngroupIDList(), and rename().

eZContentObject::contentClassGroupIDList ( )
Returns
the content class group identifiers for the current content object
eZContentObject::contentClassIdentifier ( )
Returns
the content class identifer for the current content object
Note
The object will cache the class name information so multiple calls will be fast.
eZContentObject::contentObjectAttributes (   $asObject = true,
  $version = false,
  $language = false,
  $contentObjectAttributeID = false,
  $distinctItemsOnly = false 
)

Fetches the attributes for the current published version of the object. TODO: fix using of $asObject parameter, fix condition for getting attribute from cache, probably need to move method to eZContentObjectVersion class

Referenced by contentActionList(), fetchDataMap(), and handleAllCustomHTTPActions().

eZContentObject::contentObjectListRelatingThis (   $version = false)

Returns the related objects.

Note
This function is a duplicate of reverseRelatedObjectList(), use that function instead.
eZContentObject::copy (   $allVersions = true)

Makes a copy of the object which is stored and then returns it.

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.
eZContentObject::copyContentObjectRelations (   $currentVersion,
  $newVersion,
  $newObjectID = false 
)

Referenced by copyVersion().

eZContentObject::copyRevertTo (   $version,
  $language = false 
)

Copies the given version of the object and creates a new current version.

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.
eZContentObject::copyVersion ( $newObject,
$version,
  $newVersionNumber,
  $contentObjectID = false,
  $status = eZContentObjectVersion::STATUS_DRAFT,
  $languageCode = false,
  $copyFromLanguageCode = false 
)

Creates a new version and returns it as an eZContentObjectVersion object. If version number is given as argument that version is used to create a copy.

Parameters
$languageCodeIf false all languages will be copied, otherwise only specified by the locale code string or an array of the locale code strings.
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.

Referenced by copy(), and createNewVersion().

static eZContentObject::create (   $name,
  $contentclassID,
  $userID,
  $sectionID = 1,
  $version = 1,
  $languageCode = false 
)
static

Creates a new content object instance and stores it.

Referenced by eZContentClass\instantiate().

static eZContentObject::createFetchSQLString (   $id)
static

Creates the SQL for fetching the object with ID $id and returns the string.

Referenced by exists(), and fetch().

static eZContentObject::createFilterByVisibilitySQLString (   $IgnoreVisibility = false,
  $ezcontentobjectTable = 'ezcontentobject' 
)
static

Creates the SQL for filtering objects by visibility, used by IgnoreVisibility on some fetches.

The object is visible if 1 or more assigned nodes are visible.

Since
Version 4.1
Parameters
bool$IgnoreVisibilityignores visibility if true
string$ezcontentobjectTablename of ezcontentobject table used in sql
Returns
string with sql condition for node filtering by visibility
static eZContentObject::createGroupedDataMap (   $contentObjectAttributes)
static

Generates a map with all the content object attributes where the keys are the attribute identifiers grouped by class attribute category.

Note
Result is not cached, so make sure you don't call this over and over.
Parameters
array$contentObjectAttributesArray of eZContentObjectAttribute objects
Returns
array
eZContentObject::createInitialVersion (   $userID,
  $initialLanguageCode = false 
)
eZContentObject::createNewVersion (   $copyFromVersion = false,
  $versionCheck = true,
  $languageCode = false,
  $copyFromLanguageCode = false,
  $status = eZContentObjectVersion::STATUS_DRAFT 
)

Creates a new version and returns it as an eZContentObjectVersion object. If version number is given as argument that version is used to create a copy.

Parameters
$versionCheckIf true it will check if there are too many version and remove some of them to make room for a new.
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.

Referenced by createNewVersionIn(), rename(), and eZContentFunctions\updateAndPublishObject().

eZContentObject::createNewVersionIn (   $languageCode,
  $copyFromLanguageCode = false,
  $copyFromVersion = false,
  $versionCheck = true,
  $status = eZContentObjectVersion::STATUS_DRAFT 
)

Referenced by copyRevertTo().

eZContentObject::createNodeAssignment (   $parentNodeID,
  $isMain,
  $remoteID = false,
  $sortField = eZContentObjectTreeNode::SORT_FIELD_PUBLISHED,
  $sortOrder = eZContentObjectTreeNode::SORT_ORDER_DESC 
)

Creates a new node assignment that will place the object as child of node $nodeID.

Returns
The eZNodeAssignment object it created
Parameters
$parentNodeIDThe node ID of the parent node
$isMaintrue if the created node is the main node of the object
$remoteIDA string denoting the unique remote ID of the assignment or false for no remote id.
$sortField
$sortOrder
Note
The returned assignment will already be stored in the database
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.
static eZContentObject::createWithNodeAssignment (   $parentNode,
  $contentClassID,
  $languageCode,
  $remoteID = false 
)
static
eZContentObject::currentLanguage ( )
eZContentObject::currentLanguageObject ( )
eZContentObject::currentVersion (   $asObject = true)

Returns the current version of this document.

Referenced by copy(), createNewVersion(), removeTranslation(), serialize(), and setAlwaysAvailableLanguageID().

eZContentObject::dataMap ( )
Returns
a map with all the content object attributes where the keys are the attribute identifiers.
eZContentObject::embeddedContentObjectCount (   $fromObjectVersion = false)

Returns the xml-embedded objects count.

eZContentObject::embeddedContentObjectList (   $fromObjectVersion = false,
  $fromObjectID = false 
)

Returns the xml-embedded objects.

static eZContentObject::exists (   $id)
static

Tests for the existance of a content object by using the ID $id.

Returns
true if the object exists, false otherwise.
Note
Uses the static function createFetchSQLString() to generate the SQL
static eZContentObject::expireAllCache ( )
static

Sets all content cache files to be expired. Both view cache and cache blocks are expired.

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.

Referenced by eZContentCacheManager\clearAllContentCache().

static eZContentObject::expireAllViewCache ( )
static
static eZContentObject::expireComplexViewModeCache ( )
static

Sets all complex viewmode content cache files to be expired.

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.

Referenced by eZContentCacheManager\clearObjectViewCache().

static eZContentObject::expireTemplateBlockCache ( )
static

Expires all template block cache. This should be expired anytime any content is published/modified or removed.

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.

Referenced by eZContentCacheManager\clearTemplateBlockCache(), and expireTemplateBlockCacheIfNeeded().

static eZContentObject::expireTemplateBlockCacheIfNeeded ( )
static

Callse eZContentObject::xpireTemplateBlockCache() unless template caching is disabled.

eZContentObject::eZContentObject (   $row)
static eZContentObject::fetch (   $id,
  $asObject = true 
)
static

Fetches a content object by ID.

Parameters
int$idID of the content object to fetch
bool$asObjectReturn the result as an object (true) or an assoc. array (false)
Returns
eZContentObject

Referenced by eZContentOperationCollection\addAssignment(), eZContentObjectTreeNode\addChildTo(), eZShopOperationCollection\addToBasket(), eZObjectRelationListType\appendObject(), eZRole\assignToUser(), eZContentOperationCollection\attributePublishAction(), eZContentOperationCollection\changeTranslationAvailableStatus(), checkGroupLimitationAccess(), eZContentCacheManager\clearTemplateBlockCache(), eZWorkflowProcess\content(), eZInformationCollectionAttribute\contentObject(), eZProductCollectionItem\contentObject(), eZContentObjectVersion\contentObject(), eZUser\contentObject(), copyPublishContentObject(), eZContentOperationCollection\copyTranslations(), eZContentObjectVersion\creator(), eZContentObjectTreeNode\creator(), eZObjectRelationListType\customObjectAttributeHTTPAction(), updateNodeAssignment\execute(), eZFinishUserRegisterType\execute(), eZWaitUntilDateType\execute(), eZApproveType\execute(), eZMultiplexerType\execute(), eZShopFunctionCollection\fetchBestSellList(), fetchByRemoteID(), eZContentFunctionCollection\fetchContentObject(), eZApproveType\fetchHTTPInput(), eZContentFunctionCollection\fetchObject(), eZURLObjectLink\fetchObjectVersionList(), eZContentFunctionCollection\fetchRelatedObjects(), eZContentFunctionCollection\fetchRelatedObjectsCount(), eZShopFunctionCollection\fetchRelatedPurchaseList(), eZContentFunctionCollection\fetchReverseRelatedObjects(), eZContentFunctionCollection\fetchReverseRelatedObjectsCount(), eZRole\fetchRolesByLimitation(), eZRole\fetchUserByRole(), ezpContent\fromObjectId(), eZObjectRelationType\fromString(), eZObjectRelationListType\fromString(), eZRSSExport\generateFeed(), eZContentObjectPackageHandler\generateFetchAliasArray(), eZContentCacheManager\generateObjectViewCache(), eZObjectRelationListType\handleCustomObjectHTTPActions(), importRSSItem(), eZImageAliasHandler\initializeFromFile(), eZObjectRelationListType\initializeObjectAttribute(), eZContentObjectPackageHandler\installSuspendedNodeAssignment(), eZTextFileUser\loginUser(), eZContentOperationCollection\loopNodeAssignment(), eZObjectRelationListType\metaData(), eZOrderStatusHistory\modifier(), eZContentCacheManager\nodeList(), eZContentCacheManager\nodeListForObject(), eZContentObjectAttribute\object(), eZInformationCollection\object(), eZContentObjectTreeNode\object(), eZObjectRelationType\objectAttributeContent(), eZObjectRelationListType\onPublish(), owner(), eZCollaborationItemParticipantLink\participant(), eZOrder\productList(), eZContentOperationCollection\publishNode(), eZContentUpload\publishObject(), eZLDAPUser\publishUpdateUser(), eZUserOperationCollection\publishUserContentObject(), eZContentOperationCollection\registerSearchObject(), eZContentObjectOperations\remove(), eZContentOperationCollection\removeAssignment(), eZObjectRelationType\removeContentObjectRelation(), eZContentOperationCollection\removeNodes(), eZContentOperationCollection\removeOldNodes(), eZContentOperationCollection\removeTemporaryDrafts(), eZContentOperationCollection\removeTranslation(), eZSiteInstaller\renameContentObject(), eZContentOperationCollection\resetNodeassignmentOpcodes(), eZUserOperationCollection\sendActivationEmail(), eZObjectRelationType\serializeContentObjectAttribute(), eZObjectRelationListType\serializeContentObjectAttribute(), eZContentOperationCollection\setObjectStatusPublished(), eZContentOperationCollection\setVersionStatus(), eZObjectRelationType\storeObjectAttribute(), eZObjectRelationListType\storeObjectAttribute(), eZObjectRelationListType\title(), eZXMLTextType\transformLinksToRemoteLinks(), unserialize(), eZContentOperationCollection\updateAlwaysAvailable(), eZSiteInstaller\updateContentObjectAttributes(), eZContentOperationCollection\updateInitialLanguage(), eZContentObjectTreeNode\updateMainNodeID(), eZContentOperationCollection\updateNontranslatableAttributes(), eZSiteInstaller\updateObjectAttributeFromString(), eZContentOperationCollection\updateObjectState(), eZContentOperationCollection\updateSectionID(), eZApproveType\validateGroupIDList(), eZObjectRelationListType\validateObjectAttributeHTTPInput(), and eZApproveType\validateUserIDList().

eZContentObject::fetchAttributesByIdentifier (   $identifierArray,
  $version = false,
  $languageArray = false,
  $asObject = true 
)

Fetch a set of content object attributes by their class identifiers.

static eZContentObject::fetchByNodeID (   $nodeID,
  $asObject = true 
)
static

Fetches the contentobject which has a node with ID $nodeID $nodeID can also be an array of NodeIDs.

In this case, an array of content objects will be returned

Parameters
int | array$nodeIDSingle nodeID or array of NodeIDs
bool$asObjectIf results have to be returned as eZContentObject instances or not
Returns
mixed Content object or array of content objects. Content objects can be eZContentObject instances or array result sets

Referenced by eZNodeAssignment\getParentObject(), eZContentCacheManager\nodeListForObject(), and eZContentObjectTreeNode\updateMainNodeID().

eZContentObject::fetchClassAttributes (   $version = 0,
  $asObject = true 
)

Returns the attributes for the content object version $version and content object $contentObjectID. $language defines the language to fetch.

See Also
attributes

Referenced by serialize().

eZContentObject::fetchDataMap (   $version = false,
  $language = false 
)
Returns
a map with all the content object attributes where the keys are the attribute identifiers.
See Also
eZContentObjectTreeNode::dataMap

Referenced by dataMap(), fetchInput(), ezpContentFieldSet\fromContentObject(), and groupedDataMap().

static eZContentObject::fetchFilteredList (   $conditions = null,
  $offset = false,
  $limit = false,
  $asObject = true 
)
static

Referenced by fetchSameClassList().

static eZContentObject::fetchIDArray (   $idArray,
  $asObject = true 
)
static

Fetches a content object list based on an array of content object ids.

Parameters
array$idArrayarray of content object ids
bool$asObjectWether to get the result as an array of eZContentObject or an array of associative arrays
Returns
array(contentObjectID => eZContentObject|array) array of eZContentObject (if $asObject = true) or array of associative arrays (if $asObject = false)

Referenced by eZXMLOutputHandler\prefetch().

eZContentObject::fetchInput (   $contentObjectAttributes,
  $attributeDataBaseName,
  $customActionAttributeArray,
  $customActionParameters 
)
static eZContentObject::fetchList (   $asObject = true,
  $conditions = null,
  $offset = false,
  $limit = false 
)
static
Returns
An array with content objects.
Parameters
$asObjectWhether to return objects or not
$conditionsOptional conditions to limit the fetch, set to null to skip it.
$offsetWhere to start fetch from, set to false to skip it.
$limitMaximum number of objects to fetch, set false to skip it.
See Also
fetchListCount

Referenced by eZContentCacheManager\clearContentCacheIfNeededBySectionID(), eZSiteInstaller\contentObjectByName(), and eZOrder\orderStatistics().

static eZContentObject::fetchListCount (   $conditions = null)
static
Returns
The number of objects in the database. Optionally $conditions can be used to limit the list count.
See Also
fetchList
static eZContentObject::fetchObjectCountByUserID (   $classID,
  $userID,
  $status = false 
)
static
Returns
the number of objects of the given class is created by the given user.

Referenced by eZContentFunctionCollection\fetchObjectCountByUserID().

static eZContentObject::fetchSameClassList (   $contentClassID,
  $asObject = true,
  $offset = false,
  $limit = false 
)
static
static eZContentObject::fetchSameClassListCount (   $contentClassID)
static
static eZContentObject::fillNodeListAttributes (   $objList,
  $asObject = true 
)
static

Fetches the attributes for an array of objects. The objList parameter contains an array of objects ( instanceOf eZContentObject or a object that is or extends eZContentObjectTreeNode ) to fetch attributes from.

Referenced by eZTreeMenuOperator\modify(), relatedObjects(), and eZContentObjectTreeNode\subTreeByNodeID().

static eZContentObject::fixReverseRelations (   $objectID,
  $mode = false 
)
static
eZContentObject::fixupInput (   $contentObjectAttributes,
  $attributeDataBaseName 
)
eZContentObject::getVersionCount ( )

Returns number of exist versions.

Referenced by createNewVersion().

eZContentObject::groupedDataMap ( )

Generates a map with all the content object attributes where the keys are the attribute identifiers grouped by class attribute category.

Note
Result is not cached, so make sure you don't call this over and over.
Returns
array
eZContentObject::handleAllCustomHTTPActions (   $attributeDataBaseName,
  $customActionAttributeArray,
  $customActionParameters,
  $objectVersion = false 
)
eZContentObject::handleCustomHTTPActions (   $contentObjectAttribute,
  $attributeDataBaseName,
  $customActionAttributeArray,
  $customActionParameters 
)

Referenced by fetchInput().

eZContentObject::hasContentAction (   $name)
Returns
true if the content action is in the content action list

Referenced by contentActionList().

eZContentObject::hasRemainingVersions ( )
Returns
true if the object has any versions remaining.
eZContentObject::initialLanguage ( )
eZContentObject::initialLanguageCode ( )
eZContentObject::isAlwaysAvailable ( )

Referenced by copyVersion().

static eZContentObject::isCacheExpired (   $timestamp)
static
Returns
if the content cache timestamp $timestamp is expired.

Referenced by eZNodeviewfunctions\contentViewRetrieve(), eZContentCache\exists(), and eZContentCache\restore().

static eZContentObject::isComplexViewMode (   $viewMode)
static
Returns
true if the viewmode is a complex viewmode.

Referenced by isComplexViewModeCacheExpired().

static eZContentObject::isComplexViewModeCacheExpired (   $viewMode,
  $timestamp 
)
static
Returns
true if the viewmode is a complex viewmode and the viewmode timestamp is expired.

Referenced by eZContentCache\exists(), and eZContentCache\restore().

eZContentObject::languages ( )

Referenced by availableLanguages().

eZContentObject::linkedContentObjectCount (   $fromObjectVersion = false)

Returns the xml-linked objects count.

eZContentObject::linkedContentObjectList (   $fromObjectVersion = false,
  $fromObjectID = false 
)

Returns the xml-linked objects.

eZContentObject::mainNode ( )
eZContentObject::mainNodeID ( )

Returns the main node id for the current object.

eZContentObject::mainParentNodeID ( )
static eZContentObject::mapLanguage (   $language,
  $options 
)
staticprivate

Maps input lange to another one if defined in $options['language_map']. If it cannot map it returns the original language.

Returns
string

Referenced by unserialize().

eZContentObject::matchIngroupIDList ( )

Get class groups this object's class belongs to if match for class groups is enabled.

Returns
array of class group ids. False if match is disabled.
eZContentObject::name (   $version = false,
  $lang = false 
)
eZContentObject::names ( )
eZContentObject::nextVersion ( )

Returns the next available version number for this object.

Referenced by createNewVersion().

eZContentObject::owner ( )

Returns the owner of the object as a content object.

eZContentObject::parentNodeIDArray ( )

Get parent node IDs

eZContentObject::parentNodes (   $version = false,
  $asObject = true 
)
Parameters
$versionNo longer in use, published nodes are used instead.
$asObjectIf true it fetches PHP objects, otherwise it fetches IDs.
Returns
the parnet nodes for the current object.

Referenced by parentNodeIDArray().

eZContentObject::permissions ( )

Returns the permission for the current object.

eZContentObject::postUnserialize (   $package)

Performs additional unserialization actions that need to be performed when all objects contained in the package are already installed. (maintain objects' cross-relations)

eZContentObject::previousVersion ( )

Returns the previous available version number for this object, if existing, false otherwise ( if the object has only one version )

eZContentObject::publishContentObjectRelations (   $version)
eZContentObject::purge ( )

If nodeID is not given, this function will remove object from database. All versions and translations of this object will be lost. Otherwise, it will check node assignment and only delete the object from this node if it was assigned to other nodes as well.

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.
static eZContentObject::recursionProtect (   $id)
static
static eZContentObject::recursionProtectionEnd ( )
static
static eZContentObject::recursionProtectionStart ( )
static
eZContentObject::relatedContentObjectArray (   $fromObjectVersion = false,
  $fromObjectID = false,
  $attributeID = 0,
  $params = false 
)
eZContentObject::relatedContentObjectCount (   $fromObjectVersion = false,
  $attributeID = 0,
  $params = false 
)
Returns
the number of related objects
Parameters
$attributeID: ( makes sense only when $params['AllRelations'] not set or eZContentObject::RELATION_ATTRIBUTE ) >0 - return relations made with attribute ID ( "related object(s)" datatype ) 0 or false ( $params['AllRelations'] is eZContentObject::RELATION_ATTRIBUTE )
  • return relations made with any attributes false ( $params['AllRelations'] not set )
  • return ALL relations (deprecated, use "$params['AllRelations'] = true" instead)
$params: other parameters from template fetch function : $params['AllRelations'] - relation type filter : true - return ALL relations, including attribute-level false - return object-level relations >0 - bit mask of EZ_CONTENT_OBJECT_RELATION_* values $params['SortBy'] - related objects sorting mode. Supported modes: class_identifier, class_name, modified, name, published, section $params['IgnoreVisibility'] - ignores 'hidden' state of related objects if true
eZContentObject::relatedContentObjectList (   $fromObjectVersion = false,
  $fromObjectID = false,
  $attributeID = 0,
  $groupByAttribute = false,
  $params = false 
)

Returns the related objects.

Parameters
$attributeID: ( makes sense only when $params['AllRelations'] not set or eZContentObject::RELATION_ATTRIBUTE ) >0 - return relations made with attribute ID ( "related object(s)" datatype ) 0 or false ( $params['AllRelations'] is eZContentObject::RELATION_ATTRIBUTE )
  • return relations made with any attributes false ( $params['AllRelations'] not set )
  • return ALL relations (deprecated, use "$params['AllRelations'] = true" instead)
$groupByAttribute: false - return all relations as an array of content objects true - return all relations groupped by attribute ID This parameter makes sense only when $attributeID == false or $params['AllRelations'] = true
$params: other parameters from template fetch function : $params['AllRelations'] - relation type filter : true - return ALL relations, including attribute-level false - return object-level relations >0 - bit mask of EZ_CONTENT_OBJECT_RELATION_* values $params['SortBy'] - related objects sorting mode. Supported modes: class_identifier, class_name, modified, name, published, section $params['IgnoreVisibility'] - ignores 'hidden' state of related objects if true $params['RelatedClassIdentifiers'] - limit returned relations to objects of the specified class identifiers

Referenced by relatedContentObjectArray().

eZContentObject::relatedObjectCount (   $version = false,
  $attributeID = 0,
  $reverseRelatedObjects = false,
  $params = false 
)

Fetch the number of (reverse) related objects.

Parameters
int$version
int$attributeIDThis parameter only makes sense if $params[AllRelations] is unset, set to false, or matches eZContentObject::RELATION_ATTRIBUTE Possible values:
  • 0 or false: Count relations made with any attribute
  • >0 Count relations made with attribute $attributeID
int | false$reverseRelatedObjectsWether to count related objects (false) or reverse related objects (false)
array | false$paramsVarious params, as an associative array. Possible values:
  • AllRelations (bool|int) true: count ALL relations, object and attribute level false: only count object level relations other: bit mask of eZContentObject::RELATION_* constants
  • IgnoreVisibility (bool) If true, 'hidden' status will be ignored
Returns
int The number of (reverse) related objects for the object

Referenced by embeddedContentObjectCount(), linkedContentObjectCount(), relatedContentObjectCount(), reverseEmbeddedObjectCount(), reverseLinkedObjectCount(), and reverseRelatedObjectCount().

eZContentObject::relatedObjects (   $fromObjectVersion = false,
  $objectID = false,
  $attributeID = 0,
  $groupByAttribute = false,
  $params = false,
  $reverseRelatedObjects = false 
)

Returns the related or reverse related objects:

Parameters
$attributeID: ( makes sense only when $params['AllRelations'] not set or eZContentObject::RELATION_ATTRIBUTE ) >0 - return relations made with attribute ID ( "related object(s)" datatype ) 0 or false ( $params['AllRelations'] is eZContentObject::RELATION_ATTRIBUTE )
  • return relations made with any attributes false ( $params['AllRelations'] not set )
  • return ALL relations (deprecated, use "$params['AllRelations'] = true" instead)
$groupByAttribute: false - return all relations as an array of content objects true - return all relations groupped by attribute ID This parameter makes sense only when $attributeID == false or $params['AllRelations'] = true
$params: other parameters from template fetch function : $params['AllRelations'] - relation type filter : true - return ALL relations, including attribute-level false - return object-level relations >0 - bit mask of EZ_CONTENT_OBJECT_RELATION_* values $params['SortBy'] - related objects sorting mode. Supported modes: class_identifier, class_name, modified, name, published, section $params['IgnoreVisibility'] - ignores 'hidden' state of related objects if true $params['RelatedClassIdentifiers'] - limit returned relations to objects of the specified class identifiers
$reverseRelatedObjects: if "true" returns reverse related contentObjects if "false" returns related contentObjects

Referenced by commitInputRelations(), embeddedContentObjectList(), linkedContentObjectList(), relatedContentObjectList(), reverseEmbeddedObjectList(), reverseLinkedObjectList(), and reverseRelatedObjectList().

static eZContentObject::relationTypeMask (   $allRelations = false)
static
eZContentObject::remoteID ( )

Get remote id of content object

eZContentObject::removeContentObjectRelation (   $toObjectID = false,
  $fromObjectVersion = false,
  $attributeID = 0,
  $relationType = eZContentObject::RELATION_COMMON 
)

Removes a link to the given content object id.

Parameters
$toObjectIDIf false it will delete relations to all the objects.
$attributeIDID of class attribute. IF it is > 0 we remove relations created by a specific objectrelation[list] attribute. If it is set to 0 we remove relations created without using of objectrelation[list] attribute. If it is set to false, we remove all relations, no matter how were they created: using objectrelation[list] attribute or using "Add related objects" functionality in obect editing mode.
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.

Referenced by commitInputRelations().

eZContentObject::removeReverseRelations (   $objectID)
eZContentObject::removeThis (   $nodeID = 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.
eZContentObject::removeTranslation (   $languageID)
static eZContentObject::removeVersions (   $versionStatus = false)
static
Deprecated:
This method is left here only for backward compatibility. Use eZContentObjectVersion::removeVersions() method instead.
eZContentObject::rename (   $newName)

Sets the object's name to $newName: tries to find attributes that are in 'object pattern name' and updates them.

Returns
true if object's name was changed, otherwise false.
eZContentObject::resetDataMap ( )

Referenced by __clone().

eZContentObject::resetInputRelationList ( )
eZContentObject::restoreObjectAttributes ( )

Restores attributes for current content object when it's being restored from trash.

eZContentObject::reverseEmbeddedObjectCount (   $fromObjectVersion = false)

Returns the reverse xml-embedded objects count.

eZContentObject::reverseEmbeddedObjectList (   $fromObjectVersion = false,
  $fromObjectID = false 
)

Returns the reverse xml-embedded objects.

eZContentObject::reverseLinkedObjectCount (   $fromObjectVersion = false)

Returns the reverse xml-linked objects count.

eZContentObject::reverseLinkedObjectList (   $fromObjectVersion = false,
  $fromObjectID = false 
)

Returns the reverse xml-linked objects.

eZContentObject::reverseRelatedObjectCount (   $version = false,
  $attributeID = 0,
  $params = false 
)

Returns the number of objects to which this object is related.

Parameters
$attributeID: ( makes sense only when $params['AllRelations'] not set or eZContentObject::RELATION_ATTRIBUTE ) >0 - return relations made with attribute ID ( "related object(s)" datatype ) 0 or false ( $params['AllRelations'] is eZContentObject::RELATION_ATTRIBUTE )
  • return relations made with any attributes false ( $params['AllRelations'] not set )
  • return ALL relations (deprecated, use "$params['AllRelations'] = true" instead)
$params: other parameters from template fetch function : $params['AllRelations'] - relation type filter : true - return ALL relations, including attribute-level false - return object-level relations >0 - bit mask of EZ_CONTENT_OBJECT_RELATION_* values
eZContentObject::reverseRelatedObjectList (   $version = false,
  $attributeID = 0,
  $groupByAttribute = false,
  $params = false 
)

Returns the objects to which this object are related .

Parameters
$attributeID: ( makes sense only when $params['AllRelations'] not set or eZContentObject::RELATION_ATTRIBUTE ) >0 - return relations made with attribute ID ( "related object(s)" datatype ) 0 or false ( $params['AllRelations'] is eZContentObject::RELATION_ATTRIBUTE )
  • return relations made with any attributes false ( $params['AllRelations'] not set )
  • return ALL relations (deprecated, use "$params['AllRelations'] = true" instead)
$groupByAttribute: false - return all relations as an array of content objects true - return all relations groupped by attribute ID This parameter makes sense only when $attributeID == false or $params['AllRelations'] = true
$params: other parameters from template fetch function : $params['AllRelations'] - relation type filter : true - return ALL relations, including attribute-level false - return object-level relations >0 - bit mask of EZ_CONTENT_OBJECT_RELATION_* values $params['SortBy'] - related objects sorting mode. Supported modes: class_identifier, class_name, modified, name, published, section $params['IgnoreVisibility'] - ignores 'hidden' state of related objects if true

Referenced by contentObjectListRelatingThis(), and removeReverseRelations().

eZContentObject::revertTo (   $version)

Reverts the object to the given version. All versions newer then the given version will be deleted.

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.
eZContentObject::serialize (   $package,
  $specificVersion = false,
  $options = false,
  $contentNodeIDArray = false,
  $topNodeIDArray = false 
)
Returns
a DOM structure of the content object and it's attributes.
Parameters
package
Contentobject version, true for current version, false for all, else array containing specific versions.
packageoptions ( optianal )
arrayof allowed nodes ( optional )
arrayof top nodes in current package export (optional )
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.
eZContentObject::setAlwaysAvailableLanguageID (   $languageID,
  $version = false 
)
eZContentObject::setCachedName (   $name)

Sets the name of the object, in memory only. Use setName() to change it.

eZContentObject::setClassName (   $name)
eZContentObject::setContentObjectAttributes ( $attributes,
  $version,
  $language 
)

Initializes the cached copy of the content object attributes for the given version and language

eZContentObject::setCurrentLanguage (   $lang)
static eZContentObject::setDefaultLanguage (   $lang)
static

Set default language. Checks if default language is valid.

Parameters
defaultlanguage.
Note
Deprecated.
eZContentObject::setName (   $objectName,
  $versionNum = false,
  $languageCode = false 
)

Sets the name of the object in all translations.

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.
eZContentObject::setPermissions (   $permissionArray)

Sets the permissions for this object.

eZContentObject::stateIDArray (   $refreshCache = false)

Gets the current states of the content object.

Uses a member variable that caches the result.

Returns
array an associative array with state group id => state id pairs
Parameters
boolean$refreshCacheif the cache in the member variable needs to be refreshed

Referenced by assignState().

eZContentObject::stateIdentifierArray ( )
eZContentObject::store (   $fieldFilters = null)

Store the 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.

Referenced by removeThis(), removeTranslation(), revertTo(), serialize(), setAlwaysAvailableLanguageID(), and eZContentFunctions\updateAndPublishObject().

eZContentObject::storeInput (   $contentObjectAttributes,
  $attributeInputMap 
)
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.
eZContentObject::storeNodeModified ( )

Update all nodes to set modified_subnode value

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.

Referenced by store().

static eZContentObject::translationList ( )
static
Returns
an array with locale objects, these objects represents the languages the content objects are allowed to be translated into.
Note
the setting ContentSettings/TranslationList in site.ini determines the array.
See Also
translationStringList

Referenced by eZContentFunctionCollection\fetchTranslationList(), eZContentObjectPackageCreator\initializeObjectLimits(), eZContentObjectPackageCreator\loadObjectLimits(), and eZContentObjectVersion\nonTranslationList().

static eZContentObject::translationStringList ( )
static
Returns
an array with locale strings, these strings represents the languages which content objects are allowed to be translated into.
Note
the setting ContentSettings/TranslationList in site.ini determines the array.
See Also
translationList
static eZContentObject::unserialize (   $package,
  $domNode,
$options,
  $ownerID = false,
  $handlerType = 'ezcontentobject' 
)
static

Unserialize xml structure. Create object from xml input.

Parameters
package
XMLDOM Node
parentnode object.
Options
ownerID, override owner ID, null to use XML owner id (optional)
Returns
created object, false if could not create object/xml invalid
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.

Referenced by checkAccess(), classListFromPolicy(), and eZContentObjectPackageHandler\installContentObjects().

eZContentObject::validateInput (   $contentObjectAttributes,
  $attributeDataBaseName,
  $inputParameters = false,
  $parameters = array() 
)
eZContentObject::version (   $version,
  $asObject = true 
)

Returns the given object version. False is returned if the versions does not exist.

Referenced by createNewVersion(), and serialize().

eZContentObject::versionLanguageName (   $version,
  $lang = false 
)

Referenced by name().

eZContentObject::versions (   $asObject = true,
  $parameters = array() 
)

Returns an array of eZContentObjectVersion for the current object according to the conditions in $parameters.

Parameters
boolean$asObject
array$parameters
Returns
array

Referenced by cleanupInternalDrafts(), copy(), createNewVersion(), hasRemainingVersions(), postUnserialize(), removeTranslation(), and serialize().

Member Data Documentation

eZContentObject::$ClassIdentifier

Cached class identifier.

Referenced by contentClassIdentifier().

eZContentObject::$ClassName

Stores the current class name.

Referenced by className().

eZContentObject::$ContentActionList = false

Contains an array of the content object actions for the current object.

Referenced by contentActionList().

eZContentObject::$ContentObjectAttributes = array()

Contains a cached version of the content object attributes for the given version and language.

eZContentObject::$CurrentLanguage

Stores the current language.

Referenced by contentObjectAttributes(), currentLanguage(), fetchDataMap(), and name().

eZContentObject::$DataMap = array()

Contains the datamap for content object attributes.

Referenced by resetDataMap().

eZContentObject::$InputRelationList = array()

Contains the arrays of relatedobject id by fetching input for this object.

eZContentObject::$MainNodeID = false

Contains the main node id for this object.

Referenced by mainNodeID().

eZContentObject::$Name

Referenced by name().

eZContentObject::$StateIDArray = false
private

Referenced by stateIDArray().

const eZContentObject::PACKAGE_DELETE = 4
const eZContentObject::PACKAGE_ERROR_EXISTS = 2
const eZContentObject::PACKAGE_ERROR_HAS_CHILDREN = 102
const eZContentObject::PACKAGE_ERROR_MODIFIED = 101
const eZContentObject::PACKAGE_ERROR_NO_CLASS = 1
const eZContentObject::PACKAGE_ERROR_NODE_EXISTS = 3
const eZContentObject::PACKAGE_KEEP = 5
const eZContentObject::PACKAGE_NEW = 3
const eZContentObject::PACKAGE_REPLACE = 1
const eZContentObject::PACKAGE_SKIP = 2
const eZContentObject::PACKAGE_UPDATE = 6

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