Manual

SDK

 
   

API Reference
 

Sections

Todo

eZContentObjectAttribute Class Reference
[Kernel system]

Encapsulates the data for an object attribute. More...

Inheritance diagram for eZContentObjectAttribute:

eZPersistentObject List of all members.

Public Methods

& definition ()
 storeNewRow ()
& attribute ($attr)
& contentClassAttribute ()
 setContentClassAttributeIdentifier ($identifier)
& contentClassAttributeIdentifier ()
 validateInput (&$http,$base)
 fixupInput (&$http,$base)
 fetchInput (&$http,$base)
 customHTTPAction (&$http,$action,$parameters=array())
 initialize ($currentVersion=null,$originalContentObjectAttribute=null)
& remove ($id,$currentVersion=null)
& clone ($newVersionNumber,$currentVersionNumber,$contentObjectID=false)
& dataType ()
 title ()
 content ()
 metaData ()
 setContent ($content)
& contentActionList ()
& viewTemplateName ()
& editTemplateName ()
& viewTemplate ()
& editTemplate ()
& informationTemplate ()

Public Attributes

 Content
 Contains the content for this attribute.

 IsValid
 Stores the is valid.

 ValidationError
 Contains the last validation error.

 ValidationLog
 Contains the last validation error.

Detailed Description

Encapsulates the data for an object attribute.

See also:
eZContentClassAttribute

Definition at line ezcontentobjectattribute.php.

Member Function Documentation

& eZContentObjectAttribute::attribute (  $    attr ) 
 

Returns:
the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched.

Reimplemented from eZPersistentObject.

Definition at line ezcontentobjectattribute.php.

References viewTemplateName().

Referenced by content().

& eZContentObjectAttribute::clone (  $    newVersionNumber,
$    currentVersionNumber,
$    contentObjectID = false
) 
 

Clones the attribute with new version $newVersionNumber and old version $currentVersionNumber.

Note:
The cloned attribute is not stored.

Definition at line ezcontentobjectattribute.php.

eZContentObjectAttribute::content (    ) 
 

Returns the content for this attribute.

Definition at line ezcontentobjectattribute.php.

References dataType().

Referenced by setContent().

& eZContentObjectAttribute::contentActionList (    ) 
 

Returns the content action(s) for this attribute

Definition at line ezcontentobjectattribute.php.

References dataType().

& eZContentObjectAttribute::contentClassAttribute (    ) 
 

Returns the attribute for the current data attribute instance

Definition at line ezcontentobjectattribute.php.

Referenced by viewTemplateName().

& eZContentObjectAttribute::contentClassAttributeIdentifier (    ) 
 

Returns:
the idenfifier for the content class attribute

Definition at line ezcontentobjectattribute.php.

Referenced by attribute().

eZContentObjectAttribute::customHTTPAction (  &$    http,
$    action,
$    parameters = array()
) 
 

Executes the custom HTTP action

Definition at line ezcontentobjectattribute.php.

References dataType().

& eZContentObjectAttribute::dataType (    ) 
 

Returns the data type class for the current attribute.

Definition at line ezcontentobjectattribute.php.

References dataType().

Referenced by viewTemplate().

& eZContentObjectAttribute::definition (    ) 
 

Returns:
the definition for the object, the default implementation is to return an empty array. It's upto each inheriting class to return a proper definition array.
The definition array is an associative array consists of these keys:
  • fields - an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
  • keys - an array of fields which is used for uniquely identifying the object in the table.
  • function_attributes - an associative array of attributes which maps to member functions, used for fetching data with functions.
  • set_functions - an associative array of attributes which maps to member functions, used for setting data with functions.
  • increment_key - the field which is incremented on table inserts.
  • class_name - the classname which is used for instantiating new objecs when fetching from the database.
  • sort - an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either asc or desc.
  • name - the name of the database table
Example: 
function definition()
{
    return array( "fields" => array( "id" => "ID",
                                     "version" => "Version",
                                     "name" => "Name" ),
                  "keys" => array( "id", "version" ),
                  "function_attributes" => array( "current" => "currentVersion",
                                                  "class_name" => "className" ),
                  "increment_key" => "id",
                  "class_name" => "eZContentClass",
                  "sort" => array( "id" => "asc" ),
                  "name" => "ezcontentclass" );
}

Reimplemented from eZPersistentObject.

Definition at line ezcontentobjectattribute.php.

References viewTemplateName().

Referenced by validateInput().

& eZContentObjectAttribute::editTemplate (    ) 
 

Returns:
the template name to use for editing the attribute.
Note:
The returned template name does not include the .tpl extension.
See also:
viewTemplate, informationTemplate

Definition at line ezcontentobjectattribute.php.

References dataType().

Referenced by editTemplateName().

& eZContentObjectAttribute::editTemplateName (    ) 
 

Returns:
the template name to use for editing the attribute.

Definition at line ezcontentobjectattribute.php.

References editTemplate().

Referenced by definition().

eZContentObjectAttribute::fetchInput (  &$    http,
$    base
) 
 

Fetches the data from http post vars and sets them correctly.

Definition at line ezcontentobjectattribute.php.

References dataType().

eZContentObjectAttribute::fixupInput (  &$    http,
$    base
) 
 

Tries to fixup the input text to be acceptable. �

Definition at line ezcontentobjectattribute.php.

References definition().

& eZContentObjectAttribute::informationTemplate (    ) 
 

Returns:
the template name to use for information collection for the attribute.
Note:
The returned template name does not include the .tpl extension.
See also:
viewTemplate, editTemplate

Definition at line ezcontentobjectattribute.php.

References dataType().

Referenced by viewTemplateName().

eZContentObjectAttribute::initialize (  $    currentVersion = null,
$    originalContentObjectAttribute = null
) 
 

Initialized the attribute by using the datatype.

Definition at line ezcontentobjectattribute.php.

References dataType().

eZContentObjectAttribute::metaData (    ) 
 

Returns the metadata. This is the pure content of the attribute used for indexing data for search engines.

Definition at line ezcontentobjectattribute.php.

References dataType().

& eZContentObjectAttribute::remove (  $    id,
$    currentVersion = null
) 
 

Remove the attribute by using the datatype.

Reimplemented from eZPersistentObject.

Definition at line ezcontentobjectattribute.php.

References eZPersistentObject::removeObject().

eZContentObjectAttribute::setContent (  $    content ) 
 

Sets the content for the current attribute

Definition at line ezcontentobjectattribute.php.

References content().

eZContentObjectAttribute::setContentClassAttributeIdentifier (  $    identifier ) 
 

Sets the cached content class attribute identifier

Definition at line ezcontentobjectattribute.php.

eZContentObjectAttribute::storeNewRow (    ) 
 

Store one row into content attribute table

Definition at line ezcontentobjectattribute.php.

References eZPersistentObject::store().

eZContentObjectAttribute::title (    ) 
 

Fetches the title of the data instance which is to form the title of the object.

Definition at line ezcontentobjectattribute.php.

References definition().

eZContentObjectAttribute::validateInput (  &$    http,
$    base
) 
 

Validates the data contents, returns true on success false if the data does not validate. �

Definition at line ezcontentobjectattribute.php.

References IsValid.

& eZContentObjectAttribute::viewTemplate (    ) 
 

Returns:
the template name to use for viewing the attribute.
Note:
The returned template name does not include the .tpl extension.
See also:
editTemplate, informationTemplate

Definition at line ezcontentobjectattribute.php.

References dataType().

Referenced by viewTemplateName().

& eZContentObjectAttribute::viewTemplateName (    ) 
 

Returns:
the template name to use for viewing the attribute or if the attribute is an information collector the information template name is returned.
Note:
The returned template name does not include the .tpl extension.
See also:
editTemplate, informationTemplate

Definition at line ezcontentobjectattribute.php.

References viewTemplate().

Referenced by definition().

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

Exponential