node

About

eZ Publish Content Tree Node

Examples

Detecting locations of a node ...

PHP node object

The php object that represents has a couple attributes that can be accessed (similar to object properties).

List of attributes

"node_id" => array( 'name' => "NodeID",
'datatype' => 'integer',
'default' => 0,
'required' => true ),
"parent_node_id" => array( 'name' => "ParentNodeID",
'datatype' => 'integer',
'default' => 0,
'required' => true,
'foreign_class' => 'eZContentObjectTreeNode',
'foreign_attribute' => 'node_id',
'multiplicity' => '1..*' ),
"main_node_id" => array( 'name' => "MainNodeID",
'datatype' => 'integer',
'default' => 0,
'required' => true,
'foreign_class' => 'eZContentObjectTreeNode',
'foreign_attribute' => 'node_id',
'multiplicity' => '1..*' ),
"contentobject_id" => array( 'name' => "ContentObjectID",
'datatype' => 'integer',
'default' => 0,
'required' => true,
'foreign_class' => 'eZContentObject',
'foreign_attribute' => 'id',
'multiplicity' => '1..*' ),
'contentobject_version' => array( 'name' => 'ContentObjectVersion',
'datatype' => 'integer',
'default' => 0,
'required' => true ),
'contentobject_is_published' => array( 'name' => 'ContentObjectIsPublished',
'datatype' => 'integer',
'default' => 0,
'required' => true ),
"depth" => array( 'name' => "Depth",
'datatype' => 'integer',
'default' => 0,
'required' => true ),
'sort_field' => array( 'name' => 'SortField',
'datatype' => 'integer',
'default' => 1,
'required' => true ),
'sort_order' => array( 'name' => 'SortOrder',
'datatype' => 'integer',
'default' => 1,
'required' => true ),
'priority' => array( 'name' => 'Priority',
'datatype' => 'integer',
'default' => 0,
'required' => true ),
'modified_subnode' => array( 'name' => 'ModifiedSubNode',
'datatype' => 'integer',
'default' => 0,
'required' => true ),
"path_string" => array( 'name' => "PathString",
'datatype' => 'string',
'default' => '',
'required' => true ),
"path_identification_string" => array( 'name' => "PathIdentificationString",
'datatype' => 'text',
'default' => '',
'required' => true ),
'remote_id' => array( 'name' => 'RemoteID',
'datatype' => 'string',
'default' => '',
'required' => true ),
"is_hidden" => array( 'name' => "IsHidden",
'datatype' => 'integer',
'default' => 0,
'required' => true ),
"is_invisible" => array( 'name' => "IsInvisible",
'datatype' => 'integer',
'default' => 0,
'required' => true ) ),

List of object functions to get related values

"name" => "getName",
'data_map' => 'dataMap',
'remote_id' => 'remoteID', // Note: This overrides remote_id field
"object" => "object",
"subtree" => "subTree",
"children" => "children",
"children_count" => "childrenCount",
'view_count' => 'viewCount',
'contentobject_version_object' => 'contentObjectVersionObject',
'sort_array' => 'sortArray',
'can_read' => 'canRead',
'can_pdf' => 'canPdf',
'can_create' => 'canCreate',
'can_edit' => 'canEdit',
'can_hide' => 'canHide',
'can_remove' => 'canRemove',
'can_move' => 'canMoveFrom',
'can_move_from' => 'canMoveFrom',
'can_add_location' => 'canAddLocation',
'can_remove_location' => 'canRemoveLocation',
'can_view_embed' => 'canViewEmbed',
'is_main' => 'isMain',
'creator' => 'creator',
"path" => "fetchPath",
'path_array' => 'pathArray',
"parent" => "fetchParent",
'url' => 'url',
'url_alias' => 'urlAlias',
'class_identifier' => 'classIdentifier',
'class_name' => 'className',
'hidden_invisible_string' => 'hiddenInvisibleString',
'hidden_status_string' => 'hiddenStatusString',
'classes_js_array' => 'availableClassesJsArray' )