Path

ez.no / documentation / ez publish / technical manual / 3.6 / reference / objects / ezcontentobject


Caution: This documentation is for eZ Publish legacy, from version 3.x to 5.x.
For 5.x documentation covering Platform see eZ Documentation Center, for difference between legacy and Platform see 5.x Architecture overview.

ezcontentobject

Summary

Contains information about a content object.

Persistent

Yes.

Attributes

Attribute

Type

Description

id

string

The ID number of the object.

section_id

string

The ID number of the section that the object belongs to.

owner_id

string

The ID number of the object representing the user who initially created the object.

contentclass_id

string

The ID number of the content class which the object is an instance of.

name

string

The actual name of the object (for example "Liver sandwitch").

is_published

string

Either 1 or 0. 1 means that the object has been published. 0 means that the object has not yet been published.

published

string

A UNIX timestamp pinpointing the exact date/time when the object was published for the first time.

modified

string

A UNIX timestamp pinpointing the exact date/time when the object was last modified.

current_version

string

The number of the currently published version.

status

string

The status of the object (0=Draft, 1=Published, 2=Archived).

remote_id

string

A global unique ID for the object. The remote ID is an MD5 hash of the time when the object was created plus a random value. Remote IDs are used in order to avoid collisions of identical objects during an import.

current

object

The current version (as ezcontentobjectversion) of the object.

versions

array

The object's versions (as ezcontentobjectversion objects).

author_array

array

Array of ezuser objects representing the different creators of the content object's versions.

class_name

string

The name of the class which the content object is an instance of (for example "Consumer product").

content_class

object

The content class (as ezcontentclass) which the content object is an instance of.

contentobject_attributes

array

Array of ezcontentobjectattribute objects representing the attributes of the content object.

owner

object

An ezcontentobject that represents the user who initially created the object.

related_contentobject_array

array

An array of ezcontentobject objects that are related to this object. This attribute is deprecated. It is recommended to use the " related_objects" fetch function instead.

related_contentobject_count

string

The number of objects that are related to this object. This attribute is deprecated. It is recommended to use the " related_objects_count" fetch function instead.

reverse_related_contentobject_array

array

An array of ezcontentobject objects that make use of this object (reverse relations). This attribute is deprecated. It is recommended to use the " reverse_related_objects" fetch function instead.

reverse_related_contentobject_count

string

The number of objects that are using this object. This attribute is deprecated. It is recommended to use the " reverse_related_objects_count" fetch function instead.

can_read

boolean

Returns TRUE if the current user has read access to the object, FALSE otherwise.

can_edit

boolean

Returns TRUE if the current user has edit access to the object, FALSE otherwise.

can_translate

boolean

Returns TRUE if the current user has permissions to translate the contents of the object, FALSE otherwise.

can_move_from

boolean

Returns TRUE if the current user has permissions to move the main node of the object, FALSE otherwise.

can_remove

boolean

Returns TRUE if the current user has permissions to remove the object, FALSE otherwise.

data_map

array

Array of ezcontentobjectattribute objects representing the actual attributes of the content object.

main_parent_node_id

string

The ID number of the main node of the object encapsulated by the parent node.

assigned_nodes

array

Array of nodes (as ezcontentobjecttreenode objects) that encapsulate the object.

parent_nodes

array

An array of ID numbers of the parent nodes (as strings).

main_node_id

string

The ID number of the object's main node.

main_node

object

The object's main node (as ezcontentobjecttreenode).

default_language

string

The default language of the object (for example "eng-GB").

content_action_list

array

An array of hashes revealing information about the content actions that can be performed on the object. The keys "name" and "action" contain the actual name (for example "Add to basket" - which should be value of the HTML input tag) and the action itself (for example "ActionAddToBasket" - which should be the name of the HTML input tag). The array is generated by a function that examines the object's attributes. If a datatype used to represent an attribute provides support for content actions or if the attribute is an information collector, the supported actions will be added to the "content_action_list" array. This array can be used to automatically generate action buttons (standard HTML buttons) for content objects that either make use of special datatypes or have attributes that are marked as information collectors.

class_identifier

string

The identifier of the class which the object is an instance of (for example "consumer_product").

class_group_id_list

array

An array of ID numbers of the class groups which the class (that the object is an instance of) belongs to.

match_ingroup_id_list

array

The ID numbers of the class groups that the class (which the object is an instance of) belongs to. This variable is connected with a feature that makes it possible to create template overrides based on class groups.

By default the "match_ingroup_id_list" always returns a boolean FALSE value because the class group override feature is turned off. It can be turned on by setting the "EnableClassGroupOverride" directive in the [ContentOverrideSettings] block of a configuration override for "content.ini" to "true".

Balazs Halasy (22/02/2005 8:41 am)

Julia Shymova (17/09/2007 12:16 pm)

Balazs Halasy, Svitlana Shatokhina, Julia Shymova


Comments

There are no comments.