Path

7x / documentation / ez publish / technical manual / 3.9 / reference / objects / ezcontentobjecttrashnode


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

ezcontentobjecttrashnode

Summary

Contains information about a node moved to the trash.

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.

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 (for example "company/about_us/my_article").

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.

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_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_remove

boolean

No.

Returns TRUE if the current user can remove the node (FALSE otherwise).

creator

object

No.

The object (as ezcontentobject) containing the user who created the node.

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).

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").

original_parent

object

No.

Returns the parent node (as ezcontentobjecttreenode) or NULL if the parent node has been removed or moved to another place in the content tree.

original_parent_path_id_string

string

No.

Returns the path identification string of the parent node (for example "company/about_us") regardless whether the parent node has been removed, moved to another place in the content tree or not.

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

Julia Shymova (25/05/2007 12:43 pm)

Balazs Halasy (30/05/2007 5:44 pm)

Julia Shymova, Balazs Halasy


Comments

There are no comments.