The class eZNodeAssignment does. More...

Inheritance diagram for eZNodeAssignment:

Collaboration diagram for eZNodeAssignment:

Public Member Functions
	cloneNodeAssignment ($nextVersionNumber=1, $contentObjectID=false)
	eZNodeAssignment ($row)
	fetchNode ()
	getParentNode ()
	getParentObject ()
	isCreateOperation ()
	isMoveOperation ()
	isNopOperation ()
	isRemoveOperation ()
	isSetOperation ()
	name ()
	purge ($parentNodeID=false, $contentObjectID=false)
	remove ($parentNodeID=false, $contentObjectID=false)
	setName ($name)
	tempNode ()
Static Public Member Functions
static	create ($parameters=array())
static	definition ()
static	fetch ($contentObjectID, $version=1, $parentNode=0, $asObject=true)
static	fetchByID ($id, $asObject=true)
static	fetchChildCountByVersionStatus ($parentNodeIDList, $status=eZContentObjectVersion::STATUS_PENDING)
	Fetch node assignment count by version status, giving parent node id list.
static	fetchChildListByVersionStatus ($parentNodeIDList, $status=eZContentObjectVersion::STATUS_PENDING, $asObject=true)
	Fetch node assignment list by version status, giving parent node id list.
static	fetchForObject ($contentObjectID, $version=1, $main=0, $asObject=true)
static	fetchListByID ($idList, $asObject=true)
static	purgeByID ($assignmentID)
static	removeByID ($assignmentID)
static	setNewMainAssignment ($objectID, $version)
Public Attributes
	$ContentobjectID
	$ContentObjectVersion
	$FromNodeID
	$ID
	$Main
	$ParentNode
	$ParentRemoteID
	$RemoteID
	Used for giving unique values to an assignment which can later be checked.
	$SortField
	$SortOrder
const	OP_CODE_CREATE = 3
const	OP_CODE_CREATE_NOP = 2
const	OP_CODE_EXECUTE = 1
const	OP_CODE_MOVE = 5
const	OP_CODE_MOVE_NOP = 4
const	OP_CODE_NOP = 0
const	OP_CODE_REMOVE = 7
const	OP_CODE_REMOVE_NOP = 6
const	OP_CODE_SET = 9
const	OP_CODE_SET_NOP = 8

Detailed Description

The class eZNodeAssignment does.

Definition at line 39 of file eznodeassignment.php.

Member Function Documentation

eZNodeAssignment::cloneNodeAssignment	(	$	nextVersionNumber = `1`,
		$	contentObjectID = `false`
	)

Definition at line 511 of file eznodeassignment.php.

static eZNodeAssignment::create ( $ parameters = array() ) [static]

Definition at line 207 of file eznodeassignment.php.

Referenced by cloneNodeAssignment(), eZWebDAVContentBackend\copyObject(), eZWebDAVContentBackend\copyObjectSameDirectory(), eZContentFunctions\createAndPublishObject(), importRSSItem(), eZContentObjectPackageHandler\installSuspendedNodeAssignment(), eZContentObjectAssignmentHandler\setupAssignments(), and tempNode().

static eZNodeAssignment::definition ( ) [static]

Returns:: the definition for the object, the default implementation is to return an empty array. It's upto each inheriting class to return a proper definition array.

The definition array is an associative array consists of these keys:

fields - an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
keys - an array of fields which is used for uniquely identifying the object in the table.
function_attributes - an associative array of attributes which maps to member functions, used for fetching data with functions.
set_functions - an associative array of attributes which maps to member functions, used for setting data with functions.
increment_key - the field which is incremented on table inserts.
class_name - the classname which is used for instantiating new objecs when fetching from the database.
sort - an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either asc or desc.
name - the name of the database table

Example:

static function definition()
{
    return array( "fields" => array( "id" => "ID",
                                     "version" => "Version",
                                     "name" => "Name" ),
                  "keys" => array( "id", "version" ),
                  "function_attributes" => array( "current" => "currentVersion",
                                                  "class_name" => "className" ),
                  "increment_key" => "id",
                  "class_name" => "eZContentClass",
                  "sort" => array( "id" => "asc" ),
                  "name" => "ezcontentclass" );
}

Reimplemented from eZPersistentObject.

Definition at line 68 of file eznodeassignment.php.

Referenced by fetch(), fetchByID(), fetchForObject(), fetchListByID(), eZContentObjectPackageHandler\installSuspendedNodeAssignment(), remove(), and eZContentObjectTreeNode\unserialize().

eZNodeAssignment::eZNodeAssignment ( $ row )

Constructor

Definition at line 61 of file eznodeassignment.php.

Referenced by create(), and fetchChildListByVersionStatus().

static eZNodeAssignment::fetch	(	$	contentObjectID,
		$	version = `1`,
		$	parentNode = `0`,
		$	asObject = `true`
	)		`[static]`

Definition at line 408 of file eznodeassignment.php.

Referenced by getParentNode(), eZContentObjectTreeNodeOperations\move(), and eZObjectRelationListType\onPublish().

static eZNodeAssignment::fetchByID	(	$	id,
		$	asObject = `true`
	)		`[static]`

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

See also:: fetchListByID

Definition at line 433 of file eznodeassignment.php.

static eZNodeAssignment::fetchChildCountByVersionStatus	(	$	parentNodeIDList,
		$	status = `eZContentObjectVersion::STATUS_PENDING`
	)		`[static]`

Fetch node assignment count by version status, giving parent node id list.

Parameters:

array	$parentNodeIDList
int	$status

Returns:: int

Definition at line 460 of file eznodeassignment.php.

Referenced by eZContentObjectTreeNode\removeSubtrees().

static eZNodeAssignment::fetchChildListByVersionStatus	(	$	parentNodeIDList,
		$	status = `eZContentObjectVersion::STATUS_PENDING`,
		$	asObject = `true`
	)		`[static]`

Fetch node assignment list by version status, giving parent node id list.

Parameters:

array	$idList	node id array
int	$status	status of the object version
boolean	$count
boolean	$asObject	valid only when $count is false

Returns:: array|int

Definition at line 483 of file eznodeassignment.php.

static eZNodeAssignment::fetchForObject	(	$	contentObjectID,
		$	version = `1`,
		$	main = `0`,
		$	asObject = `true`
	)		`[static]`

Definition at line 391 of file eznodeassignment.php.

Referenced by eZContentObjectVersion\checkAccess(), eZContentObject\checkAccess(), eZContentObjectTreeNode\checkAccess(), eZContentObjectVersion\mainParentNodeID(), eZContentObjectVersion\nodeAssignments(), eZContentObjectVersion\parentNodes(), and setNewMainAssignment().

static eZNodeAssignment::fetchListByID	(	$	idList,
		$	asObject = `true`
	)		`[static]`

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

See also:: fetchByID

Definition at line 445 of file eznodeassignment.php.

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

Definition at line 424 of file eznodeassignment.php.

eZNodeAssignment::getParentNode ( )

Definition at line 526 of file eznodeassignment.php.

eZNodeAssignment::getParentObject ( )

Returns:: The contentobject which the parent node points to.

Definition at line 534 of file eznodeassignment.php.

eZNodeAssignment::isCreateOperation ( )

Returns true if the assignment is a create operation.

Returns:: bool

Definition at line 175 of file eznodeassignment.php.

eZNodeAssignment::isMoveOperation ( )

Returns true if the assignment is a move operation.

Returns:: bool

Definition at line 184 of file eznodeassignment.php.

eZNodeAssignment::isNopOperation ( )

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

Returns:: bool

Definition at line 166 of file eznodeassignment.php.

eZNodeAssignment::isRemoveOperation ( )

Returns true if the assignment is a remove operation.

Returns:: bool

Definition at line 193 of file eznodeassignment.php.

eZNodeAssignment::isSetOperation ( )

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

Returns:: bool

Definition at line 202 of file eznodeassignment.php.

eZNodeAssignment::name ( )

Definition at line 157 of file eznodeassignment.php.

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:

$parentNodeID	The ID of the parent node
$contentObjectID	The 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.

Definition at line 335 of file eznodeassignment.php.

static eZNodeAssignment::purgeByID ( $ assignmentID ) [static]

Delelet the node assignment with the ID $assignmentID.

Parameters:

$assignmentID Either 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.

Definition at line 363 of file eznodeassignment.php.

Referenced by copyPublishContentObject().

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:

$parentNodeID	The ID of the parent node
$contentObjectID	The 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.

Reimplemented from eZPersistentObject.

Definition at line 266 of file eznodeassignment.php.

static eZNodeAssignment::removeByID ( $ assignmentID ) [static]

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

Parameters:

$assignmentID Either 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.

Definition at line 298 of file eznodeassignment.php.

eZNodeAssignment::setName ( $ name )

Definition at line 152 of file eznodeassignment.php.

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

Definition at line 546 of file eznodeassignment.php.

Referenced by eZContentObject\unserialize().

eZNodeAssignment::tempNode ( )

Definition at line 138 of file eznodeassignment.php.