kernel/classes/ezcontentobjectattribute.php
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

$PersistentDataDirty= ''
inheritedInherited from:
\eZPersistentObject::$$PersistentDataDirty
Details
- Type
- n/a
- Inherited_from
- \eZPersistentObject::$$PersistentDataDirty
Methods

attribute(
$attr, $noFunction
=
false
)
:
void
inherited
Inherited from:
\eZPersistentObject::attribute()
Parameters
| Name | Type | Description |
|---|---|---|
| $attr | ||
| $noFunction |

cloneContentObjectAttribute(
int $newVersionNumber, $currentVersionNumber, int $contentObjectID
=
false, string $newLanguageCode
=
false
)
:
\eZContentObjectAttributeClones the attribute to a new version
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $newVersionNumber | int | Target version number |
| $currentVersionNumber | ||
| $contentObjectID | int | |
| $newLanguageCode | string |
| Type | Description |
|---|---|
| \eZContentObjectAttribute | The cloned attribute |
- Note
- The cloned attribute isn't stored automatically
- Todo
- Deprecate this in favor of a real __clone

collectInformation(
$collection, $collectionAttribute, $http, $base
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $collection | ||
| $collectionAttribute | ||
| $http | ||
| $base |

count(
$def, $conds
=
null, $field
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $conds | ||
| $field |

create(
$contentclassAttributeID, $contentobjectID, $version
=
1, $languageCode
=
false
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $contentclassAttributeID | ||
| $contentobjectID | ||
| $version | ||
| $languageCode |

customHTTPAction(
$http, $action, $parameters
=
array()
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $http | ||
| $action | ||
| $parameters |

eZPersistentObject(
$row
)
:
void
inherited
Inherited from:
\eZPersistentObject::eZPersistentObject()
Parameters
| Name | Type | Description |
|---|---|---|
| $row |

fetch(
$id, $version, $asObject
=
true, $field_filters
=
null
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $id | ||
| $version | ||
| $asObject | ||
| $field_filters |

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

fetchByIdentifier(
$identifier, $asObject
=
true
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $identifier | ||
| $asObject |

fetchListByClassID(
$id, $version
=
false, $limit
=
null, $asObject
=
true, $asCount
=
false
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $id | ||
| $version | ||
| $limit | ||
| $asObject | ||
| $asCount |

fetchObject(
$def, $field_filters, $conds, $asObject
=
true, $grouping
=
null, $custom_fields
=
null
)
:
void
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
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $field_filters | ||
| $conds | ||
| $sorts | ||
| $limit | ||
| $asObject | ||
| $grouping | ||
| $custom_fields | ||
| $custom_tables | ||
| $custom_conds |

fetchSameClassAttributeIDList(
$contentClassAttributeID, $asObject
=
true, $version
=
false, $contentObjectID
=
false
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $contentClassAttributeID | ||
| $asObject | ||
| $version | ||
| $contentObjectID |

fill(
$row
)
:
void
inherited
Inherited from:
\eZPersistentObject::fill()
Parameters
| Name | Type | Description |
|---|---|---|
| $row |

generateValidationErrorText(
$numargs, $argList
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $numargs | ||
| $argList |

getShortAttributeName(
$db, $def, $attrName
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $db | ||
| $def | ||
| $attrName |

handleCustomHTTPActions(
$http, $attributeDataBaseName, $customActionAttributeArray, $customActionParameters
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $http | ||
| $attributeDataBaseName | ||
| $customActionAttributeArray | ||
| $customActionParameters |

handleDownload(
$object, $objectVersion, $objectLanguage
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $object | ||
| $objectVersion | ||
| $objectLanguage |

handleRows(
$rows, $class_name, $asObject
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $rows | ||
| $class_name | ||
| $asObject |

hasAttribute(
$attr
)
:
void
inherited
Inherited from:
\eZPersistentObject::hasAttribute()
Parameters
| Name | Type | Description |
|---|---|---|
| $attr |

hasStoredFileInformation(
$object, $objectVersion, $objectLanguage
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $object | ||
| $objectVersion | ||
| $objectLanguage |

initialize(
int $currentVersion
=
null, \eZContentObjectAttribute $originalContentObjectAttribute
=
null
)
:
voidInitializes 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 |

insertHTTPFile(
$object, $objectVersion, $objectLanguage, $httpFile, $mimeData, $result
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $object | ||
| $objectVersion | ||
| $objectLanguage | ||
| $httpFile | ||
| $mimeData | ||
| $result |

insertRegularFile(
$object, $objectVersion, $objectLanguage, $filePath, $result
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $object | ||
| $objectVersion | ||
| $objectLanguage | ||
| $filePath | ||
| $result |

insertSimpleString(
$object, $objectVersion, $objectLanguage, $string, $result
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $object | ||
| $objectVersion | ||
| $objectLanguage | ||
| $string | ||
| $result |

language(
$languageCode
=
false, $asObject
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $languageCode | ||
| $asObject |

newObjectOrder(
$def, $orderField, $conditions
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $orderField | ||
| $conditions |

postInitialize(
$currentVersion
=
null, $originalContentObjectAttribute
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $currentVersion | ||
| $originalContentObjectAttribute |

remove(
$conditions
=
null, $extraConditions
=
null
)
:
void
inherited
Inherited from:
\eZPersistentObject::remove()
Parameters
| Name | Type | Description |
|---|---|---|
| $conditions | ||
| $extraConditions |

removeObject(
$def, $conditions
=
null, $extraConditions
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $conditions | ||
| $extraConditions |

removeThis(
$id, $currentVersion
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $id | ||
| $currentVersion |

reorderObject(
$def, $orderField, $conditions, $down
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $orderField | ||
| $conditions | ||
| $down |

replaceFieldsWithShortNames(
$db, $fieldDefs, $fields
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $db | ||
| $fieldDefs | ||
| $fields |

setAttribute(
$attr, $val
)
:
void
inherited
Inherited from:
\eZPersistentObject::setAttribute()
Parameters
| Name | Type | Description |
|---|---|---|
| $attr | ||
| $val |

setContentClassAttributeCanTranslate(
$canTranslate
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $canTranslate |

setContentClassAttributeIdentifier(
$identifier
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $identifier |

setHasDirtyData(
$hasDirtyData
)
:
void
inherited
Inherited from:
\eZPersistentObject::setHasDirtyData()
Parameters
| Name | Type | Description |
|---|---|---|
| $hasDirtyData |

storeObject(
$obj, $fieldFilters
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $obj | ||
| $fieldFilters |

storedFileInformation(
$object, $objectVersion, $objectLanguage
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $object | ||
| $objectVersion | ||
| $objectLanguage |

swapRow(
$table, $keys, $order_id, $rows, $id1, $id2
)
:
void
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 |

translateTo(
$languageCode, $updateLanguageMask
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $languageCode | ||
| $updateLanguageMask |

unserialize(
$package, $attributeDOMNode
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $package | ||
| $attributeDOMNode |

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

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