Help center

Path

7x / documentation / exponential / 3.6 / technical manual 3.6 / reference / objects / ezcontentobjecttreenode

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

Table of contents

ezcontentobjecttreenode

Summary

Contains information about a node within the content node tree.

Persistent

Yes.

Attributes

Attribute Type Description
node_id string The ID number of the node.
parent_node_id string The ID number of the parent node.
main_node_id string The ID number of the main node.
contentobject_id string The ID number of the content object.
contentobject_version string The number of the published version.
contentobject_is_published string The published status of the object (0=not published, 1=published).
depth string The depth of the node within the content node tree. The depth of a top level node is 1.
sort_field string The sorting method used to sort the child nodes.
sort_order string The sorting order used when sorting the node's children.
priority string The node's priority (positive or negative integer).
modified_subnode string A UNIX timestamp pinpointing the exact time a sub node was changed.
path_string string The node's path string (for example "/1/2/44").
path_identification_string string The node's path identification string (for example "company/about_us").
remote_id string A unique ID for the node (avoids crashes when importing/exporting nodes). A remote ID is an MD5 hash of the time when the node was generated plus a random value.
is_hidden string The node's hidden status (0=visible, 1=hidden).
is_invisible string The node's visibility status (0=visible, 1=hidden by superior).
name string The name of the object the node encapsulates (for example "My article").
data_map array The object's attributes as ezcontentobjectattribute objects.
object object The actual content object (as ezcontentobject) that the node encapsulates.
subtree array All the nodes that are below this node as ezcontentobjecttreenode objects.
children array Array of nodes that are directly below this node as ezcontentobjecttreenode objects.
children_count string The number of nodes that are directly below this node.
contentobject_version_object object The current version (as ezcontentobjectversion) of the object that the node encapsulates.
sort_array array The node's sort array.
can_read boolean Returns TRUE if the current user has read access to the node (FALSE otherwise).
can_create boolean Returns TRUE if the current user can create nodes under this node (FALSE otherwise).
can_edit boolean Returns TRUE if the current user has edit access to the node (FALSE otherwise).
can_hide boolean Returns TRUE if the current user can modify the hidden state of the node (FALSE otherwise).
can_remove boolean Returns TRUE if the current user can remove the node (FALSE otherwise).
can_move boolean Returns TRUE if the current user can move the node to another location (FALSE otherwise).
can_move_from boolean Same as "can_move", returns TRUE if the current user has permissions to move node, FALSE otherwise.
creator object The object (as ezcontentobject) containing the user who created the node.
path array Array containing the nodes that make up the path as ezcontentobjecttreenode objects. The current node is not included.
path_array array Array of strings revealing the ID numbers of the nodes that make up the path. The current node is also included.
parent object The parent node (as ezcontentobjecttreenode).
url string The URL of the node either as a virtual URL ("company/about_us") or a system URL ("content/view/full/13") depending on a configuration setting.
url_alias string The virtual URL of the node ("company/about_us").
class_identifier string The identifier of the class which the object encapsulated by the node is an instance of (for example "product_review").
class_name string The name of the class which the object encapsulated by the node is an instance of (for example "Product review").
hidden_invisible_string string The visibility status of a node ("-/-" = completely visible, "H/X" = hidden by user and thus invisible, "-/X" = hidden by superior).
hidden_status_string string The visibility status of the node: "Visible", "Hidden" or "Hidden by superior".

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

Balazs Halasy (01/04/2007 2:30 pm)

Balazs Halasy

No ratings yet

Comments

There are no comments.