kernel/classes/ezcontentobjectattribute.php

Show: inherited
Table of Contents

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

\eZContentObjectAttribute

Package: kernel

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

Propertypublic  $Content= ''
Details
Type
n/a
Propertypublic  $ContentClassAttributeCanTranslate= ''
Details
Type
n/a
Propertypublic  $ContentClassAttributeID= ''
Details
Type
n/a
Propertypublic  $ContentClassAttributeIdentifier= ''
Details
Type
n/a
Propertypublic  $ContentClassAttributeIsInformationCollector= ''
Details
Type
n/a
Propertypublic  $ContentClassAttributeIsRequired= ''
Details
Type
n/a
Propertypublic  $ContentClassAttributeName= ''
Details
Type
n/a
Propertypublic  $DisplayInfo= ''
Details
Type
n/a
Propertypublic  $HTTPValue= ''
Details
Type
n/a
Propertypublic  $IsValid= ''
Details
Type
n/a
Propertypublic  $PersistentDataDirty= ''
Details
Type
n/a
Inherited_from
\eZPersistentObject::$$PersistentDataDirty  
Propertypublic  $ValidationError= ''
Details
Type
n/a
Propertypublic  $ValidationLog= ''
Details
Type
n/a

Methods

methodpublicattribute(  $attr,  $noFunction = false ) : void
inherited

Inherited from: \eZPersistentObject::attribute()
Parameters
Name Type Description
$attr
$noFunction
methodpublicattributes( ) : void
inherited

Inherited from: \eZPersistentObject::attributes()
methodpublicclassContent( ) : void

methodpublicclassDisplayInfo( ) : void

methodpubliccloneContentObjectAttribute( int $newVersionNumber,  $currentVersionNumber, int $contentObjectID = false, string $newLanguageCode = false ) : \eZContentObjectAttribute

Clones the attribute to a new version

Parameters
Name Type Description
$newVersionNumber int

Target version number

$currentVersionNumber
$contentObjectID int
$newLanguageCode string
Returns
Type Description
\eZContentObjectAttribute The cloned attribute
Details
Note
The cloned attribute isn't stored automatically  
Todo
Deprecate this in favor of a real __clone  
methodpubliccollectInformation(  $collection,  $collectionAttribute,  $http,  $base ) : void

Parameters
Name Type Description
$collection
$collectionAttribute
$http
$base
methodpublicconditionText(  $conditions ) : void
staticinherited

Inherited from: \eZPersistentObject::conditionText()
Parameters
Name Type Description
$conditions
methodpublicconditionTextByRow(  $conditions,  $row ) : void
staticinherited

Inherited from: \eZPersistentObject::conditionTextByRow()
Parameters
Name Type Description
$conditions
$row
methodpubliccontent( ) : void

methodpubliccontentActionList( ) : void

methodpubliccontentClassAttribute( ) : void

methodpubliccontentClassAttributeCanTranslate( ) : void

methodpubliccontentClassAttributeIdentifier( ) : void

methodpubliccontentClassAttributeIsInformationCollector( ) : void

methodpubliccontentClassAttributeIsRequired( ) : void

methodpubliccontentClassAttributeName( ) : void

methodpubliccount(  $def,  $conds = null,  $field = null ) : void
staticinherited

Inherited from: \eZPersistentObject::count()
Parameters
Name Type Description
$def
$conds
$field
methodpubliccreate(  $contentclassAttributeID,  $contentobjectID,  $version = 1,  $languageCode = false ) : void
static

Parameters
Name Type Description
$contentclassAttributeID
$contentobjectID
$version
$languageCode
methodpubliccustomHTTPAction(  $http,  $action,  $parameters = array() ) : void

Parameters
Name Type Description
$http
$action
$parameters
methodpublicdataType( ) : void

methodpublicdefinition( ) : void
static

methodpublicdisplayInfo( ) : void

methodpubliceZContentObjectAttribute(  $row ) : void

Parameters
Name Type Description
$row
methodpubliceZPersistentObject(  $row ) : void
inherited

Inherited from: \eZPersistentObject::eZPersistentObject()
Parameters
Name Type Description
$row
methodpubliceditTemplate( ) : void

methodpubliceditTemplateName( ) : void

methodpublicescapeArray(  $array ) : void
staticinherited

Inherited from: \eZPersistentObject::escapeArray()
Parameters
Name Type Description
$array
methodpublicfetch(  $id,  $version,  $asObject = true,  $field_filters = null ) : void
static

Parameters
Name Type Description
$id
$version
$asObject
$field_filters
methodpublicfetchAttributeTranslations(  $asObject = true ) : void

Parameters
Name Type Description
$asObject
methodpublicfetchByClassAttributeID(  $classAttributeID,  $objectID,  $version,  $languageID,  $asObject = true ) : void
static

Parameters
Name Type Description
$classAttributeID
$objectID
$version
$languageID
$asObject
methodpublicfetchByIdentifier(  $identifier,  $asObject = true ) : void
static

Parameters
Name Type Description
$identifier
$asObject
methodpublicfetchInput(  $http,  $base ) : void

Parameters
Name Type Description
$http
$base
methodpublicfetchListByClassID(  $id,  $version = false,  $limit = null,  $asObject = true,  $asCount = false ) : void
static

Parameters
Name Type Description
$id
$version
$limit
$asObject
$asCount
methodpublicfetchObject(  $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
methodpublicfetchObjectList(  $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
methodpublicfetchSameClassAttributeIDList(  $contentClassAttributeID,  $asObject = true,  $version = false,  $contentObjectID = false ) : void
static

Parameters
Name Type Description
$contentClassAttributeID
$asObject
$version
$contentObjectID
methodpublicfill(  $row ) : void
inherited

Inherited from: \eZPersistentObject::fill()
Parameters
Name Type Description
$row
methodpublicfixupInput(  $http,  $base ) : void

Parameters
Name Type Description
$http
$base
methodpublicfromString(  $string ) : void

Parameters
Name Type Description
$string
methodpublicgenerateValidationErrorText(  $numargs,  $argList ) : void
static

Parameters
Name Type Description
$numargs
$argList
methodpublicgetShortAttributeName(  $db,  $def,  $attrName ) : void
staticinherited

Inherited from: \eZPersistentObject::getShortAttributeName()
Parameters
Name Type Description
$db
$def
$attrName
methodpublichandleCustomHTTPActions(  $http,  $attributeDataBaseName,  $customActionAttributeArray,  $customActionParameters ) : void

Parameters
Name Type Description
$http
$attributeDataBaseName
$customActionAttributeArray
$customActionParameters
methodpublichandleDownload(  $object,  $objectVersion,  $objectLanguage ) : void

Parameters
Name Type Description
$object
$objectVersion
$objectLanguage
methodpublichandleRows(  $rows,  $class_name,  $asObject ) : void
staticinherited

Inherited from: \eZPersistentObject::handleRows()
Parameters
Name Type Description
$rows
$class_name
$asObject
methodpublichasAttribute(  $attr ) : void
inherited

Inherited from: \eZPersistentObject::hasAttribute()
Parameters
Name Type Description
$attr
methodpublichasContent( ) : void

methodpublichasDirtyData( ) : void
inherited

Inherited from: \eZPersistentObject::hasDirtyData()
methodpublichasHTTPValue( ) : void

methodpublichasStoredFileInformation(  $object,  $objectVersion,  $objectLanguage ) : void

Parameters
Name Type Description
$object
$objectVersion
$objectLanguage
methodpublichasValidationError( ) : void

methodpublicinformationTemplate( ) : void

methodpublicinitialize( int $currentVersion = null, \eZContentObjectAttribute $originalContentObjectAttribute = null ) : void

Initializes the attribute by using the datatype

Parameters
Name Type Description
$currentVersion int

Current version number

$originalContentObjectAttribute \eZContentObjectAttribute

Optional eZContentObjectAttribute the content will be initialized from

methodpublicinputParameters( ) : void

methodpublicinsertHTTPFile(  $object,  $objectVersion,  $objectLanguage,  $httpFile,  $mimeData,  $result ) : void

Parameters
Name Type Description
$object
$objectVersion
$objectLanguage
$httpFile
$mimeData
$result
methodpublicinsertRegularFile(  $object,  $objectVersion,  $objectLanguage,  $filePath,  $result ) : void

Parameters
Name Type Description
$object
$objectVersion
$objectLanguage
$filePath
$result
methodpublicinsertSimpleString(  $object,  $objectVersion,  $objectLanguage,  $string,  $result ) : void

Parameters
Name Type Description
$object
$objectVersion
$objectLanguage
$string
$result
methodpublicisA( ) : void

methodpubliclanguage(  $languageCode = false,  $asObject = true ) : void

Parameters
Name Type Description
$languageCode
$asObject
methodpublicmetaData( ) : void

methodpublicmetaDataArray(  $attributes ) : void
static

Parameters
Name Type Description
$attributes
methodpublicnewObjectOrder(  $def,  $orderField,  $conditions ) : void
staticinherited

Inherited from: \eZPersistentObject::newObjectOrder()
Parameters
Name Type Description
$def
$orderField
$conditions
methodpublicobject( ) : void

methodpublicobjectVersion( ) : void

methodpubliconPublish(  $object,  $nodes ) : void

Parameters
Name Type Description
$object
$nodes
methodpublicpostInitialize(  $currentVersion = null,  $originalContentObjectAttribute = null ) : void

Parameters
Name Type Description
$currentVersion
$originalContentObjectAttribute
methodpublicpostUnserialize(  $package ) : void

Parameters
Name Type Description
$package
methodpublicremove(  $conditions = null,  $extraConditions = null ) : void
inherited

Inherited from: \eZPersistentObject::remove()
Parameters
Name Type Description
$conditions
$extraConditions
methodpublicremoveObject(  $def,  $conditions = null,  $extraConditions = null ) : void
staticinherited

Inherited from: \eZPersistentObject::removeObject()
Parameters
Name Type Description
$def
$conditions
$extraConditions
methodpublicremoveThis(  $id,  $currentVersion = null ) : void

Parameters
Name Type Description
$id
$currentVersion
methodpublicreorderObject(  $def,  $orderField,  $conditions,  $down = true ) : void
staticinherited

Inherited from: \eZPersistentObject::reorderObject()
Parameters
Name Type Description
$def
$orderField
$conditions
$down
methodpublicreplaceFieldsWithShortNames(  $db,  $fieldDefs,  $fields ) : void
staticinherited

Inherited from: \eZPersistentObject::replaceFieldsWithShortNames()
Parameters
Name Type Description
$db
$fieldDefs
$fields
methodpublicresultTemplate( ) : void

methodpublicserialize(  $package ) : void

Parameters
Name Type Description
$package
methodpublicsetAttribute(  $attr,  $val ) : void
inherited

Inherited from: \eZPersistentObject::setAttribute()
Parameters
Name Type Description
$attr
$val
methodpublicsetContent(  $content ) : void

Parameters
Name Type Description
$content
methodpublicsetContentClassAttributeCanTranslate(  $canTranslate ) : void

Parameters
Name Type Description
$canTranslate
methodpublicsetContentClassAttributeIdentifier(  $identifier ) : void

Parameters
Name Type Description
$identifier
methodpublicsetContentClassAttributeName(  $name ) : void

Parameters
Name Type Description
$name
methodpublicsetHTTPValue(  $value ) : void

Parameters
Name Type Description
$value
methodpublicsetHasDirtyData(  $hasDirtyData ) : void
inherited

Inherited from: \eZPersistentObject::setHasDirtyData()
Parameters
Name Type Description
$hasDirtyData
methodpublicsetHasValidationError(  $hasError = true ) : void

Parameters
Name Type Description
$hasError
methodpublicsetInputParameters(  $parameters ) : void

Parameters
Name Type Description
$parameters
methodpublicsetValidationError( ) : void

methodpublicsetValidationLog(  $text ) : void

Parameters
Name Type Description
$text
methodpublicsetValidationParameters(  $parameters ) : void

Parameters
Name Type Description
$parameters
methodpublicstore(  $fieldFilters = null ) : void

Parameters
Name Type Description
$fieldFilters
methodpublicstoreData( ) : void

methodpublicstoreNewRow( ) : void

methodpublicstoreObject(  $obj,  $fieldFilters = null ) : void
staticinherited

Inherited from: \eZPersistentObject::storeObject()
Parameters
Name Type Description
$obj
$fieldFilters
methodpublicstoredFileInformation(  $object,  $objectVersion,  $objectLanguage ) : void

Parameters
Name Type Description
$object
$objectVersion
$objectLanguage
methodpublicswapRow(  $table,  $keys,  $order_id,  $rows,  $id1,  $id2 ) : void
staticinherited

Inherited from: \eZPersistentObject::swapRow()
Parameters
Name Type Description
$table
$keys
$order_id
$rows
$id1
$id2
methodpublicsync(  $fieldFilters = null ) : void
inherited

Inherited from: \eZPersistentObject::sync()
Parameters
Name Type Description
$fieldFilters
methodpublictitle( ) : void

methodpublictoString( ) : void

methodpublictranslateTo(  $languageCode,  $updateLanguageMask = true ) : void

Parameters
Name Type Description
$languageCode
$updateLanguageMask
methodpublicunserialize(  $package,  $attributeDOMNode ) : void

Parameters
Name Type Description
$package
$attributeDOMNode
methodpublicunsetInputParameters( ) : void

methodpublicunsetValidationParameters( ) : void

methodpublicupdateObjectList(  $parameters ) : void
staticinherited

Inherited from: \eZPersistentObject::updateObjectList()
Parameters
Name Type Description
$parameters
methodpublicupdateSortKey(  $storeData = true ) : void

Parameters
Name Type Description
$storeData
methodpublicvalidateAddToBasket(  $data,  $errors ) : void

Parameters
Name Type Description
$data
$errors
methodpublicvalidateInformation(  $http,  $base,  $inputParameters,  $validationParameters = array() ) : void

Parameters
Name Type Description
$http
$base
$inputParameters
$validationParameters
methodpublicvalidateInput(  $http,  $base,  $inputParameters,  $validationParameters = array() ) : void

Parameters
Name Type Description
$http
$base
$inputParameters
$validationParameters
methodpublicvalidateIsRequired( ) : void

methodpublicvalidationError( ) : void

methodpublicvalidationLog( ) : void

methodpublicvalidationParameters( ) : void

methodpublicvalue( ) : void

methodpublicviewTemplate( ) : void

methodpublicviewTemplateName( ) : void

Documentation was generated by DocBlox 0.18.1.