ezcontentobjectattribute

Summary

Contains information about an attribute of a content object.

Persistent

Yes.

Attributes

Attribute

Type

Static*

Description

id

string

Yes.

The ID number of the attribute.

contentobject_id

string

Yes.

The ID number of the content object that the attribute belongs to.

version

string

Yes.

The version number of the content object that the attribute belongs to.

language_code

string

Yes.

The code of the translation that the attribute belongs to (for example "eng-GB").

language_id

string

Yes.

The ID number of the translation language plus 1 if this is the language is initial/main and the object is always available.

contentclassattribute_id

string

Yes.

The ID number of the attribute.

attribute_original_id

string

Yes.

The original ID of the attribute.

sort_key_int

string

Yes.

Integer used for sorting.

sort_key_string

string

Yes.

Text used for sorting.

data_type_string

string

Yes.

The identifier string of the datatype (for example "ezstring").

data_text

string

Yes.

Text stored by the attribute.

data_int

string

Yes.

Integer stored by the attribute.

data_float

string

Yes.

Float stored by the attribute.

contentclass_attribute

object

No.

The class attribute (as an ezcontentclassattribute object).

contentclass_attribute_identifier

string

No.

The identifier of the content class attribute (for example "first_name").

contentclass_attribute_name

string

No.

The name of the content class attribute.

can_translate

string

No.

1 if the attribute is translatable, 0 if not.

is_information_collector

string

No.

1 if the attribute is an information collector, 0 if not.

is_required

string

No.

1 if the attribute is required, 0 if not.

content

any

No.

The actual content (what is returned when the ".content" notation is used).

has_http_value

boolean

No.

TRUE if the attribute has an HTTP value, FALSE otherwise.

value

any

No.

The HTTP input from the user (if submitted) or the contents of the object
attribute from the database (same as the "content" attribute).

has_content

boolean

No.

TRUE if there is attribute contains content, FALSE if it is empty.

class_content

any

No.

The content of the class attribute which this object attribute is made from (same as ".contentclass_attribute.content").

object

object

No.

The object that the attribute belongs to (as an ezcontentobject object).

object_version

object

No.

The version that the attribute belongs to (as an ezcontentobjectversion object).

view_template

string

No.

The name of the template that is used to display the view interface for the attribute (for example "ezstring").

edit_template

string

No.

The name of the template that is used to display the edit interface for the attribute (for example "ezstring").

result_template

string

No.

The name of the template that is used to display the information that was collected by the attribute (for example "ezstring").

has_validation_error

boolean

No.

TRUE if a validation error was detected, FALSE if everything is okay.

validation_error

NULL

No.

The validation error(s), NULL if none.

validation_log

NULL

No.

A log of the validation error(s), NULL if none.

language

object

No.

The original translation (as ezcontentobjectattribute object) of this content object
attribute (it may just be the same object).

is_a

string

No.

Returns the identifier of the datatype that is used to represent the attribute (for example "ezstring").

display_info

array

No.

An array containing information about how the attribute should be displayed in different scenarios (for example if the information should be grouped, etc.).

class_display_info

array

No.

An array containing information about how the attribute should be displayed on the class level.

* Indicates whether the attribute provides a pre-fetched value or if it needs to be computed upon request.

Powered by eZ Publish™ CMS Open Source Web Content Management. Copyright © 1999-2013 eZ Systems AS (except where otherwise noted). All rights reserved.