Content object attributes reference #

$node.object and $object (in content_view_gui templates and in the results of fetch( 'content', 'object' )) are eZContentObject objects (kernel/classes/ezcontentobject.php). The attributes a template can read are the fields (columns of the ezcontentobject table) and the function_attributes of eZContentObject::definition().

Contents #

1. How this table was made
2. Database fields
3. Function attributes
4. A sample
5. Notes
6. Related pages

How this table was made #

The same read-only script as for the node attributes: definition() listed, every name read with $object->attribute( $name ) on the object of node 96 (object 94, an ng_article), as the anonymous user of the site siteaccess.

Database fields #

Function attributes #

name and remote_id are in both lists; the function attributes (name(), remoteID()) are the ones a template reads. name() returns the name in the object's current language, the field Name the name stored on the object.

A sample #

{def $object = fetch( 'content', 'node', hash( 'node_id', 96 ) ).object}
id / class:          {$object.id} / {$object.class_identifier} ({$object.contentclass_id})
section:             {$object.section_id} ({$object.section_identifier})
published:           {$object.published|datetime( 'custom', '%Y-%m-%d' )}
current version:     {$object.current_version}
language:            {$object.current_language}, available: {$object.available_languages|implode( ', ' )}
states:              {$object.state_identifier_array|implode( ', ' )}
main node:           {$object.main_node_id}, locations: {$object.assigned_nodes|count}
related objects:     {$object.related_contentobject_count}, reverse related: {$object.reverse_related_contentobject_count}
owner is a user:     {cond( $object.owner.class_identifier|eq( 'user' ), 'yes', 'no' )}

Output:

id / class:          94 / ng_article (44)
section:             1 (standard)
published:           2018-07-23
current version:     1
language:            eng-US, available: eng-US
states:              ez_lock/not_locked, help_status/draft
main node:           96, locations: 1
related objects:     0, reverse related: 0
owner is a user:     yes

Notes #

• Relations. related_contentobject_array returns the objects this object relates to (all relation types: relatedContentObjectList() calls relatedObjects() without a type filter); linked_contentobject_array only the objects linked from rich text, embedded_contentobject_array only the ones embedded in it. The reverse_* variants return the objects that point at this one. Each reads the database when it is read.
• Versions. current is the published version object, current_version its number, versions every version. Reading versions loads them all; use it in the admin, not on a site page.
• Locations. main_node and main_node_id give the main location, assigned_nodes every location, visible_nodes the visible ones, parent_nodes the node IDs of the parents.
• Grouped data map. grouped_data_map groups the attributes by their class attribute category (the "Category" of a class attribute, such as content and meta); the code notes that the result is not cached.
• States. state_id_array maps each state group ID to the object's state ID, state_identifier_array gives group/state identifiers such as ez_lock/not_locked.
• Permissions. can_edit, can_remove, can_translate, can_create_class_list and the other can_* attributes check the current user's policies, and can_create_languages / can_edit_languages the languages the user may use.
• match_ingroup_id_list is false unless content.ini [ContentOverrideSettings] EnableClassGroupOverride=true; then it is the class group IDs, which the class_group override condition uses.
• author_array returns eZUser objects of every user who created a version of the object.

Related pages #

• The object model in templates
• Node attributes reference
• Content attribute and version reference
• Data map and content
• Content view gui
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.