kernel/classes/ezcontentobject.php

Show:

inherited

Classes
- \eZContentObject

Table of Contents

File containing the eZContentObject class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Package: kernel
Version: 4.6.0

\eZContentObject
jump to top

Package: kernel

File containing the eZContentObject class.

Parent(s): \eZPersistentObject
Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Version: 4.6.0

Constants

 
                STATUS_DRAFT
                = 0

 
                STATUS_PUBLISHED
                = 1

 
                STATUS_ARCHIVED
                = 2

 
                PACKAGE_ERROR_NO_CLASS
                = 1

 
                PACKAGE_ERROR_EXISTS
                = 2

 
                PACKAGE_ERROR_NODE_EXISTS
                = 3

 
                PACKAGE_ERROR_MODIFIED
                = 101

 
                PACKAGE_ERROR_HAS_CHILDREN
                = 102

 
                PACKAGE_REPLACE
                = 1

 
                PACKAGE_SKIP
                = 2

 
                PACKAGE_NEW
                = 3

 
                PACKAGE_UPDATE
                = 6

 
                PACKAGE_DELETE
                = 4

 
                PACKAGE_KEEP
                = 5

 
                RELATION_COMMON
                = 1

 
                RELATION_EMBED
                = 2

 
                RELATION_LINK
                = 4

 
                RELATION_ATTRIBUTE
                = 8

Properties


                 $ClassIdentifier= ''

Details

Type: n/a


                 $ClassName= ''

Details

Type: n/a


                 $ContentActionList= 'false'

Default valuefalseDetails

Type: n/a


                 $ContentObjectAttributes= 'array()'

Default valuearray()Details

Type: n/a


                 $CurrentLanguage= ''

Details

Type: n/a


                 $DataMap= 'array()'

Default valuearray()Details

Type: n/a


                 $ID= ''

Details

Type: n/a


                 $InputRelationList= 'array()'

Default valuearray()Details

Type: n/a


                 $MainNodeID= 'false'

Default valuefalseDetails

Type: n/a


                 $Name= ''

Details

Type: n/a


                 $PersistentDataDirty= ''

inheritedInherited from: \eZPersistentObject::$$PersistentDataDirty

Details

Type: n/a
Inherited_from: \eZPersistentObject::$$PersistentDataDirty

array
                 $StateIDArray= 'false'

Cache for the state ID array

Default valuefalseDetails

Type: array
See: \eZContentObject::stateIDArray()

Methods

__clone(
          
          )
        
        :
          void

accessList(
           $function
          )
        
        :
          void

Parameters

Name	Type	Description
$function

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

Parameters

Name	Type	Description
$toObjectID
$fromObjectVersion
$attributeID
$relationType

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

Parameters

Name	Type	Description
$parentNodeID
$asObject

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

Parameters

Name	Type	Description
$contentObjectID
$asObject

allLanguages(
          
          )
        
        :
          void

allowedAssignSectionList(
          
          )
        
        :
          void

allowedAssignStateIDList(
          \eZUser $user
              =
              null
          )
        
        :
          array

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

Parameters

Name	Type	Description
$user	\eZUser	the user to check the policies of, when omitted the currently logged in user will be used

Returns

Type	Description
array	the IDs of all states we are allowed to set

allowedAssignStateList(
           $user
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$user

appendInputRelationList(
           $addingIDList,  $relationType
          )
        
        :
          void

Parameters

Name	Type	Description
$addingIDList
$relationType

assignDefaultStates(
          
          )
        
        :
          void

Sets the default states of a content object.

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

assignState(
          \eZContentObjectState $state
          )
        
        :
          boolean

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

Name	Type	Description
$state	\eZContentObjectState

Returns

Type	Description
boolean	true when the state was set, false if the state equals the current state

assignedNodes(
           $asObject
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$asObject

attribute(
           $attr,  $noFunction
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::attribute()

Parameters

Name	Type	Description
$attr
$noFunction

attributes(
          
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::attributes()

authorArray(
          
          )
        
        :
          void

availableLanguages(
          
          )
        
        :
          void

availableLanguagesJsArray(
          
          )
        
        :
          void

cacheInfo(
           $Params
          )
        
        :
          void

Parameters

Name	Type	Description
$Params

canCreate(
          
          )
        
        :
          void

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

Parameters

Name	Type	Description
$asObject
$includeFilter
$groupList
$fetchID

canCreateLanguages(
          
          )
        
        :
          void

canDiff(
          
          )
        
        :
          void

canEdit(
           $originalClassID
              =
              false,  $parentClassID
              =
              false,  $returnAccessList
              =
              false,  $language
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$originalClassID
$parentClassID
$returnAccessList
$language

canEditLanguages(
          
          )
        
        :
          void

canMove(
          
          )
        
        :
          void

canMoveFrom(
          
          )
        
        :
          void

canPdf(
          
          )
        
        :
          void

canRead(
          
          )
        
        :
          void

canRemove(
          
          )
        
        :
          void

canTranslate(
          
          )
        
        :
          void

canViewEmbed(
          
          )
        
        :
          void

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

Parameters

Name	Type	Description
$functionName
$originalClassID
$parentClassID
$returnAccessList
$language

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

Parameters

Name	Type	Description
$limitationValueList
$userID
$contentObjectID

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

Parameters

Name	Type	Description
$policy
$allowedLanguageCodes

className(
          
          )
        
        :
          void

cleanupAllInternalDrafts(
           $userID
              =
              false,  $timeDuration
              =
              86400
          )
        
        :
          void

static

Parameters

Name	Type	Description
$userID
$timeDuration

cleanupInternalDrafts(
           $userID
              =
              false,  $timeDuration
              =
              86400
          )
        
        :
          void

Parameters

Name	Type	Description
$userID
$timeDuration

clearCache(
           $idArray
              =
              array()
          )
        
        :
          void

static

Parameters

Name	Type	Description
$idArray

commitInputRelations(
           $editVersion
          )
        
        :
          void

Parameters

Name	Type	Description
$editVersion

conditionText(
           $conditions
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::conditionText()

Parameters

Name	Type	Description
$conditions

conditionTextByRow(
           $conditions,  $row
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::conditionTextByRow()

Parameters

Name	Type	Description
$conditions
$row

contentActionList(
          
          )
        
        :
          void

contentClass(
          
          )
        
        :
          void

contentClassGroupIDList(
          
          )
        
        :
          void

contentClassIdentifier(
          
          )
        
        :
          void

contentObjectAttributes(
           $asObject
              =
              true,  $version
              =
              false,  $language
              =
              false,  $contentObjectAttributeID
              =
              false,  $distinctItemsOnly
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$asObject
$version
$language
$contentObjectAttributeID
$distinctItemsOnly

contentObjectListRelatingThis(
           $version
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$version

copy(
           $allVersions
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$allVersions

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

Parameters

Name	Type	Description
$currentVersion
$newVersion
$newObjectID

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

Parameters

Name	Type	Description
$version
$language

copyVersion(
           $newObject,  $version,  $newVersionNumber,  $contentObjectID
              =
              false,  $status
              =
              eZContentObjectVersion::STATUS_DRAFT,  $languageCode
              =
              false,  $copyFromLanguageCode
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$newObject
$version
$newVersionNumber
$contentObjectID
$status
$languageCode
$copyFromLanguageCode

count(
           $def,  $conds
              =
              null,  $field
              =
              null
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::count()

Parameters

Name	Type	Description
$def
$conds
$field

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

static

Parameters

Name	Type	Description
$name
$contentclassID
$userID
$sectionID
$version
$languageCode

createFetchSQLString(
           $id
          )
        
        :
          void

static

Parameters

Name	Type	Description
$id

createFilterByVisibilitySQLString(
          bool $IgnoreVisibility
              =
              false, string $ezcontentobjectTable
              =
              'ezcontentobject'
          )
        
        :
          string

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.

Parameters

Name	Type	Description
$IgnoreVisibility	bool	ignores visibility if true
$ezcontentobjectTable	string	name of ezcontentobject table used in sql

Returns

Type	Description
string	with sql condition for node filtering by visibility

Details

Since: Version 4.1
Static

createGroupedDataMap(
          array $contentObjectAttributes
          )
        
        :
          array

static

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

Parameters

Name	Type	Description
$contentObjectAttributes	array	Array of eZContentObjectAttribute objects

Returns

Type	Description
array

Details

Note: Result is not cached, so make sure you don't call this over and over.

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

Parameters

Name	Type	Description
$userID
$initialLanguageCode

createNewVersion(
           $copyFromVersion
              =
              false,  $versionCheck
              =
              true,  $languageCode
              =
              false,  $copyFromLanguageCode
              =
              false,  $status
              =
              eZContentObjectVersion::STATUS_DRAFT
          )
        
        :
          void

Parameters

Name	Type	Description
$copyFromVersion
$versionCheck
$languageCode
$copyFromLanguageCode
$status

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

Parameters

Name	Type	Description
$languageCode
$copyFromLanguageCode
$copyFromVersion
$versionCheck
$status

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

Parameters

Name	Type	Description
$parentNodeID
$isMain
$remoteID
$sortField
$sortOrder

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

static

Parameters

Name	Type	Description
$parentNode
$contentClassID
$languageCode
$remoteID

currentLanguage(
          
          )
        
        :
          void

currentLanguageObject(
          
          )
        
        :
          void

currentVersion(
           $asObject
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$asObject

dataMap(
          
          )
        
        :
          void

defaultLanguage(
          
          )
        
        :
          void

static

definition(
          
          )
        
        :
          void

static

eZContentObject(
           $row
          )
        
        :
          void

Parameters

Name	Type	Description
$row

eZPersistentObject(
           $row
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::eZPersistentObject()

Parameters

Name	Type	Description
$row

embeddedContentObjectCount(
           $fromObjectVersion
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$fromObjectVersion

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

Parameters

Name	Type	Description
$fromObjectVersion
$fromObjectID

escapeArray(
           $array
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::escapeArray()

Parameters

Name	Type	Description
$array

exists(
           $id
          )
        
        :
          void

static

Parameters

Name	Type	Description
$id

expireAllCache(
          
          )
        
        :
          void

static

expireAllViewCache(
          
          )
        
        :
          void

static

expireComplexViewModeCache(
          
          )
        
        :
          void

static

expireTemplateBlockCache(
          
          )
        
        :
          void

static

expireTemplateBlockCacheIfNeeded(
          
          )
        
        :
          void

static

fetch(
          int $id, bool $asObject
              =
              true
          )
        
        :
          \eZContentObject

static

Fetches a content object by ID

Parameters

Name	Type	Description
$id	int	ID of the content object to fetch
$asObject	bool	Return the result as an object (true) or an assoc. array (false)

Returns

Type	Description
\eZContentObject

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

Parameters

Name	Type	Description
$identifierArray
$version
$languageArray
$asObject

fetchByNodeID(
          int | array $nodeID, bool $asObject
              =
              true
          )
        
        :
          mixed

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

Name	Type	Description
$nodeID	int \| array	Single nodeID or array of NodeIDs
$asObject	bool	If results have to be returned as eZContentObject instances or not

Returns

Type	Description
mixed	Content object or array of content objects. Content objects can be eZContentObject instances or array result sets

fetchByRemoteID(
           $remoteID,  $asObject
              =
              true
          )
        
        :
          void

static

Parameters

Name	Type	Description
$remoteID
$asObject

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

Parameters

Name	Type	Description
$version
$asObject

fetchDataMap(
           $version
              =
              false,  $language
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$version
$language

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

static

Parameters

Name	Type	Description
$conditions
$offset
$limit
$asObject

fetchIDArray(
          array $idArray, bool $asObject
              =
              true
          )
        
        :
          \array(contentObjectID

static

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

Parameters

Name	Type	Description
$idArray	array	array of content object ids
$asObject	bool	Wether to get the result as an array of eZContentObject or an array of associative arrays

Returns

Type	Description
\array(contentObjectID	=> eZContentObject\|array) array of eZContentObject (if $asObject = true) or array of associative arrays (if $asObject = false)

fetchInput(
           $contentObjectAttributes,  $attributeDataBaseName,  $customActionAttributeArray,  $customActionParameters
          )
        
        :
          void

Parameters

Name	Type	Description
$contentObjectAttributes
$attributeDataBaseName
$customActionAttributeArray
$customActionParameters

fetchList(
           $asObject
              =
              true,  $conditions
              =
              null,  $offset
              =
              false,  $limit
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$asObject
$conditions
$offset
$limit

fetchListCount(
           $conditions
              =
              null
          )
        
        :
          void

static

Parameters

Name	Type	Description
$conditions

fetchObject(
           $def,  $field_filters,  $conds,  $asObject
              =
              true,  $grouping
              =
              null,  $custom_fields
              =
              null
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::fetchObject()

Parameters

Name	Type	Description
$def
$field_filters
$conds
$asObject
$grouping
$custom_fields

fetchObjectCountByUserID(
           $classID,  $userID,  $status
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$classID
$userID
$status

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

staticinherited

Inherited from: \eZPersistentObject::fetchObjectList()

Parameters

Name	Type	Description
$def
$field_filters
$conds
$sorts
$limit
$asObject
$grouping
$custom_fields
$custom_tables
$custom_conds

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

static

Parameters

Name	Type	Description
$contentClassID
$asObject
$offset
$limit

fetchSameClassListCount(
           $contentClassID
          )
        
        :
          void

static

Parameters

Name	Type	Description
$contentClassID

fill(
           $row
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::fill()

Parameters

Name	Type	Description
$row

fillNodeListAttributes(
           $objList,  $asObject
              =
              true
          )
        
        :
          void

static

Parameters

Name	Type	Description
$objList
$asObject

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

static

Parameters

Name	Type	Description
$objectID
$mode

fixupInput(
           $contentObjectAttributes,  $attributeDataBaseName
          )
        
        :
          void

Parameters

Name	Type	Description
$contentObjectAttributes
$attributeDataBaseName

getShortAttributeName(
           $db,  $def,  $attrName
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::getShortAttributeName()

Parameters

Name	Type	Description
$db
$def
$attrName

getVersionCount(
          
          )
        
        :
          void

groupedDataMap(
          
          )
        
        :
          array

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

Returns

Type	Description
array

Details

Note: Result is not cached, so make sure you don't call this over and over.

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

Parameters

Name	Type	Description
$attributeDataBaseName
$customActionAttributeArray
$customActionParameters
$objectVersion

handleCustomHTTPActions(
           $contentObjectAttribute,  $attributeDataBaseName,  $customActionAttributeArray,  $customActionParameters
          )
        
        :
          void

Parameters

Name	Type	Description
$contentObjectAttribute
$attributeDataBaseName
$customActionAttributeArray
$customActionParameters

handleRows(
           $rows,  $class_name,  $asObject
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::handleRows()

Parameters

Name	Type	Description
$rows
$class_name
$asObject

hasAttribute(
           $attr
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::hasAttribute()

Parameters

Name	Type	Description
$attr

hasContentAction(
           $name
          )
        
        :
          void

Parameters

Name	Type	Description
$name

hasDirtyData(
          
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::hasDirtyData()

hasRemainingVersions(
          
          )
        
        :
          void

initialLanguage(
          
          )
        
        :
          void

initialLanguageCode(
          
          )
        
        :
          void

isAlwaysAvailable(
          
          )
        
        :
          void

isCacheExpired(
           $timestamp
          )
        
        :
          void

static

Parameters

Name	Type	Description
$timestamp

isComplexViewMode(
           $viewMode
          )
        
        :
          void

static

Parameters

Name	Type	Description
$viewMode

isComplexViewModeCacheExpired(
           $viewMode,  $timestamp
          )
        
        :
          void

static

Parameters

Name	Type	Description
$viewMode
$timestamp

isObjectRelationTyped(
          
          )
        
        :
          void

static

languages(
          
          )
        
        :
          void

linkedContentObjectCount(
           $fromObjectVersion
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$fromObjectVersion

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

Parameters

Name	Type	Description
$fromObjectVersion
$fromObjectID

mainNode(
          
          )
        
        :
          void

mainNodeID(
          
          )
        
        :
          void

mainParentNodeID(
          
          )
        
        :
          void

mapLanguage(
           $language,  $options
          )
        
        :
          void

static

Parameters

Name	Type	Description
$language
$options

matchIngroupIDList(
          
          )
        
        :
          void

name(
           $version
              =
              false,  $lang
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$version
$lang

newObjectOrder(
           $def,  $orderField,  $conditions
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::newObjectOrder()

Parameters

Name	Type	Description
$def
$orderField
$conditions

nextVersion(
          
          )
        
        :
          void

parentNodeIDArray(
          
          )
        
        :
          void

parentNodes(
           $version
              =
              false,  $asObject
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$version
$asObject

permissions(
          
          )
        
        :
          void

postUnserialize(
           $package
          )
        
        :
          void

Parameters

Name	Type	Description
$package

previousVersion(
          
          )
        
        :
          void

publishContentObjectRelations(
           $version
          )
        
        :
          void

Parameters

Name	Type	Description
$version

recursionProtect(
           $id
          )
        
        :
          void

static

Parameters

Name	Type	Description
$id

recursionProtectionEnd(
          
          )
        
        :
          void

static

recursionProtectionStart(
          
          )
        
        :
          void

static

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

Parameters

Name	Type	Description
$fromObjectVersion
$fromObjectID
$attributeID
$params

relatedContentObjectCount(
           $fromObjectVersion
              =
              false,  $attributeID
              =
              0,  $params
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$fromObjectVersion
$attributeID
$params

relatedContentObjectList(
           $fromObjectVersion
              =
              false,  $fromObjectID
              =
              false,  $attributeID
              =
              0,  $groupByAttribute
              =
              false,  $params
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$fromObjectVersion
$fromObjectID
$attributeID
$groupByAttribute
$params

relatedObjectCount(
          int $version
              =
              false, int $attributeID
              =
              0, int | false $reverseRelatedObjects
              =
              false, array | false $params
              =
              false
          )
        
        :
          int

Fetch the number of (reverse) related objects

Parameters

Name	Type	Description
$version	int
$attributeID	int	This 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
$reverseRelatedObjects	int \| false	Wether to count related objects (false) or reverse related objects (false)
$params	array \| false	Various 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

Type	Description
int	The number of (reverse) related objects for the object

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

Parameters

Name	Type	Description
$fromObjectVersion
$objectID
$attributeID
$groupByAttribute
$params
$reverseRelatedObjects

relationTypeMask(
           $allRelations
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$allRelations

remoteID(
          
          )
        
        :
          void

remove(
           $conditions
              =
              null,  $extraConditions
              =
              null
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::remove()

Parameters

Name	Type	Description
$conditions
$extraConditions

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

Parameters

Name	Type	Description
$toObjectID
$fromObjectVersion
$attributeID
$relationType

removeObject(
           $def,  $conditions
              =
              null,  $extraConditions
              =
              null
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::removeObject()

Parameters

Name	Type	Description
$def
$conditions
$extraConditions

removeReverseRelations(
           $objectID
          )
        
        :
          void

Parameters

Name	Type	Description
$objectID

removeThis(
           $nodeID
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$nodeID

removeTranslation(
           $languageID
          )
        
        :
          void

Parameters

Name	Type	Description
$languageID

removeVersions(
           $versionStatus
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$versionStatus

rename(
           $newName
          )
        
        :
          void

Parameters

Name	Type	Description
$newName

reorderObject(
           $def,  $orderField,  $conditions,  $down
              =
              true
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::reorderObject()

Parameters

Name	Type	Description
$def
$orderField
$conditions
$down

replaceFieldsWithShortNames(
           $db,  $fieldDefs,  $fields
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::replaceFieldsWithShortNames()

Parameters

Name	Type	Description
$db
$fieldDefs
$fields

resetDataMap(
          
          )
        
        :
          void

resetInputRelationList(
          
          )
        
        :
          void

restoreObjectAttributes(
          
          )
        
        :
          void

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

reverseEmbeddedObjectCount(
           $fromObjectVersion
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$fromObjectVersion

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

Parameters

Name	Type	Description
$fromObjectVersion
$fromObjectID

reverseLinkedObjectCount(
           $fromObjectVersion
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$fromObjectVersion

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

Parameters

Name	Type	Description
$fromObjectVersion
$fromObjectID

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

Parameters

Name	Type	Description
$version
$attributeID
$params

reverseRelatedObjectList(
           $version
              =
              false,  $attributeID
              =
              0,  $groupByAttribute
              =
              false,  $params
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$version
$attributeID
$groupByAttribute
$params

revertTo(
           $version
          )
        
        :
          void

Parameters

Name	Type	Description
$version

serialize(
           $package,  $specificVersion
              =
              false,  $options
              =
              false,  $contentNodeIDArray
              =
              false,  $topNodeIDArray
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$package
$specificVersion
$options
$contentNodeIDArray
$topNodeIDArray

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

Parameters

Name	Type	Description
$languageID
$version

setAttribute(
           $attr,  $val
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::setAttribute()

Parameters

Name	Type	Description
$attr
$val

setCachedName(
           $name
          )
        
        :
          void

Parameters

Name	Type	Description
$name

setClassName(
           $name
          )
        
        :
          void

Parameters

Name	Type	Description
$name

setContentObjectAttributes(
           $attributes,  $version,  $language
          )
        
        :
          void

Parameters

Name	Type	Description
$attributes
$version
$language

setCurrentLanguage(
           $lang
          )
        
        :
          void

Parameters

Name	Type	Description
$lang

setDefaultLanguage(
           $lang
          )
        
        :
          void

static

Parameters

Name	Type	Description
$lang

setHasDirtyData(
           $hasDirtyData
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::setHasDirtyData()

Parameters

Name	Type	Description
$hasDirtyData

setName(
           $objectName,  $versionNum
              =
              false,  $languageCode
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$objectName
$versionNum
$languageCode

setPermissions(
           $permissionArray
          )
        
        :
          void

Parameters

Name	Type	Description
$permissionArray

stateIDArray(
          boolean $refreshCache
              =
              false
          )
        
        :
          array

Gets the current states of the content object.

Uses a member variable that caches the result.

Parameters

Name	Type	Description
$refreshCache	boolean	if the cache in the member variable needs to be refreshed

Returns

Type	Description
array	an associative array with state group id => state id pairs

stateIdentifierArray(
          
          )
        
        :
          void

store(
           $fieldFilters
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$fieldFilters

storeInput(
           $contentObjectAttributes,  $attributeInputMap
          )
        
        :
          void

Parameters

Name	Type	Description
$contentObjectAttributes
$attributeInputMap

storeNodeModified(
          
          )
        
        :
          void

storeObject(
           $obj,  $fieldFilters
              =
              null
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::storeObject()

Parameters

Name	Type	Description
$obj
$fieldFilters

swapRow(
           $table,  $keys,  $order_id,  $rows,  $id1,  $id2
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::swapRow()

Parameters

Name	Type	Description
$table
$keys
$order_id
$rows
$id1
$id2

sync(
           $fieldFilters
              =
              null
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::sync()

Parameters

Name	Type	Description
$fieldFilters

translationList(
          
          )
        
        :
          void

static

translationStringList(
          
          )
        
        :
          void

static

unserialize(
           $package,  $domNode,  $options,  $ownerID
              =
              false,  $handlerType
              =
              'ezcontentobject'
          )
        
        :
          void

static

Parameters

Name	Type	Description
$package
$domNode
$options
$ownerID
$handlerType

updateObjectList(
           $parameters
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::updateObjectList()

Parameters

Name	Type	Description
$parameters

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

Parameters

Name	Type	Description
$contentObjectAttributes
$attributeDataBaseName
$inputParameters
$parameters

version(
           $version,  $asObject
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$version
$asObject

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

Parameters

Name	Type	Description
$version
$lang

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

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

Parameters

Name	Type	Description
$asObject	boolean
$parameters	array

Returns

Type	Description
array

kernel/classes/ezcontentobject.php

\eZContentObjectjump to top

Constants

Properties

Methods

\eZContentObject
jump to top