kernel/classes/ezcontentclassattribute.php

Show:

inherited

Classes
- \eZContentClassAttribute

Table of Contents

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

\eZContentClassAttribute
jump to top

Package: kernel

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

Properties


                 $Content= ''

Details

Type: n/a


                 $ContentClassID= ''

Details

Type: n/a


                 $DataTypeString= ''

Details

Type: n/a


                 $DescriptionList= ''

Details

Type: n/a


                 $DisplayInfo= ''

Details

Type: n/a


                 $EditLocale= 'false'

Default valuefalseDetails

Type: n/a


                 $ID= ''

Details

Type: n/a


                 $Identifier= ''

Details

Type: n/a


                 $IsInformationCollector= ''

Details

Type: n/a


                 $IsRequired= ''

Details

Type: n/a


                 $IsSearchable= ''

Details

Type: n/a


                 $Module= ''

Details

Type: n/a


                 $NameList= ''

Details

Type: n/a


                 $PersistentDataDirty= ''

inheritedInherited from: \eZPersistentObject::$$PersistentDataDirty

Details

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


                 $Position= ''

Details

Type: n/a


                 $SerializedNameList= ''

Details

Type: n/a


                 $Version= ''

Details

Type: n/a


                 $identifierHash= 'null'

static

In-memory cache for class attributes identifiers / id matching

Default valuenullDetails

Type: n/a

Methods

__clone(
          
          )
        
        :
          void

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

inherited

Inherited from: \eZPersistentObject::attribute()

Parameters

Name	Type	Description
$attr
$noFunction

attributes(
          
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::attributes()

cachedInfo(
          
          )
        
        :
          void

static

classAttributeIDByIdentifier(
           $identifier
          )
        
        :
          int | false

static

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

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

Parameters

Name	Type	Description
$identifier

Returns

Type	Description
int \| false	Returns classattributeid or false

Details

Since: Version 4.1
Static

classAttributeIdentifierByID(
           $id
          )
        
        :
          string | false

static

Resolves the numeric class attribute identifier $id to its string value

Parameters

Name	Type	Description
$id

Returns

Type	Description
string \| false	Returns classattributeidentifier or false

Details

Since: Version 4.1
Static

classAttributeIdentifiersHash(
          
          )
        
        :
          array

static

Returns the class attribute 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 classattributeidentifier => classattributeid

Details

Access: protected
Since: Version 4.1
Static

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

content(
          
          )
        
        :
          void

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

staticinherited

Inherited from: \eZPersistentObject::count()

Parameters

Name	Type	Description
$def
$conds
$field

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

static

Parameters

Name	Type	Description
$class_id
$data_type_string
$optionalValues
$languageLocale

currentModule(
          
          )
        
        :
          void

customHTTPAction(
           $module,  $http,  $action
          )
        
        :
          void

Parameters

Name	Type	Description
$module
$http
$action

dataTextI18n(
          string | false $languageLocale
              =
              false
          )
        
        :
          string

Returns data_text_i18n of attribute based on serialized_data_text

Parameters

Name	Type	Description
$languageLocale	string \| false	Uses AlwaysAvailable language if false

Returns

Type	Description
string

dataTextI18nList(
          
          )
        
        :
          array

Returns data_text_i18n list for all locales for attribute

Returns

Type	Description
array

dataType(
          
          )
        
        :
          void

dataTypeByID(
           $classAttributeID
          )
        
        :
          void

static

Parameters

Name	Type	Description
$classAttributeID

definition(
          
          )
        
        :
          void

static

description(
          string | false $languageLocale
              =
              false
          )
        
        :
          string

Returns description of attribute based on serialized_description_list

Parameters

Name	Type	Description
$languageLocale	string \| false	Uses AlwaysAvailable language if false

Returns

Type	Description
string

descriptionList(
          
          )
        
        :
          array

Returns description list for all locales for attribute

Returns

Type	Description
array

diff(
           $old,  $new
          )
        
        :
          void

Parameters

Name	Type	Description
$old
$new

displayInfo(
          
          )
        
        :
          void

eZContentClassAttribute(
           $row
          )
        
        :
          void

Parameters

Name	Type	Description
$row

eZPersistentObject(
           $row
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::eZPersistentObject()

Parameters

Name	Type	Description
$row

editLocale(
          
          )
        
        :
          string | false

Returns locale code as set with {@link self::setEditLocale()}

Returns

Type	Description
string \| false

escapeArray(
           $array
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::escapeArray()

Parameters

Name	Type	Description
$array

expireCache(
          int $contentClassAttributeID
              =
              false, int $contentClassID
              =
              false
          )
        
        :
          void

static

Clears all content class attribute related caches

Parameters

Name	Type	Description
$contentClassAttributeID	int	Specific attribute ID to clear cache for
$contentClassID	int	Specific attribute ID to clear cache for

Details

Since: 4.2

fetch(
           $id,  $asObject
              =
              true,  $version
              =
              eZContentClass::VERSION_STATUS_DEFINED,  $field_filters
              =
              null
          )
        
        :
          void

static

Parameters

Name	Type	Description
$id
$asObject
$version
$field_filters

fetchFilteredList(
           $cond,  $asObject
              =
              true
          )
        
        :
          void

static

Parameters

Name	Type	Description
$cond
$asObject

fetchList(
           $asObject
              =
              true,  $parameters
              =
              array()
          )
        
        :
          void

static

Parameters

Name	Type	Description
$asObject
$parameters

fetchListByClassID(
           $classID,  $version
              =
              eZContentClass::VERSION_STATUS_DEFINED,  $asObject
              =
              true
          )
        
        :
          void

static

Parameters

Name	Type	Description
$classID
$version
$asObject

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

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()

initializeObjectAttributes(
          mixed $objects
              =
              null
          )
        
        :
          void

Initialize the attribute in the existing objects.

Parameters

Name	Type	Description
$objects	mixed	not used, the existing objects are fetched if necessary (depending on the datatype of the attribute).

instantiate(
           $contentobjectID,  $languageCode
              =
              false,  $version
              =
              1
          )
        
        :
          void

Parameters

Name	Type	Description
$contentobjectID
$languageCode
$version

instantiateTemporary(
           $contentobjectID
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$contentobjectID

move(
           $down,  $params
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$down
$params

name(
          string | false $languageLocale
              =
              false
          )
        
        :
          string

Returns name of attribute based on serialized_name_list

Parameters

Name	Type	Description
$languageLocale	string \| false	Uses AlwaysAvailable language if false

Returns

Type	Description
string

nameFromSerializedString(
          string $serializedNameList, string | false $languageLocale
              =
              false
          )
        
        :
          string

static

Returns name from serialized string, can be used for serialized description and data_text as well.

Parameters

Name	Type	Description
$serializedNameList	string
$languageLocale	string \| false	Uses AlwaysAvailable language if false

Returns

Type	Description
string

nameList(
          
          )
        
        :
          array

Returns name list for all locales for attribute

Returns

Type	Description
array

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

staticinherited

Inherited from: \eZPersistentObject::newObjectOrder()

Parameters

Name	Type	Description
$def
$orderField
$conditions

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

inherited

Inherited from: \eZPersistentObject::remove()

Parameters

Name	Type	Description
$conditions
$extraConditions

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

staticinherited

Inherited from: \eZPersistentObject::removeObject()

Parameters

Name	Type	Description
$def
$conditions
$extraConditions

removeThis(
           $quiet
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$quiet

removeTranslation(
          string $languageLocale
          )
        
        :
          void

Removes an translation (as in the serilized strings for name, description or data_text_i18n)

Parameters

Name	Type	Description
$languageLocale	string

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

setAlwaysAvailableLanguage(
          string | false $languageLocale
          )
        
        :
          void

Specify AlwaysAvailableLanguage (for name, description or data_text_i18n)

Parameters

Name	Type	Description
$languageLocale	string \| false

setAttribute(
           $attr,  $val
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::setAttribute()

Parameters

Name	Type	Description
$attr
$val

setContent(
           $content
          )
        
        :
          void

Parameters

Name	Type	Description
$content

setDataTextI18n(
          string $string, string | false $languageLocale
              =
              false
          )
        
        :
          string

Sets data_text_i18n of attribute, store() will take care of writing back to serialized_data_text

Parameters

Name	Type	Description
$string	string
$languageLocale	string \| false	Uses AlwaysAvailable language if false

Returns

Type	Description
string	Return old value

setDescription(
          string $description, string | false $languageLocale
              =
              false
          )
        
        :
          string

Sets description of attribute, store() will take care of writing back to serialized_description_list

Parameters

Name	Type	Description
$description	string
$languageLocale	string \| false	Uses AlwaysAvailable language if false

Returns

Type	Description
string	Return old value

setEditLocale(
          string | false $languageLocale
              =
              false
          )
        
        :
          void

Sets locale code of attribute for use by datatypes in class/edit storing process.

Parameters

Name	Type	Description
$languageLocale	string \| false	Uses AlwaysAvailable language if false

setHasDirtyData(
           $hasDirtyData
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::setHasDirtyData()

Parameters

Name	Type	Description
$hasDirtyData

setName(
          string $name, string | false $languageLocale
              =
              false
          )
        
        :
          string

Sets name of attribute, store() will take care of writing back to serialized_name_list

Parameters

Name	Type	Description
$name	string
$languageLocale	string \| false	Uses AlwaysAvailable language if false

Returns

Type	Description
string	Return old value

sortKeyTypeByID(
           $classAttributeID
          )
        
        :
          void

static

Parameters

Name	Type	Description
$classAttributeID

store(
           $fieldFilters
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$fieldFilters

storeDefined(
          
          )
        
        :
          null | false

Store the content class in the version status "defined".

Returns

Type	Description
null \| false	false if the operation failed

Details

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.

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

staticinherited

Inherited from: \eZPersistentObject::storeObject()

Parameters

Name	Type	Description
$obj
$fieldFilters

storeVersioned(
          int $version
          )
        
        :
          null | false

Store the content class in the specified version status.

Parameters

Name	Type	Description
$version	int	version status

Returns

Type	Description
null \| false	false if the operation failed

Details

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

inherited

Inherited from: \eZPersistentObject::sync()

Parameters

Name	Type	Description
$fieldFilters

updateObjectList(
           $parameters
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::updateObjectList()

Parameters

Name	Type	Description
$parameters

kernel/classes/ezcontentclassattribute.php

\eZContentClassAttributejump to top

Properties

Methods

\eZContentClassAttribute
jump to top