eZPublish  3.8
eZContentClassAttribute Class Reference

Encapsulates data for a class attribute. More...

+ Inheritance diagram for eZContentClassAttribute:
+ Collaboration diagram for eZContentClassAttribute:

Public Member Functions

 cachedInfo ()
 
 clone ()
 
content ()
 
 create ($class_id, $data_type_string, $optionalValues=array())
 
currentModule ()
 
 customHTTPAction (&$module, &$http, $action)
 
dataType ()
 
 definition ()
 
 diff ($old, $new)
 
displayInfo ()
 
 eZContentClassAttribute ($row)
 
fetch ($id, $asObject=true, $version=EZ_CLASS_VERSION_STATUS_DEFINED, $field_filters=null)
 
fetchFilteredList ($cond, $asObject=true)
 
fetchList ($asObject=true, $parameters=array())
 
fetchListByClassID ($classID, $version=EZ_CLASS_VERSION_STATUS_DEFINED, $asObject=true)
 
 instantiate ($contentobjectID, $languageCode=false, $version=1)
 
instantiateTemporary ($contentobjectID=false)
 
 move ($down, $params=null)
 
 remove ($quiet=false)
 
 setContent ($content)
 
 store ()
 
 storeDefined ()
 
- Public Member Functions inherited from eZPersistentObject
attribute ($attr, $noFunction=false)
 
 attributes ()
 
 conditionText (&$conditions)
 
conditionTextByRow (&$conditions, &$row)
 
 definition ()
 
escapeArray (&$array)
 
 eZPersistentObject ($row)
 
 fetchObject (&$def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 
 fetchObjectList (&$def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null)
 
 fill (&$row)
 
 getShortAttributeName (&$db, &$def, $attrName)
 
 handleRows (&$rows, $class_name, $asObject)
 
 hasAttribute ($attr)
 
 hasDirtyData ()
 
 newObjectOrder (&$def, $orderField, $conditions)
 
 remove ($conditions=null, $extraConditions=null)
 
 removeObject (&$def, $conditions=null, $extraConditions=null)
 
 reorderObject (&$def, $orderField, $conditions, $down=true)
 
 setAttribute ($attr, $val)
 
 setHasDirtyData ($hasDirtyData)
 
 store ($fieldFilters=null)
 
 swapRow ($table, &$keys, &$order_id, &$rows, $id1, $id2)
 
 sync ($fieldFilters=null)
 
 updateObjectList ($parameters)
 

Static Public Member Functions

 dataTypeByID ($classAttributeID)
 
 sortKeyTypeByID ($classAttributeID)
 

Private Attributes

 $Content
 Contains the content for this attribute. More...
 
 $ContentClassID
 
 $DataTypeString
 
 $DisplayInfo
 Contains information on how to display the current attribute in various viewmodes. More...
 
 $ID
 
 $Identifier
 
 $IsInformationCollector
 
 $IsRequired
 
 $IsSearchable
 
 $Module
 
 $Name
 
 $Position
 
 $Version
 

Detailed Description

Encapsulates data for a class attribute.

Member Function Documentation

eZContentClassAttribute::cachedInfo ( )

Referenced by dataTypeByID(), and sortKeyTypeByID().

eZContentClassAttribute::clone ( )
& eZContentClassAttribute::content ( )
Returns
The content for this attribute.
Note
The reference for the return value is required to workaround a bug with PHP references.
eZContentClassAttribute::create (   $class_id,
  $data_type_string,
  $optionalValues = array() 
)
& eZContentClassAttribute::currentModule ( )
Returns
the module which uses this attribute or null if no module set.
Note
Currently only customHTTPAction sets this.
eZContentClassAttribute::customHTTPAction ( $module,
$http,
  $action 
)

Executes the custom HTTP action

& eZContentClassAttribute::dataType ( )
eZContentClassAttribute::dataTypeByID (   $classAttributeID)
static
eZContentClassAttribute::diff (   $old,
  $new 
)

This methods relay calls to the diff method inside the datatype.

& eZContentClassAttribute::displayInfo ( )
Returns
Information on how to display the class attribute. See eZDataType::classDisplayInformation() for more information on what is returned.
eZContentClassAttribute::eZContentClassAttribute (   $row)

Referenced by clone(), and create().

& eZContentClassAttribute::fetchFilteredList (   $cond,
  $asObject = true 
)
& eZContentClassAttribute::fetchList (   $asObject = true,
  $parameters = array() 
)
& eZContentClassAttribute::fetchListByClassID (   $classID,
  $version = EZ_CLASS_VERSION_STATUS_DEFINED,
  $asObject = true 
)
eZContentClassAttribute::instantiate (   $contentobjectID,
  $languageCode = false,
  $version = 1 
)
& eZContentClassAttribute::instantiateTemporary (   $contentobjectID = false)
Note
The reference for the return value is required to workaround a bug with PHP references.
eZContentClassAttribute::move (   $down,
  $params = null 
)

Moves the object down if $down is true, otherwise up. If object is at either top or bottom it is wrapped around.

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.
eZContentClassAttribute::remove (   $quiet = false)
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.
eZContentClassAttribute::setContent (   $content)

Sets the content for the current attribute

eZContentClassAttribute::sortKeyTypeByID (   $classAttributeID)
static
eZContentClassAttribute::store ( )
eZContentClassAttribute::storeDefined ( )
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.

Member Data Documentation

eZContentClassAttribute::$Content
private

Contains the content for this attribute.

Referenced by content().

eZContentClassAttribute::$ContentClassID
private

Referenced by move().

eZContentClassAttribute::$DataTypeString
private
eZContentClassAttribute::$DisplayInfo
private

Contains information on how to display the current attribute in various viewmodes.

Referenced by displayInfo().

eZContentClassAttribute::$ID
private
eZContentClassAttribute::$Identifier
private
eZContentClassAttribute::$IsInformationCollector
private
eZContentClassAttribute::$IsRequired
private
eZContentClassAttribute::$IsSearchable
private
eZContentClassAttribute::$Module
private

Referenced by currentModule().

eZContentClassAttribute::$Name
private
eZContentClassAttribute::$Position
private

Referenced by move().

eZContentClassAttribute::$Version
private

Referenced by move().


The documentation for this class was generated from the following file: