kernel/classes/ezcontentclass.php

Show:

inherited

Classes
- \eZContentClass

Table of Contents

File containing the eZContentClass 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

\eZContentClass
jump to top

Package: kernel

File containing the eZContentClass 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

 
                VERSION_STATUS_DEFINED
                = 0

 
                VERSION_STATUS_TEMPORARY
                = 1

 
                VERSION_STATUS_MODIFIED
                = 2

int 
                CONTENT_OBJECT_NAME_MAX_LENGTH
                = 255

Max length of content object name.

: int

Properties


                 $AllGroups= ''

Details

Type: n/a


                 $CanInstantiateLanguages= ''

Details

Type: n/a


                 $ContentObjectName= ''

Details

Type: n/a


                 $Created= ''

Details

Type: n/a


                 $CreatorID= ''

Details

Type: n/a


                 $DescriptionList= ''

Details

Type: n/a


                 $ID= ''

Details

Type: n/a


                 $Identifier= ''

Details

Type: n/a


                 $InGroups= ''

Details

Type: n/a


                 $IsContainer= ''

Details

Type: n/a


                 $LanguageMask= ''

Details

Type: n/a


                 $Modified= ''

Details

Type: n/a


                 $ModifierID= ''

Details

Type: n/a


                 $NameList= ''

Details

Type: n/a


                 $PersistentDataDirty= ''

inheritedInherited from: \eZPersistentObject::$$PersistentDataDirty

Details

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


                 $SerializedNameList= ''

Details

Type: n/a


                 $Version= ''

Details

Type: n/a


                 $VersionCount= ''

Details

Type: n/a


                 $identifierHash= 'null'

static

In-memory cache for class identifiers / id matching

Default valuenullDetails

Type: n/a

Methods

__clone(
          
          )
        
        :
          void

adjustAttributePlacements(
           $attributes
          )
        
        :
          void

Parameters

Name	Type	Description
$attributes

alwaysAvailableLanguage(
          
          )
        
        :
          void

alwaysAvailableLanguageLocale(
          
          )
        
        :
          void

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

inherited

Inherited from: \eZPersistentObject::attribute()

Parameters

Name	Type	Description
$attr
$noFunction

attributes(
          
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::attributes()

buildContentObjectName(
           $contentObjectName,  $dataMap,  $tmpTags
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$contentObjectName
$dataMap
$tmpTags

canCreateLanguages(
          
          )
        
        :
          void

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

static

Parameters

Name	Type	Description
$asObject
$includeFilter
$groupList
$fetchID

canInstantiateClasses(
          
          )
        
        :
          void

canInstantiateLanguages(
          
          )
        
        :
          void

classIDByIdentifier(
          string | array $identifier
          )
        
        :
          int | false

static

Resolves the string class identifier $identifier to its numeric value Use {@link eZContentObjectTreeNode::classIDByIdentifier()} for < 4.1.

If multiple classes have the same identifier, the first found is returned.

Parameters

Name	Type	Description
$identifier	string \| array	identifier string or array of identifiers (array support added in 4.1.1)

Returns

Type	Description
int \| false	Returns classid or false

Details

Since: Version 4.1
Static

classIdentifierByID(
           $id
          )
        
        :
          string | false

static

Resolves the numeric class identifier $id to its string value

Parameters

Name	Type	Description
$id

Returns

Type	Description
string \| false	Returns classidentifier or false

Details

Since: Version 4.1
Static

classIdentifiersHash(
          
          )
        
        :
          array

static

Returns the class identifier hash for the current database.

If it is outdated or non-existent, the method updates/generates the file

Returns

Type	Description
array	Returns hash of classidentifier => classid

Details

Access: protected
Since: Version 4.1
Static

clearAlwaysAvailableLanguageID(
          
          )
        
        :
          void

compareAttributes(
           $attr1,  $attr2
          )
        
        :
          void

Parameters

Name	Type	Description
$attr1
$attr2

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

contentObjectName(
          \eZContentObject $contentObject, int | false $version
              =
              false, string | false $translation
              =
              false
          )
        
        :
          string

Will generate a name for the content object based on the class settings for content object limited by self::CONTENT_OBJECT_NAME_MAX_LENGTH.

Parameters

Name	Type	Description
$contentObject	\eZContentObject
$version	int \| false
$translation	string \| false

Returns

Type	Description
string

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

staticinherited

Inherited from: \eZPersistentObject::count()

Parameters

Name	Type	Description
$def
$conds
$field

create(
           $userID
              =
              false,  $optionalValues
              =
              array(),  $languageLocale
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$userID
$optionalValues
$languageLocale

creator(
          
          )
        
        :
          void

dataMap(
          
          )
        
        :
          void

definition(
          
          )
        
        :
          void

static

description(
           $languageLocale
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$languageLocale

descriptionFromSerializedString(
           $serializedDescriptionList
          )
        
        :
          void

static

Parameters

Name	Type	Description
$serializedDescriptionList

descriptionList(
          
          )
        
        :
          void

eZContentClass(
           $row
          )
        
        :
          void

Parameters

Name	Type	Description
$row

eZPersistentObject(
           $row
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::eZPersistentObject()

Parameters

Name	Type	Description
$row

escapeArray(
           $array
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::escapeArray()

Parameters

Name	Type	Description
$array

exists(
           $id,  $version
              =
              eZContentClass::VERSION_STATUS_DEFINED,  $userID
              =
              false,  $useIdentifier
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$id
$version
$userID
$useIdentifier

expireCache(
          
          )
        
        :
          void

static

Expires in-memory cache for eZContentClass.

Clears cache for fetched eZContentClass objects, class identifiers and class attributes.

Details

Since: 4.2

fetch(
           $id,  $asObject
              =
              true,  $version
              =
              eZContentClass::VERSION_STATUS_DEFINED,  $user_id
              =
              false,  $parent_id
              =
              null
          )
        
        :
          void

static

Parameters

Name	Type	Description
$id
$asObject
$version
$user_id
$parent_id

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

static

Parameters

Name	Type	Description
$asObject
$includeFilter
$groupList

fetchAllGroups(
          
          )
        
        :
          void

fetchAttributeByIdentifier(
           $identifier,  $asObject
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$identifier
$asObject

fetchAttributes(
           $id
              =
              false,  $asObject
              =
              true,  $version
              =
              eZContentClass::VERSION_STATUS_DEFINED
          )
        
        :
          void

Parameters

Name	Type	Description
$id
$asObject
$version

fetchByIdentifier(
           $identifier,  $asObject
              =
              true,  $version
              =
              eZContentClass::VERSION_STATUS_DEFINED,  $user_id
              =
              false,  $parent_id
              =
              null
          )
        
        :
          void

static

Parameters

Name	Type	Description
$identifier
$asObject
$version
$user_id
$parent_id

fetchByRemoteID(
           $remoteID,  $asObject
              =
              true,  $version
              =
              eZContentClass::VERSION_STATUS_DEFINED,  $user_id
              =
              false,  $parent_id
              =
              null
          )
        
        :
          void

static

Parameters

Name	Type	Description
$remoteID
$asObject
$version
$user_id
$parent_id

fetchGroupIDList(
          
          )
        
        :
          void

fetchGroupList(
          
          )
        
        :
          void

fetchIDListContainingDatatype(
           $dataTypeString
          )
        
        :
          void

static

Parameters

Name	Type	Description
$dataTypeString

fetchList(
           $version
              =
              eZContentClass::VERSION_STATUS_DEFINED,  $asObject
              =
              true,  $user_id
              =
              false,  $sorts
              =
              null,  $fields
              =
              null,  $classFilter
              =
              false,  $limit
              =
              null
          )
        
        :
          void

static

Parameters

Name	Type	Description
$version
$asObject
$user_id
$sorts
$fields
$classFilter
$limit

fetchMatchGroupIDList(
          
          )
        
        :
          void

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

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

fetchSearchableAttributes(
           $id
              =
              false,  $asObject
              =
              true,  $version
              =
              eZContentClass::VERSION_STATUS_DEFINED
          )
        
        :
          void

Parameters

Name	Type	Description
$id
$asObject
$version

fill(
           $row
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::fill()

Parameters

Name	Type	Description
$row

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

staticinherited

Inherited from: \eZPersistentObject::getShortAttributeName()

Parameters

Name	Type	Description
$db
$def
$attrName

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

hasDirtyData(
          
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::hasDirtyData()

hasNameInLanguage(
           $languageLocale
          )
        
        :
          void

Parameters

Name	Type	Description
$languageLocale

inGroup(
           $groupID
          )
        
        :
          void

Parameters

Name	Type	Description
$groupID

initializeCopy(
           $originalClass
          )
        
        :
          void

Parameters

Name	Type	Description
$originalClass

instantiate(
           $userID
              =
              false,  $sectionID
              =
              0,  $versionNumber
              =
              false,  $languageCode
              =
              false,  $versionStatus
              =
              eZContentObjectVersion::STATUS_INTERNAL_DRAFT
          )
        
        :
          void

Parameters

Name	Type	Description
$userID
$sectionID
$versionNumber
$languageCode
$versionStatus

instantiateIn(
           $lang,  $userID
              =
              false,  $sectionID
              =
              0,  $versionNumber
              =
              false,  $versionStatus
              =
              eZContentObjectVersion::STATUS_INTERNAL_DRAFT
          )
        
        :
          void

Parameters

Name	Type	Description
$lang
$userID
$sectionID
$versionNumber
$versionStatus

isRemovable(
          
          )
        
        :
          void

languages(
          
          )
        
        :
          void

modifier(
          
          )
        
        :
          void

name(
           $languageLocale
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$languageLocale

nameFromSerializedString(
           $serializedNameList
          )
        
        :
          void

static

Parameters

Name	Type	Description
$serializedNameList

nameList(
          
          )
        
        :
          void

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

staticinherited

Inherited from: \eZPersistentObject::newObjectOrder()

Parameters

Name	Type	Description
$def
$orderField
$conditions

objectCount(
          
          )
        
        :
          void

objectList(
          
          )
        
        :
          void

prioritizedLanguages(
          
          )
        
        :
          void

prioritizedLanguagesJsArray(
          
          )
        
        :
          void

remoteID(
          
          )
        
        :
          void

removableInformation(
           $includeAll
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$includeAll

remove(
           $removeAttributes
              =
              false,  $version
              =
              eZContentClass::VERSION_STATUS_DEFINED
          )
        
        :
          void

Parameters

Name	Type	Description
$removeAttributes
$version

removeAttributes(
           $removeAttributes
              =
              false,  $version
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$removeAttributes
$version

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

staticinherited

Inherited from: \eZPersistentObject::removeObject()

Parameters

Name	Type	Description
$def
$conditions
$extraConditions

removeTemporary(
          
          )
        
        :
          void

static

removeTranslation(
           $languageID
          )
        
        :
          void

Parameters

Name	Type	Description
$languageID

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

setAlwaysAvailableLanguageID(
           $languageID,  $updateChilds
              =
              true
          )
        
        :
          void

Parameters

Name	Type	Description
$languageID
$updateChilds

setAttribute(
           $attr,  $val
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::setAttribute()

Parameters

Name	Type	Description
$attr
$val

setCanInstantiateLanguages(
           $languageCodes
          )
        
        :
          void

Parameters

Name	Type	Description
$languageCodes

setDescription(
           $description,  $languageLocale
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$description
$languageLocale

setHasDirtyData(
           $hasDirtyData
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::setHasDirtyData()

Parameters

Name	Type	Description
$hasDirtyData

setName(
           $name,  $languageLocale
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$languageLocale

setVersion(
           $version,  $set_childs
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$version
$set_childs

store(
           $store_childs
              =
              false,  $fieldFilters
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$store_childs
$fieldFilters

storeDefined(
          array $attributes
          )
        
        :
          void

Stores the current class as a defined version, updates the contentobject_name attribute and recreates the class group entries.

Parameters

Name	Type	Description
$attributes	array	array of attributes of the content class

Details

Note: It will remove any existing temporary or defined classes before storing.

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

staticinherited

Inherited from: \eZPersistentObject::storeObject()

Parameters

Name	Type	Description
$obj
$fieldFilters

storeVersioned(
          array $attributes, int $version
          )
        
        :
          void

Stores the current class as a modified version, updates the contentobject_name attribute and recreates the class group entries.

Parameters

Name	Type	Description
$attributes	array	array of attributes
$version	int	version status

Details

Note: It will remove classes in the previous and specified version before storing.
Since: Version 4.3

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

Parameters

Name	Type	Description
$fieldFilters

topPriorityLanguageLocale(
          
          )
        
        :
          void

updateObjectList(
           $parameters
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::updateObjectList()

Parameters

Name	Type	Description
$parameters

urlAliasName(
          \eZContentObject $contentObject, int | false $version
              =
              false, string | false $translation
              =
              false
          )
        
        :
          string

Will generate a name for the url alias based on the class settings for content object limited by site.ini\[URLTranslator]\UrlAliasNameLimit

Parameters

Name	Type	Description
$contentObject	\eZContentObject
$version	int \| false
$translation	string \| false

Returns

Type	Description
string

versionCount(
          
          )
        
        :
          void

versionHistoryLimit(
          mixed $class
          )
        
        :
          int

static

Computes the version history limit for a content class

Parameters

Name	Type	Description
$class	mixed	Content class ID, content class identifier or content class object

Returns

Type	Description
int

Details

Since: 4.2

versionStatus(
          
          )
        
        :
          void

kernel/classes/ezcontentclass.php

\eZContentClassjump to top

Constants

Properties

Methods

\eZContentClass
jump to top