eZNodeAssignment Class Reference

The class eZNodeAssignment does. More...

Inheritance 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 ()
Static Public Member Functions
	purgeByID ($assignmentID)
	removeByID ($assignmentID)
	setNewMainAssignment ($objectID, $version)
Private Attributes
	$ContentobjectID
	$ContentObjectVersion
	$FromNodeID
	$ID
	$Main
	$ParentNode
	$ParentRemoteID
	$RemoteID
	$SortField
	$SortOrder

Detailed Description

The class eZNodeAssignment does.

Definition at line 59 of file eznodeassignment.php.

Member Function Documentation

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

Definition at line 463 of file eznodeassignment.php.

eZNodeAssignment::create ( $ parameters = array() )

Definition at line 215 of file eznodeassignment.php.

Referenced by clone(), eZContentFunctions::createAndPublishObject(), eZContentObjectPackageHandler::installSuspendedNodeAssignment(), eZContentObjectAssignmentHandler::setupAssignments(), and tempNode().

eZNodeAssignment::definition ( )

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:

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 71 of file eznodeassignment.php.

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

eZNodeAssignment::eZNodeAssignment ( $ row )

Constructor

Definition at line 64 of file eznodeassignment.php.

Referenced by create().

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

Definition at line 417 of file eznodeassignment.php.

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

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

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

See also:: fetchListByID

Definition at line 443 of file eznodeassignment.php.

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

Definition at line 400 of file eznodeassignment.php.

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

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

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

See also:: fetchByID

Definition at line 455 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 433 of file eznodeassignment.php.

& eZNodeAssignment::getParentNode ( )

Definition at line 478 of file eznodeassignment.php.

& eZNodeAssignment::getParentObject ( )

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

Definition at line 487 of file eznodeassignment.php.

& eZNodeAssignment::isCreateOperation ( )

Returns true if the assignment is a create operation.

Returns:: bool

Definition at line 179 of file eznodeassignment.php.

& eZNodeAssignment::isMoveOperation ( )

Returns true if the assignment is a move operation.

Returns:: bool

Definition at line 189 of file eznodeassignment.php.

& eZNodeAssignment::isNopOperation ( )

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

Returns:: bool

Definition at line 169 of file eznodeassignment.php.

& eZNodeAssignment::isRemoveOperation ( )

Returns true if the assignment is a remove operation.

Returns:: bool

Definition at line 199 of file eznodeassignment.php.

& eZNodeAssignment::isSetOperation ( )

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

Returns:: bool

Definition at line 209 of file eznodeassignment.php.

eZNodeAssignment::name ( )

Definition at line 160 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 343 of file eznodeassignment.php.

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 372 of file eznodeassignment.php.

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 274 of file eznodeassignment.php.

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 306 of file eznodeassignment.php.

eZNodeAssignment::setName ( $ name )

Definition at line 155 of file eznodeassignment.php.

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 500 of file eznodeassignment.php.

Referenced by eZContentObject::unserialize().

& eZNodeAssignment::tempNode ( )

Definition at line 141 of file eznodeassignment.php.

Member Data Documentation

eZNodeAssignment::$ContentobjectID [private]

Definition at line 550 of file eznodeassignment.php.

eZNodeAssignment::$ContentObjectVersion [private]

Definition at line 551 of file eznodeassignment.php.

eZNodeAssignment::$FromNodeID [private]

Definition at line 556 of file eznodeassignment.php.

eZNodeAssignment::$ID [private]

Definition at line 545 of file eznodeassignment.php.

eZNodeAssignment::$Main [private]

Definition at line 555 of file eznodeassignment.php.

eZNodeAssignment::$ParentNode [private]

Definition at line 552 of file eznodeassignment.php.

eZNodeAssignment::$ParentRemoteID [private]

Definition at line 549 of file eznodeassignment.php.

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.

Definition at line 548 of file eznodeassignment.php.

eZNodeAssignment::$SortField [private]

Definition at line 553 of file eznodeassignment.php.

eZNodeAssignment::$SortOrder [private]

Definition at line 554 of file eznodeassignment.php.

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

eznodeassignment.php

eZNodeAssignment Class Reference

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation