eZPublish  3.8
eZNodeAssignment Class Reference

The class eZNodeAssignment does. More...

+ Inheritance diagram for eZNodeAssignment:
+ Collaboration diagram for eZNodeAssignment:

Public Member Functions

 clone ($nextVersionNumber=1, $contentObjectID=false)
 
 create ($parameters=array())
 
 definition ()
 
 eZNodeAssignment ($row)
 
 fetch ($contentObjectID, $version=1, $parentNode=0, $asObject=true)
 
 fetchByID ($id, $asObject=true)
 
 fetchForObject ($contentObjectID, $version=1, $main=0, $asObject=true)
 
 fetchListByID ($idList, $asObject=true)
 
fetchNode ()
 
getParentNode ()
 
getParentObject ()
 
isCreateOperation ()
 
isMoveOperation ()
 
isNopOperation ()
 
isRemoveOperation ()
 
isSetOperation ()
 
 name ()
 
 purge ($parentNodeID=false, $contentObjectID=false)
 
 remove ($parentNodeID=false, $contentObjectID=false)
 
 setName ($name)
 
tempNode ()
 
- Public Member Functions inherited from eZPersistentObject
attribute ($attr, $noFunction=false)
 
 attributes ()
 
 conditionText (&$conditions)
 
conditionTextByRow (&$conditions, &$row)
 
 definition ()
 
escapeArray (&$array)
 
 eZPersistentObject ($row)
 
 fetchObject (&$def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 
 fetchObjectList (&$def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null)
 
 fill (&$row)
 
 getShortAttributeName (&$db, &$def, $attrName)
 
 handleRows (&$rows, $class_name, $asObject)
 
 hasAttribute ($attr)
 
 hasDirtyData ()
 
 newObjectOrder (&$def, $orderField, $conditions)
 
 remove ($conditions=null, $extraConditions=null)
 
 removeObject (&$def, $conditions=null, $extraConditions=null)
 
 reorderObject (&$def, $orderField, $conditions, $down=true)
 
 setAttribute ($attr, $val)
 
 setHasDirtyData ($hasDirtyData)
 
 store ($fieldFilters=null)
 
 swapRow ($table, &$keys, &$order_id, &$rows, $id1, $id2)
 
 sync ($fieldFilters=null)
 
 updateObjectList ($parameters)
 

Static Public Member Functions

 purgeByID ($assignmentID)
 
 removeByID ($assignmentID)
 
 setNewMainAssignment ($objectID, $version)
 

Private Attributes

 $ContentobjectID
 
 $ContentObjectVersion
 
 $FromNodeID
 
 $ID
 
 $Main
 
 $ParentNode
 
 $ParentRemoteID
 
 $RemoteID
 Used for giving unique values to an assignment which can later be checked. More...
 
 $SortField
 
 $SortOrder
 

Detailed Description

The class eZNodeAssignment does.

Member Function Documentation

eZNodeAssignment::clone (   $nextVersionNumber = 1,
  $contentObjectID = false 
)
eZNodeAssignment::eZNodeAssignment (   $row)

Constructor

Referenced by create().

eZNodeAssignment::fetch (   $contentObjectID,
  $version = 1,
  $parentNode = 0,
  $asObject = true 
)
eZNodeAssignment::fetchByID (   $id,
  $asObject = true 
)

Fetches the node assignment which has id $id and returns it.

See Also
fetchListByID
eZNodeAssignment::fetchListByID (   $idList,
  $asObject = true 
)

Fetches all node assignments which is mentioned in array $ID and returns it.

See Also
fetchByID
& eZNodeAssignment::fetchNode ( )

Finds the node for the current assignemnt if it exists and returns it.

Returns
An eZContentObjectTreeNode object or null if no node was found.
See Also
eZContentObjectTreeNode::fetchNode
& eZNodeAssignment::getParentNode ( )
& eZNodeAssignment::getParentObject ( )
Returns
The contentobject which the parent node points to.
& eZNodeAssignment::isCreateOperation ( )

Returns true if the assignment is a create operation.

Returns
bool
& eZNodeAssignment::isMoveOperation ( )

Returns true if the assignment is a move operation.

Returns
bool
& eZNodeAssignment::isNopOperation ( )

Returns true if the assignment is a nop (no operation) operation.

Returns
bool
& eZNodeAssignment::isRemoveOperation ( )

Returns true if the assignment is a remove operation.

Returns
bool
& eZNodeAssignment::isSetOperation ( )

Returns true if the assignment is a set (update/create) operation.

Returns
bool
eZNodeAssignment::name ( )
eZNodeAssignment::purge (   $parentNodeID = false,
  $contentObjectID = false 
)

Delete specified nodeassignment if parentNodeID and contentObjectID are given, if they are false it will remove the current node assignment.

Parameters
$parentNodeIDThe ID of the parent node
$contentObjectIDThe ID of the object
Note
Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.
eZNodeAssignment::purgeByID (   $assignmentID)
static

Delelet the node assignment with the ID $assignmentID.

Parameters
$assignmentIDEither an ID or an array with IDs.
Returns
true if it were able to remove the assignments, false if something failed.
Note
If $assignmentID is an empty array it immediately returns false.
Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Referenced by copyPublishContentObject(), and eZContentOperationCollection\removeOldNodes().

eZNodeAssignment::remove (   $parentNodeID = false,
  $contentObjectID = false 
)

Marks the specified nodeassignment to remove its node. It uses parentNodeID and contentObjectID if they are given, if they are false it will mark the current node assignment.

Parameters
$parentNodeIDThe ID of the parent node
$contentObjectIDThe ID of the object
Note
Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.
eZNodeAssignment::removeByID (   $assignmentID)
static

Marks the node assignment with the ID $assignmentID to remove its node.

Parameters
$assignmentIDEither an ID or an array with IDs.
Returns
true if it were able to remove the assignments, false if something failed.
Note
If $assignmentID is an empty array it immediately returns false.
Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Referenced by checkNodeActions().

eZNodeAssignment::setName (   $name)
eZNodeAssignment::setNewMainAssignment (   $objectID,
  $version 
)
static

Chooses and sets new main assignment for the specified object, in case if there's main assignment already.

Returns
false if there is already main assignment, true on success.
Note
Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Referenced by checkNodeActions(), and eZContentObject\unserialize().

& eZNodeAssignment::tempNode ( )

Member Data Documentation

eZNodeAssignment::$ContentobjectID
private
eZNodeAssignment::$ContentObjectVersion
private
eZNodeAssignment::$FromNodeID
private
eZNodeAssignment::$ID
private
eZNodeAssignment::$Main
private
eZNodeAssignment::$ParentNode
private
eZNodeAssignment::$ParentRemoteID
private
eZNodeAssignment::$RemoteID
private

Used for giving unique values to an assignment which can later be checked.

This is often used in templates to provide limited choices for assignments.

eZNodeAssignment::$SortField
private
eZNodeAssignment::$SortOrder
private

The documentation for this class was generated from the following file: