ezcontentobjecttreenode

Written by Balazs Halasy, 02/22/2005 Updated 11/05/2026 by Graham Brookins Maintainers: Balazs Halasy, Svitlana Shatokhina, Julia Shymova

Summary

Contains information about a node within the content node tree.

Persistent

Yes.

Attributes

Attribute	Type	Static*	Description
node_id	string	Yes.	The ID number of the node.
parent_node_id	string	Yes.	The ID number of the parent node.
main_node_id	string	Yes.	The ID number of the main node.
contentobject_id	string	Yes.	The ID number of the content object.
contentobject_version	string	Yes.	The number of the published version.
contentobject_is_published	string	Yes.	The published status of the object (0=not published, 1=published).
depth	string	Yes.	The depth of the node within the content node tree. The depth of a top level node is 1.
sort_field	string	Yes.	The sorting method used to sort the child nodes.
sort_order	string	Yes.	The sorting order used when sorting the node's children.
priority	string	Yes.	The node's priority (positive or negative integer).
modified_subnode	string	Yes.	A UNIX timestamp pinpointing the exact time a sub node was changed.
path_string	string	Yes.	The node's path string (for example "/1/2/44").
path_identification_string	string	Yes.	The node's path identification string in the initial/main language (for example "company/about_us").
remote_id	string	Yes.	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	Yes.	The node's hidden status (0=visible, 1=hidden).
is_invisible	string	Yes.	The node's visibility status (0=visible, 1=hidden by superior).
name	string	No.	The name of the object the node encapsulates (for example "My article").
data_map	array	No.	The object's attributes as ezcontentobjectattribute objects.
object	object	No.	The actual content object (as ezcontentobject) that the node encapsulates.
subtree	array	No.	All the nodes that are below this node as ezcontentobjecttreenode objects.
children	array	No.	Array of nodes that are directly below this node as ezcontentobjecttreenode objects.
children_count	string	No.	The number of nodes that are directly below this node.
view_count	integer	No.	The number of times the node has been viewed.
contentobject_version_object	object	No.	The current version (as ezcontentobjectversion) of the object that the node encapsulates.
sort_array	array	No.	The node's sort array.
can_read	boolean	No.	Returns TRUE if the current user has read access to the node (FALSE otherwise).
can_pdf	boolean	No.	Not documented yet.
can_create	boolean	No.	Returns TRUE if the current user can create nodes under this node (FALSE otherwise).
can_edit	boolean	No.	Returns TRUE if the current user has edit access to the node (FALSE otherwise).
can_hide	boolean	No.	Returns TRUE if the current user can modify the hidden state of the node (FALSE otherwise).
can_remove	boolean	No.	Returns TRUE if the current user can remove the node (FALSE otherwise).
can_move	boolean	No.	Returns TRUE if the current user can move the node to another location (FALSE otherwise).
can_move_from	boolean	No.	Same as "can_move", returns TRUE if the current user has permissions to move node, FALSE otherwise.
can_add_location	boolean	No.	Not documented yet.
can_remove_location	boolean	No.	Not documented yet.
can_view_embed	boolean	No.	Not documented yet.
is_main	boolean	No.	Not documented yet.
creator	object	No.	The object (as ezcontentobject) containing the user who created the node.
path	array	No.	Array containing the nodes that make up the path as ezcontentobjecttreenode objects. The current node is not included.
path_array	array	No.	Array of strings revealing the ID numbers of the nodes that make up the path. The current node is also included.
parent	object	No.	The parent node (as ezcontentobjecttreenode).
url	string	No.	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	No.	The virtual URL of the node in the current language (which is determined according to the list of prioritized languages), for example "company/about_us".
class_identifier	string	No.	The identifier of the class which the object encapsulated by the node is an instance of (for example "product_review").
class_name	string	No.	The name of the class which the object encapsulated by the node is an instance of (for example "Product review").
hidden_invisible_string	string	No.	The visibility status of a node ("-/-" = completely visible, "H/X" = hidden by user and thus invisible, "-/X" = hidden by superior).
hidden_status_string	string	No.	The visibility status of the node: "Visible", "Hidden" or "Hidden by superior".

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

Changed in Exponential 6.0.15

The attributes of ezcontentobjecttreenode as eZContentObjectTreeNode::definition() of Exponential 6.0.15 gives them (kernel/classes/ezcontentobjecttreenode.php):

Attribute	Change
path_with_names	An attribute in 6.0.15 (function attribute); this page did not list it.
classes_js_array	An attribute in 6.0.15 (function attribute); this page did not list it.
is_container	An attribute in 6.0.15 (function attribute); this page did not list it.

Contributors

Balazs Halasy Author 02/22/2005 Maintainer
Julia Shymova Maintainer
Svitlana Shatokhina Maintainer
zurgutt Commenter 02/11/2007
Pike Commenter 04/08/2009
Graham Brookins Updated 11/05/2026

Comments (3 historical)

Written by readers of the earlier documentation sites, kept as they were.

view_count is not working by default

zurgutt · 02/11/2007 01:43 pm

view_count apparently needs extra magick to work. Either by analyzing apache log in cronjob http://ez.no/doc/ez_publish/techn.../the_cronjob_scripts#updateviewcount
or if you want live updating this code from advancedforums extension (svn) could be helpful:
count.php

$Module =& $Params['Module'];

if ( $Params[ 'NodeID' ] )
{
        include_once( "kernel/classes/ezviewcounter.php");
        $counter = eZViewCounter::fetch( $Params[ 'NodeID' ] );
        if ( !is_object( $counter ) )
        {
                $counter = eZViewCounter::create( $Params[ 'NodeID' ] );
        }
        $counter->increase();
}
eZExecution::cleanExit();

node.url vs node.url_alias

pike · 04/08/2009 10:38 am

this documentation is fairly vague about the difference between node.url and node.url_alias.
node.url is 'depending on a configuration setting' - so is node.url_alias not ?
node.url_alias is 'determined according to the list of prioritized languages' - so is node.url not ?
a short test shows node.url also honors locales in its output .. if this is not 'determined according to the list of prioritized languages', how is it determined ?
node.is_invisible > node.is_hidden

pike · 11/16/2009 01:17 am

The doc above says
is_invisible (...) The node's visibility status (0=visible, 1=hidden by superior).
As far as I know and tested, thats wrong. "1" could mean "hidden" by a user or hidden by superiour. Only if its invisible, but not hidden, it must be hidden by superior.
$2c,
*-pike

Comments

Add a comment