eZContentObject Class Reference
[Kernel system]

Handles eZ publish content objects. More...

Inheritance diagram for eZContentObject:
eZPersistentObject

List of all members.

Public Member Functions

 accessList ($function)
 addContentObjectRelation ($toObjectID, $fromObjectVersion=false, $fromObjectID=false, $attributeID=0, $relationType=EZ_CONTENT_OBJECT_RELATION_COMMON)
& addLocation ($parentNodeID, $asObject=false)
 allContentObjectAttributes ($contentObjectID, $asObject=true)
& allLanguages ()
 appendInputRelationList ($addingIDList, $relationType)
& assignedNodes ($asObject=true)
& 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)
 clearCache ($idArray=array())
 clone ()
 commitInputRelations ($editVersion)
& contentActionList ()
& contentClass ()
& contentClassGroupIDList ()
& contentClassIdentifier ()
& contentObjectAttributes ($asObject=true, $version=false, $language=false, $contentObjectAttributeID=false, $distinctItemsOnly=false)
& contentObjectListRelatingThis ($version=false, $objectID=false)
& copy ($allVersions=true)
 copyContentObjectRelations ($currentVersion, $newVersion, $newObjectID=false)
 copyRevertTo ($version, $language=false)
 copyVersion (&$newObject, &$version, $newVersionNumber, $contentObjectID=false, $status=EZ_VERSION_STATUS_DRAFT, $languageCode=false, $copyFromLanguageCode=false)
 create ($name, $contentclassID, $userID, $sectionID=1, $version=1, $languageCode=false)
 createInitialVersion ($userID, $initialLanguageCode=false)
 createNewVersion ($copyFromVersion=false, $versionCheck=true, $languageCode=false, $copyFromLanguageCode=false, $status=EZ_VERSION_STATUS_DRAFT)
& createNewVersionIn ($languageCode, $copyFromLanguageCode=false, $copyFromVersion=false, $versionCheck=true, $status=EZ_VERSION_STATUS_DRAFT)
 createNodeAssignment ($parentNodeID, $isMain, $remoteID=false, $sortField=2, $sortOrder=0)
 createWithNodeAssignment ($parentNode, $contentClassID, $languageCode, $remoteID=false)
& currentLanguage ()
& currentLanguageObject ()
& currentVersion ($asObject=true)
& dataMap ()
& defaultLanguage ()
 definition ()
& embeddedContentObjectCount ($fromObjectVersion=false, $fromObjectID=false)
& embeddedContentObjectList ($fromObjectVersion=false, $fromObjectID=false)
 expireAllCache ()
 expireAllViewCache ()
 expireComplexViewModeCache ()
 expireTemplateBlockCache ()
 eZContentObject ($row)
& fetch ($id, $asObject=true)
& fetchByNodeID ($nodeID, $asObject=true)
& fetchByRemoteID ($remoteID, $asObject=true)
& fetchClassAttributes ($version=0, $asObject=true)
& fetchDataMap ($version=false, $language=false)
 fetchFilteredList ($conditions=null, $offset=false, $limit=false, $asObject=true)
& fetchIDArray ($idArray, $asObject=true)
 fetchInput (&$contentObjectAttributes, $attributeDataBaseName, $customActionAttributeArray, $customActionParameters)
 fetchList ($asObject=true, $conditions=null, $offset=false, $limit=false)
 fetchListCount ($conditions=null)
 fetchObjectCountByUserID ($classID, $userID)
 fetchSameClassList ($contentClassID, $asObject=true, $offset=false, $limit=false)
 fetchSameClassListCount ($contentClassID)
 fixReverseRelations ($objectID, $mode=false)
 fixupInput (&$contentObjectAttributes, $attributeDataBaseName)
 getVersionCount ()
 handleAllCustomHTTPActions ($attributeDataBaseName, $customActionAttributeArray, $customActionParameters, $objectVersion=false)
 handleCustomHTTPActions (&$contentObjectAttribute, $attributeDataBaseName, $customActionAttributeArray, $customActionParameters)
 hasContentAction ($name)
 hasRemainingVersions ()
& initialLanguage ()
& initialLanguageCode ()
& isAlwaysAvailable ()
 isCacheExpired ($timestamp)
 isComplexViewMode ($viewMode)
 isComplexViewModeCacheExpired ($viewMode, $timestamp)
 isObjectRelationTyped ()
& languages ()
& linkedContentObjectCount ($fromObjectVersion=false, $fromObjectID=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 ($id=false)
 recursionProtect ($id)
 recursionProtectionEnd ()
 recursionProtectionStart ()
& relatedContentObjectArray ($fromObjectVersion=false, $fromObjectID=false, $attributeID=0, $params=false)
& relatedContentObjectCount ($fromObjectVersion=false, $fromObjectID=false, $attributeID=0, $params=false)
& relatedContentObjectList ($fromObjectVersion=false, $fromObjectID=false, $attributeID=0, $groupByAttribute=false, $params=false)
& relatedObjectCount ($version=false, $objectID=false, $attributeID=0, $reverseRelatedObjects=false, $params=false)
& relatedObjects ($fromObjectVersion=false, $objectID=false, $attributeID=0, $groupByAttribute=false, $params=false, $reverseRelatedObjects=false)
 relationTypeMask ($allRelations=false)
& remoteID ()
 remove ($id=false, $nodeID=null)
 removeContentObjectRelation ($toObjectID=false, $fromObjectVersion=false, $fromObjectID=false, $attributeID=0, $relationType=EZ_CONTENT_OBJECT_RELATION_COMMON)
 removeReverseRelations ($objectID)
 removeTranslation ($languageID)
 rename ($newName)
 resetDataMap ()
 resetInputRelationList ()
& reverseEmbeddedObjectCount ($fromObjectVersion=false, $fromObjectID=false)
& reverseEmbeddedObjectList ($fromObjectVersion=false, $fromObjectID=false)
& reverseLinkedObjectCount ($fromObjectVersion=false, $fromObjectID=false)
& reverseLinkedObjectList ($fromObjectVersion=false, $fromObjectID=false)
& reverseRelatedObjectCount ($version=false, $toObjectID=false, $attributeID=0, $params=false)
& reverseRelatedObjectList ($version=false, $toObjectID=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)
 store ()
 storeInput (&$contentObjectAttributes, $attributeInputMap)
 storeNodeModified ()
 translationList ()
 translationStringList ()
 validateInput (&$contentObjectAttributes, $attributeDataBaseName, $inputParameters=false, $parameters=array())
& version ($version, $asObject=true)
& versionLanguageName ($contentObjectID, $version, $lang=false)
& versions ($asObject=true, $parameters=array())

Static Public Member Functions

 cleanupAllInternalDrafts ($userID=false, $timeDuration=86400)
 createFetchSQLString ($id)
 exists ($id)
 expireTemplateBlockCacheIfNeeded ()
 fillNodeListAttributes (&$nodeList, $asObject=true)
 removeVersions ($versionStatus=false)
 setDefaultLanguage ($lang)
& unserialize (&$package, &$domNode, &$options, $ownerID=false, $handlerType= 'ezcontentobject')

Public Attributes

 $ClassIdentifier
 Cached class identifier.
 $ClassName
 Stores the current class name.
 $ContentActionList = false
 Contains an array of the content object actions for the current object.
 $ContentObjectAttributes = array()
 Contains a cached version of the content object attributes for the given version and language.
 $CurrentLanguage
 Stores the current language.
 $DataMap = array()
 Contains the datamap for content object attributes.
 $ID
 $InputRelationList = array()
 Contains the arrays of relatedobject id by fetching input for this object.
 $MainNodeID = false
 Contains the main node id for this object.
 $Name

Private Member Functions

 mapLanguage ($language, $options)

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

Definition at line 73 of file ezcontentobject.php.

Member Function Documentation

eZContentObject::accessList ( $  function  ) 

Get accesslist for specified function

Parameters:
function 
Returns:
AccessList

Definition at line 4350 of file ezcontentobject.php.

eZContentObject::addContentObjectRelation ( $  toObjectID,
$  fromObjectVersion = false,
$  fromObjectID = false,
$  attributeID = 0,
$  relationType = EZ_CONTENT_OBJECT_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.

Definition at line 2500 of file ezcontentobject.php.

Referenced by commitInputRelations(), eZObjectRelationType::storeObjectAttribute(), and eZObjectRelationListType::storeObjectAttribute().

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

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

Parameters:
$parenNodeID The id of the node to use as parent.
$asObject If 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.

Definition at line 2473 of file ezcontentobject.php.

eZContentObject::allContentObjectAttributes ( $  contentObjectID,
$  asObject = true 
)

Definition at line 1875 of file ezcontentobject.php.

Referenced by revertTo().

& eZContentObject::allLanguages (  ) 

Definition at line 4673 of file ezcontentobject.php.

eZContentObject::appendInputRelationList ( $  addingIDList,
$  relationType 
)

Definition at line 2063 of file ezcontentobject.php.

& eZContentObject::assignedNodes ( $  asObject = true  ) 

Returns the node assignments for the current object.

Definition at line 3369 of file ezcontentobject.php.

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

& eZContentObject::authorArray (  ) 

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

Definition at line 5377 of file ezcontentobject.php.

& 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.

Definition at line 4647 of file ezcontentobject.php.

Referenced by canCreateLanguages(), canEditLanguages(), and copyVersion().

& eZContentObject::availableLanguagesJsArray (  ) 

Definition at line 4660 of file ezcontentobject.php.

eZContentObject::cacheInfo ( $  Params  ) 
Returns:
a structure with information required for caching.

Definition at line 5246 of file ezcontentobject.php.

& eZContentObject::canCreate (  ) 
Note:
The reference for the return value is required to workaround a bug with PHP references.

Definition at line 4432 of file ezcontentobject.php.

& 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:
$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.
$id A unique name for the current fetch, this must be supplied when filtering is used if you want caching to work.

Definition at line 4208 of file ezcontentobject.php.

& eZContentObject::canCreateLanguages (  ) 

Definition at line 3452 of file ezcontentobject.php.

& eZContentObject::canDiff (  ) 
Returns:
true if the current user can diff this content object.
Note:
The reference for the return value is required to workaround a bug with PHP references.

Definition at line 4418 of file ezcontentobject.php.

& eZContentObject::canEdit ( $  originalClassID = false,
$  parentClassID = false,
$  returnAccessList = false,
$  language = false 
)
Note:
The reference for the return value is required to workaround a bug with PHP references.

Definition at line 4446 of file ezcontentobject.php.

Referenced by canEditLanguages().

& eZContentObject::canEditLanguages (  ) 

Definition at line 3434 of file ezcontentobject.php.

& 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().
Note:
The reference for the return value is required to workaround a bug with PHP references.
Deprecated:
The function canMove() is preferred since its naming is clearer.

Definition at line 4527 of file ezcontentobject.php.

& 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().
Note:
The reference for the return value is required to workaround a bug with PHP references.

Definition at line 4539 of file ezcontentobject.php.

Referenced by canMove().

& eZContentObject::canPdf (  ) 
Returns:
true if the current user can create a pdf of this content object.
Note:
The reference for the return value is required to workaround a bug with PHP references.

Definition at line 4387 of file ezcontentobject.php.

& eZContentObject::canRead (  ) 
Returns:
true if the current user can read this content object.
Note:
The reference for the return value is required to workaround a bug with PHP references.

Definition at line 4372 of file ezcontentobject.php.

& eZContentObject::canRemove (  ) 
Note:
The reference for the return value is required to workaround a bug with PHP references.

Definition at line 4508 of file ezcontentobject.php.

& eZContentObject::canTranslate (  ) 
Note:
The reference for the return value is required to workaround a bug with PHP references.

Definition at line 4482 of file ezcontentobject.php.

& eZContentObject::canViewEmbed (  ) 
Returns:
true if the node can be viewed as embeded object by the current user.
See also:
checkAccess().
Note:
The reference for the return value is required to workaround a bug with PHP references.

Definition at line 4403 of file ezcontentobject.php.

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

Check access for the current object

Parameters:
function name ( edit, read, remove, etc. )
original class ID ( used to check access for object creation ), default false
parent class id ( used to check access for object creation ), default false
return access 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

Definition at line 3537 of file ezcontentobject.php.

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

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

Definition at line 3471 of file ezcontentobject.php.

Referenced by checkAccess().

eZContentObject::classListFromPolicy ( $  policy,
$  allowedLanguageCodes = false 
)

Definition at line 4061 of file ezcontentobject.php.

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.

Definition at line 4555 of file ezcontentobject.php.

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:
$userID The ID of the user to cleanup for, if false it will use the current user.

Definition at line 1843 of file ezcontentobject.php.

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:
$userID The ID of the user to cleanup for, if false it will use the current user.

Definition at line 1809 of file ezcontentobject.php.

eZContentObject::clearCache ( $  idArray = array()  ) 

Clear in-memory caches.

Parameters:
$idArray objects to clear caches for.

If the parameter is ommitted the caches are cleared for all objects.

Definition at line 283 of file ezcontentobject.php.

Referenced by eZContentObjectTreeNode::assignSectionToSubTree(), eZContentObjectPackageHandler::installContentObjects(), eZContentObjectTreeNode::removeSubtrees(), and eZContentObjectPackageHandler::uninstall().

eZContentObject::clone (  ) 
Returns:
a new clone of the current object which has is ready to be stored with a new ID.

Definition at line 1346 of file ezcontentobject.php.

Referenced by copy().

eZContentObject::commitInputRelations ( $  editVersion  ) 

Definition at line 2088 of file ezcontentobject.php.

Referenced by validateInput().

& eZContentObject::contentActionList (  ) 

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

Definition at line 4581 of file ezcontentobject.php.

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

Definition at line 633 of file ezcontentobject.php.

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

& eZContentObject::contentClassGroupIDList (  ) 
Returns:
the content class group identifiers for the current content object

Definition at line 596 of file ezcontentobject.php.

& 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.

Definition at line 608 of file ezcontentobject.php.

& 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

Definition at line 1891 of file ezcontentobject.php.

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

& eZContentObject::contentObjectListRelatingThis ( $  version = false,
$  objectID = false 
)

Returns the related objects.

Note:
This function is a duplicate of reverseRelatedObjectList(), use that function instead.

Definition at line 3187 of file ezcontentobject.php.

& 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.

Definition at line 1360 of file ezcontentobject.php.

eZContentObject::copyContentObjectRelations ( $  currentVersion,
$  newVersion,
$  newObjectID = false 
)

Definition at line 2673 of file ezcontentobject.php.

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.

Definition at line 1500 of file ezcontentobject.php.

eZContentObject::copyVersion ( &$  newObject,
&$  version,
$  newVersionNumber,
$  contentObjectID = false,
$  status = EZ_VERSION_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:
$languageCode If 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.

Definition at line 1189 of file ezcontentobject.php.

Referenced by copy(), and createNewVersion().

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

Creates a new content object instance and stores it.

Definition at line 1317 of file ezcontentobject.php.

Referenced by addLocation(), createInitialVersion(), and createNodeAssignment().

eZContentObject::createFetchSQLString ( $  id  )  [static]

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

Definition at line 774 of file ezcontentobject.php.

Referenced by exists(), and fetch().

eZContentObject::createInitialVersion ( $  userID,
$  initialLanguageCode = false 
)

Definition at line 1061 of file ezcontentobject.php.

eZContentObject::createNewVersion ( $  copyFromVersion = false,
$  versionCheck = true,
$  languageCode = false,
$  copyFromLanguageCode = false,
$  status = EZ_VERSION_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:
$versionCheck If 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.

Definition at line 1081 of file ezcontentobject.php.

Referenced by createNewVersionIn(), and rename().

& eZContentObject::createNewVersionIn ( $  languageCode,
$  copyFromLanguageCode = false,
$  copyFromVersion = false,
$  versionCheck = true,
$  status = EZ_VERSION_STATUS_DRAFT 
)

Definition at line 1066 of file ezcontentobject.php.

Referenced by copyRevertTo().

eZContentObject::createNodeAssignment ( $  parentNodeID,
$  isMain,
$  remoteID = false,
$  sortField = 2,
$  sortOrder = 0 
)

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

Returns:
The eZNodeAssignment object it created
Parameters:
$parentNodeID The node ID of the parent node
$isMain true if the created node is the main node of the object
$remoteID A string denoting the unique remote ID of the assignment or false for no remote id.
Note:
The return 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.

Definition at line 3317 of file ezcontentobject.php.

eZContentObject::createWithNodeAssignment ( $  parentNode,
$  contentClassID,
$  languageCode,
$  remoteID = false 
)

Definition at line 3336 of file ezcontentobject.php.

Referenced by eZWebDAVContentServer::createFolder().

& eZContentObject::currentLanguage (  ) 

Definition at line 2425 of file ezcontentobject.php.

& eZContentObject::currentLanguageObject (  ) 

Definition at line 2430 of file ezcontentobject.php.

& eZContentObject::currentVersion ( $  asObject = true  ) 

Returns the current version of this document.

Definition at line 979 of file ezcontentobject.php.

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.

Definition at line 516 of file ezcontentobject.php.

& eZContentObject::defaultLanguage (  ) 

Definition at line 4679 of file ezcontentobject.php.

Referenced by eZContentObjectVersion::create(), eZContentObjectAttribute::create(), create(), eZWebDAVContentServer::createFolder(), eZContentUpload::handleLocalFile(), eZContentUpload::handleUpload(), eZContentClass::instantiate(), and eZImageType::repairContentObjectAttribute().

eZContentObject::definition (  ) 
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: 

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.

Definition at line 106 of file ezcontentobject.php.

Referenced by eZMultiplexerType::attribute(), eZSection::canBeRemoved(), fetchFilteredList(), fetchList(), fetchListCount(), and fetchSameClassListCount().

& eZContentObject::embeddedContentObjectCount ( $  fromObjectVersion = false,
$  fromObjectID = false 
)

Returns the xml-embedded objects count.

Definition at line 3034 of file ezcontentobject.php.

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

Returns the xml-embedded objects.

Definition at line 2935 of file ezcontentobject.php.

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

Definition at line 748 of file ezcontentobject.php.

eZContentObject::expireAllCache (  ) 

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.

Definition at line 5284 of file ezcontentobject.php.

Referenced by eZContentCacheManager::clearAllContentCache().

eZContentObject::expireAllViewCache (  ) 

Sets all view cache files to be expired

Definition at line 5271 of file ezcontentobject.php.

Referenced by eZContentCacheManager::clearObjectViewCache(), eZContentObjectOperations::remove(), and eZContentClassOperations::remove().

eZContentObject::expireComplexViewModeCache (  ) 

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.

Definition at line 5323 of file ezcontentobject.php.

Referenced by eZContentCacheManager::clearObjectViewCache().

eZContentObject::expireTemplateBlockCache (  ) 

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.

Definition at line 5299 of file ezcontentobject.php.

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

eZContentObject::expireTemplateBlockCacheIfNeeded (  )  [static]

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

Definition at line 5311 of file ezcontentobject.php.

eZContentObject::eZContentObject ( $  row  ) 

Definition at line 75 of file ezcontentobject.php.

Referenced by create(), fetch(), fetchByNodeID(), fetchIDArray(), and relatedObjects().

& eZContentObject::fetch ( $  id,
$  asObject = true 
)

Fetches the content object with the given ID

Note:
Uses the static function createFetchSQLString() to generate the SQL

Definition at line 700 of file ezcontentobject.php.

Referenced by eZObjectRelationListType::appendObject(), checkAccess(), checkGroupLimitationAccess(), classListFromPolicy(), eZContentCacheManager::clearTemplateBlockCache(), contentClass(), eZInformationCollectionAttribute::contentObject(), createWithNodeAssignment(), eZObjectRelationListType::customObjectAttributeHTTPAction(), eZWaitUntilDateType::execute(), eZMultiplexerType::execute(), eZApproveType::execute(), fetchByRemoteID(), eZApproveType::fetchHTTPInput(), eZObjectRelationType::fromString(), eZObjectRelationListType::fromString(), eZContentObjectPackageHandler::generateFetchAliasArray(), eZContentCacheManager::generateObjectViewCache(), eZObjectRelationListType::handleCustomObjectHTTPActions(), eZObjectRelationListType::initializeObjectAttribute(), initialLanguage(), eZContentObjectPackageHandler::installSuspendedNodeAssignment(), eZObjectRelationListType::metaData(), eZContentCacheManager::nodeList(), eZContentCacheManager::nodeListForObject(), eZObjectRelationType::objectAttributeContent(), eZObjectRelationListType::onPublish(), owner(), eZContentUpload::publishObject(), purge(), eZContentObjectOperations::remove(), remove(), removeTranslation(), eZXMLTextType::serializeContentObjectAttribute(), eZObjectRelationType::serializeContentObjectAttribute(), eZObjectRelationListType::serializeContentObjectAttribute(), eZObjectRelationListType::title(), unserialize(), eZApproveType::validateGroupIDList(), eZObjectRelationListType::validateObjectAttributeHTTPInput(), eZApproveType::validateUserIDList(), and versionLanguageName().

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

Fetches the contentobject which has a node with the ID $nodeID

Parameters:
$asObject If true return the as a PHP object, if false return the raw database data.

Definition at line 797 of file ezcontentobject.php.

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

& eZContentObject::fetchByRemoteID ( $  remoteID,
$  asObject = true 
)

Fetches contentobject by remote ID, returns null if none exist

Definition at line 684 of file ezcontentobject.php.

Referenced by eZContentObjectPackageHandler::installContentObjects(), eZContentObjectPackageHandler::installFetchAliases(), eZContentObjectPackageHandler::installOverrides(), eZContentObjectPackageHandler::installSuspendedObjectRelations(), eZXMLTextType::postUnserializeContentObjectAttribute(), eZObjectRelationType::postUnserializeContentObjectAttribute(), eZObjectRelationListType::postUnserializeContentObjectAttribute(), eZContentObjectPackageHandler::uninstall(), eZContentObjectVersion::unserialize(), unserialize(), and eZObjectRelationType::unserializeContentObjectAttribute().

& 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

Definition at line 4765 of file ezcontentobject.php.

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

Definition at line 526 of file ezcontentobject.php.

Referenced by dataMap().

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

Definition at line 929 of file ezcontentobject.php.

Referenced by fetchSameClassList().

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

Fetches the content object from the ID array

Definition at line 856 of file ezcontentobject.php.

Referenced by checkGroupLimitationAccess(), and eZXMLOutputHandler::prefetch().

eZContentObject::fetchInput ( &$  contentObjectAttributes,
$  attributeDataBaseName,
$  customActionAttributeArray,
$  customActionParameters 
)

Definition at line 2246 of file ezcontentobject.php.

eZContentObject::fetchList ( $  asObject = true,
$  conditions = null,
$  offset = false,
$  limit = false 
)
Returns:
An array with content objects.
Parameters:
$asObject Whether to return objects or not
$conditions Optional conditions to limit the fetch, set to null to skip it.
$offset Where to start fetch from, set to false to skip it.
$limit Maximum number of objects to fetch, set false to skip it.
See also:
fetchListCount

Definition at line 916 of file ezcontentobject.php.

Referenced by eZContentCacheManager::clearContentCacheIfNeededBySectionID(), translationList(), and translationStringList().

eZContentObject::fetchListCount ( $  conditions = null  ) 
Returns:
The number of objects in the database. Optionally $conditions can be used to limit the list count.
See also:
fetchList

Definition at line 945 of file ezcontentobject.php.

eZContentObject::fetchObjectCountByUserID ( $  classID,
$  userID 
)
Returns:
the number of objects of the given class is created by the given user.

Definition at line 5397 of file ezcontentobject.php.

eZContentObject::fetchSameClassList ( $  contentClassID,
$  asObject = true,
$  offset = false,
$  limit = false 
)

Definition at line 958 of file ezcontentobject.php.

Referenced by eZContentClass::objectList(), and eZContentClassOperations::remove().

eZContentObject::fetchSameClassListCount ( $  contentClassID  ) 

Definition at line 964 of file ezcontentobject.php.

Referenced by eZContentClassPackageHandler::install(), and eZContentClassPackageHandler::uninstall().

eZContentObject::fillNodeListAttributes ( &$  nodeList,
$  asObject = true 
) [static]

Fetches the attributes for an array of objects. The objectList parameter contains an array of object id's , versions and language to fetch attributes from.

Definition at line 1987 of file ezcontentobject.php.

Referenced by eZTreeMenuOperator::modify(), and eZContentObjectTreeNode::subTree().

eZContentObject::fixReverseRelations ( $  objectID,
$  mode = false 
)

Definition at line 1507 of file ezcontentobject.php.

Referenced by purge(), and remove().

eZContentObject::fixupInput ( &$  contentObjectAttributes,
$  attributeDataBaseName 
)

Definition at line 2236 of file ezcontentobject.php.

eZContentObject::getVersionCount (  ) 

Returns number of exist versions.

Definition at line 2416 of file ezcontentobject.php.

Referenced by createNewVersion().

eZContentObject::handleAllCustomHTTPActions ( $  attributeDataBaseName,
$  customActionAttributeArray,
$  customActionParameters,
$  objectVersion = false 
)

Definition at line 2313 of file ezcontentobject.php.

eZContentObject::handleCustomHTTPActions ( &$  contentObjectAttribute,
$  attributeDataBaseName,
$  customActionAttributeArray,
$  customActionParameters 
)

Definition at line 2297 of file ezcontentobject.php.

Referenced by fetchInput().

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

Definition at line 4624 of file ezcontentobject.php.

Referenced by contentActionList().

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

Definition at line 1050 of file ezcontentobject.php.

& eZContentObject::initialLanguage (  ) 

Definition at line 2450 of file ezcontentobject.php.

Referenced by createNewVersion(), initialLanguageCode(), and setName().

& eZContentObject::initialLanguageCode (  ) 

Definition at line 2457 of file ezcontentobject.php.

Referenced by contentActionList(), fetchInput(), and validateInput().

& eZContentObject::isAlwaysAvailable (  ) 

Definition at line 5595 of file ezcontentobject.php.

Referenced by copyVersion().

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

Definition at line 5334 of file ezcontentobject.php.

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

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

Definition at line 5349 of file ezcontentobject.php.

Referenced by isComplexViewModeCacheExpired().

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

Definition at line 5359 of file ezcontentobject.php.

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

eZContentObject::isObjectRelationTyped (  ) 

Definition at line 2705 of file ezcontentobject.php.

Referenced by relationTypeMask().

& eZContentObject::languages (  ) 

Definition at line 4666 of file ezcontentobject.php.

Referenced by availableLanguages().

& eZContentObject::linkedContentObjectCount ( $  fromObjectVersion = false,
$  fromObjectID = false 
)

Returns the xml-linked objects count.

Definition at line 3025 of file ezcontentobject.php.

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

Returns the xml-linked objects.

Definition at line 2926 of file ezcontentobject.php.

& eZContentObject::mainNode (  ) 

Definition at line 3412 of file ezcontentobject.php.

& eZContentObject::mainNodeID (  ) 

Returns the main node id for the current object.

Definition at line 3402 of file ezcontentobject.php.

& eZContentObject::mainParentNodeID (  ) 

Definition at line 675 of file ezcontentobject.php.

eZContentObject::mapLanguage ( $  language,
$  options 
) [private]

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

Returns:
string

Definition at line 4777 of file ezcontentobject.php.

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.
Note:
The reference for the return value is required to workaround a bug with PHP references.

Definition at line 241 of file ezcontentobject.php.

& eZContentObject::name ( $  version = false,
$  lang = false 
)

Definition at line 331 of file ezcontentobject.php.

eZContentObject::names (  ) 

Definition at line 351 of file ezcontentobject.php.

eZContentObject::nextVersion (  ) 

Returns the next available version number for this object.

Definition at line 2385 of file ezcontentobject.php.

Referenced by createNewVersion().

& eZContentObject::owner (  ) 

Returns the owner of the object as a content object.

Definition at line 584 of file ezcontentobject.php.

& eZContentObject::parentNodeIDArray (  ) 

Get parent node IDs

Definition at line 3270 of file ezcontentobject.php.

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

Definition at line 3281 of file ezcontentobject.php.

Referenced by parentNodeIDArray().

eZContentObject::permissions (  ) 

Returns the permission for the current object.

Definition at line 3429 of file ezcontentobject.php.

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)

Definition at line 5117 of file ezcontentobject.php.

eZContentObject::previousVersion (  ) 

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

Definition at line 2397 of file ezcontentobject.php.

eZContentObject::publishContentObjectRelations ( $  version  ) 

Definition at line 3193 of file ezcontentobject.php.

eZContentObject::purge ( $  id = false  ) 

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.

Definition at line 1580 of file ezcontentobject.php.

eZContentObject::recursionProtect ( $  id  ) 

Definition at line 2342 of file ezcontentobject.php.

Referenced by eZObjectRelationListType::handleCustomObjectHTTPActions(), eZObjectRelationType::metaData(), and eZObjectRelationListType::metaData().

eZContentObject::recursionProtectionEnd (  ) 

Definition at line 2355 of file ezcontentobject.php.

eZContentObject::recursionProtectionStart (  ) 

Definition at line 2337 of file ezcontentobject.php.

& eZContentObject::relatedContentObjectArray ( $  fromObjectVersion = false,
$  fromObjectID = false,
$  attributeID = 0,
$  params = false 
)

Definition at line 2960 of file ezcontentobject.php.

& eZContentObject::relatedContentObjectCount ( $  fromObjectVersion = false,
$  fromObjectID = false,
$  attributeID = 0,
$  params = false 
)
Returns:
the number of related objects
Parameters:
$attributeID : ( makes sense only when $params['AllRelations'] not set or EZ_CONTENT_OBJECT_RELATION_ATTRIBUTE ) >0 - return relations made with attribute ID ( "related object(s)" datatype ) 0 or false ( $params['AllRelations'] is EZ_CONTENT_OBJECT_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

Definition at line 2983 of file ezcontentobject.php.

& 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 EZ_CONTENT_OBJECT_RELATION_ATTRIBUTE ) >0 - return relations made with attribute ID ( "related object(s)" datatype ) 0 or false ( $params['AllRelations'] is EZ_CONTENT_OBJECT_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

Definition at line 2911 of file ezcontentobject.php.

Referenced by relatedContentObjectArray(), and eZContentObjectVersion::serialize().

& eZContentObject::relatedObjectCount ( $  version = false,
$  objectID = false,
$  attributeID = 0,
$  reverseRelatedObjects = false,
$  params = false 
)
Returns:
the number of related or reverse related objects
Parameters:
$attributeID : ( makes sense only when $params['AllRelations'] not set or EZ_CONTENT_OBJECT_RELATION_ATTRIBUTE ) >0 - return relations made with attribute ID ( "related object(s)" datatype ) 0 or false ( $params['AllRelations'] is EZ_CONTENT_OBJECT_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
$reverseRelatedObjects : if "true" returns reverse related contentObjects if "false" returns related contentObjects

Definition at line 3077 of file ezcontentobject.php.

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 EZ_CONTENT_OBJECT_RELATION_ATTRIBUTE ) >0 - return relations made with attribute ID ( "related object(s)" datatype ) 0 or false ( $params['AllRelations'] is EZ_CONTENT_OBJECT_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
$reverseRelatedObjects : if "true" returns reverse related contentObjects if "false" returns related contentObjects

Definition at line 2758 of file ezcontentobject.php.

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

eZContentObject::relationTypeMask ( $  allRelations = false  ) 

Definition at line 2718 of file ezcontentobject.php.

Referenced by relatedObjectCount(), and relatedObjects().

& eZContentObject::remoteID (  ) 

Get remote id of content node

Definition at line 648 of file ezcontentobject.php.

eZContentObject::remove ( $  id = false,
$  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.

Reimplemented from eZPersistentObject.

Definition at line 1716 of file ezcontentobject.php.

Referenced by unserialize().

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

Removes a link to the given content object id.

Parameters:
$toObjectID If false it will delete relations to all the objects.
$attributeID ID 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.

Definition at line 2593 of file ezcontentobject.php.

Referenced by commitInputRelations(), and eZObjectRelationListType::storeObjectAttribute().

eZContentObject::removeReverseRelations ( $  objectID  ) 

Definition at line 1533 of file ezcontentobject.php.

eZContentObject::removeTranslation ( $  languageID  ) 

Definition at line 5509 of file ezcontentobject.php.

eZContentObject::removeVersions ( $  versionStatus = false  )  [static]
Deprecated:
This method is left here only for backward compatibility. Use eZContentObjectVersion::removeVersions() method instead.

Definition at line 5416 of file ezcontentobject.php.

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.

Definition at line 5426 of file ezcontentobject.php.

eZContentObject::resetDataMap (  ) 

Definition at line 574 of file ezcontentobject.php.

eZContentObject::resetInputRelationList (  ) 

Definition at line 2057 of file ezcontentobject.php.

Referenced by appendInputRelationList(), and validateInput().

& eZContentObject::reverseEmbeddedObjectCount ( $  fromObjectVersion = false,
$  fromObjectID = false 
)

Returns the reverse xml-embedded objects count.

Definition at line 3052 of file ezcontentobject.php.

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

Returns the reverse xml-embedded objects.

Definition at line 2953 of file ezcontentobject.php.

& eZContentObject::reverseLinkedObjectCount ( $  fromObjectVersion = false,
$  fromObjectID = false 
)

Returns the reverse xml-linked objects count.

Definition at line 3043 of file ezcontentobject.php.

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

Returns the reverse xml-linked objects.

Definition at line 2944 of file ezcontentobject.php.

& eZContentObject::reverseRelatedObjectCount ( $  version = false,
$  toObjectID = 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 EZ_CONTENT_OBJECT_RELATION_ATTRIBUTE ) >0 - return relations made with attribute ID ( "related object(s)" datatype ) 0 or false ( $params['AllRelations'] is EZ_CONTENT_OBJECT_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

Definition at line 3176 of file ezcontentobject.php.

& eZContentObject::reverseRelatedObjectList ( $  version = false,
$  toObjectID = 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 EZ_CONTENT_OBJECT_RELATION_ATTRIBUTE ) >0 - return relations made with attribute ID ( "related object(s)" datatype ) 0 or false ( $params['AllRelations'] is EZ_CONTENT_OBJECT_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

Definition at line 3011 of file ezcontentobject.php.

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.

Definition at line 1463 of file ezcontentobject.php.

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 
Content object version, true for current version, false for all, else array containing specific versions.
package options ( optianal )
array of allowed nodes ( optional )
array of 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.

Definition at line 5139 of file ezcontentobject.php.

eZContentObject::setAlwaysAvailableLanguageID ( $  languageID,
$  version = false 
)

Definition at line 5606 of file ezcontentobject.php.

eZContentObject::setCachedName ( $  name  ) 

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

Definition at line 441 of file ezcontentobject.php.

eZContentObject::setClassName ( $  name  ) 

Definition at line 4719 of file ezcontentobject.php.

eZContentObject::setContentObjectAttributes ( &$  attributes,
$  version,
$  language 
)

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

Definition at line 1977 of file ezcontentobject.php.

eZContentObject::setCurrentLanguage ( $  lang  ) 

Definition at line 2444 of file ezcontentobject.php.

eZContentObject::setDefaultLanguage ( $  lang  )  [static]

Set default language. Checks if default language is valid.

Parameters:
default language.
Note:
Deprecated.

Definition at line 4711 of file ezcontentobject.php.

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.

Definition at line 451 of file ezcontentobject.php.

eZContentObject::setPermissions ( $  permissionArray  ) 

Sets the permissions for this object.

Definition at line 3421 of file ezcontentobject.php.

eZContentObject::store (  ) 

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.

Definition at line 259 of file ezcontentobject.php.

Referenced by removeTranslation(), revertTo(), serialize(), and setAlwaysAvailableLanguageID().

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.

Definition at line 2364 of file ezcontentobject.php.

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.

Definition at line 315 of file ezcontentobject.php.

Referenced by store().

eZContentObject::translationList (  ) 
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

Definition at line 4747 of file ezcontentobject.php.

Referenced by eZContentObjectPackageCreator::initializeObjectLimits(), and eZContentObjectPackageCreator::loadObjectLimits().

eZContentObject::translationStringList (  ) 
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

Definition at line 4729 of file ezcontentobject.php.

& eZContentObject::unserialize ( &$  package,
&$  domNode,
&$  options,
$  ownerID = false,
$  handlerType = 'ezcontentobject' 
) [static]

Unserialize xml structure. Create object from xml input.

Parameters:
package 
XML DOM Node
parent node object.
Options 
owner ID, 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.

Definition at line 4800 of file ezcontentobject.php.

Referenced by checkAccess(), and eZContentObjectPackageHandler::installContentObjects().

eZContentObject::validateInput ( &$  contentObjectAttributes,
$  attributeDataBaseName,
$  inputParameters = false,
$  parameters = array() 
)

Definition at line 2112 of file ezcontentobject.php.

& eZContentObject::version ( $  version,
$  asObject = true 
)

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

Definition at line 988 of file ezcontentobject.php.

Referenced by createNewVersion(), and serialize().

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

Definition at line 367 of file ezcontentobject.php.

Referenced by eZContentObjectVersion::name(), and name().

& eZContentObject::versions ( $  asObject = true,
$  parameters = array() 
)
Returns:
an array of versions for the current object.
Note:
The reference for the return value is required to workaround a bug with PHP references.

Definition at line 1020 of file ezcontentobject.php.

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

Member Data Documentation

eZContentObject::$ClassIdentifier

Cached class identifier.

Definition at line 5665 of file ezcontentobject.php.

eZContentObject::$ClassName

Stores the current class name.

Definition at line 5662 of file ezcontentobject.php.

eZContentObject::$ContentActionList = false

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

Definition at line 5671 of file ezcontentobject.php.

eZContentObject::$ContentObjectAttributes = array()

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

Definition at line 5674 of file ezcontentobject.php.

eZContentObject::$CurrentLanguage

Stores the current language.

Definition at line 5659 of file ezcontentobject.php.

eZContentObject::$DataMap = array()

Contains the datamap for content object attributes.

Definition at line 5668 of file ezcontentobject.php.

eZContentObject::$ID

Definition at line 5655 of file ezcontentobject.php.

eZContentObject::$InputRelationList = array()

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

Definition at line 5680 of file ezcontentobject.php.

eZContentObject::$MainNodeID = false

Contains the main node id for this object.

Definition at line 5677 of file ezcontentobject.php.

eZContentObject::$Name

Definition at line 5656 of file ezcontentobject.php.

The documentation for this class was generated from the following file:
Generated on Mon Jul 12 07:10:15 2010 for eZ publish by  doxygen 1.6.3