The class eZContentObjectVersion handles different versions of an content object. More...

Inheritance diagram for eZContentObjectVersion:

Collaboration diagram for eZContentObjectVersion:

Public Member Functions
	assignToNode ($nodeID, $main=0, $fromNodeID=0, $sortField=null, $sortOrder=null, $remoteID=0)
	canVersionRead ()
	canVersionRemove ()
	checkAccess ($functionName, $originalClassID=false, $parentClassID=false, $returnAccessList=false, $language=false)
	clearAlwaysAvailableLanguageID ()
	cloneVersion ($newVersionNumber, $userID, $contentObjectID=false, $status=eZContentObjectVersion::STATUS_DRAFT)
	contentObject ()
	contentObjectAttributes ($languageCode=false, $asObject=true)
	creator ()
	dataMap ()
	defaultTranslationList ()
	eZContentObjectVersion ($row=array())
	hasConflicts ($editLanguage=false)
	initialLanguage ()
	initialLanguageCode ()
	languageMask ()
	mainParentNodeID ()
	name ($lang=false)
	nodeAssignments ()
	nonTranslatableAttributesToUpdate ()
	nonTranslationList ()
	parentNodes ()
	postUnserialize ($package)
	relatedContentObjectArray ()
	removeAssignment ($nodeID)
	removeThis ()
	removeTranslation ($languageCode)
	resetDataMap ()
	reverseRelatedObjectList ()
	serialize ($package, $options=false, $contentNodeIDArray=false, $topNodeIDArray=false)
	setAlwaysAvailableLanguageID ($languageID)
	store ($fieldFilters=null)
	tempMainNode ()
	translation ($asObject=true)
	translationList ($language=false, $asObject=true)
	translations ($asObject=true)
	unpublish ()
	updateLanguageMask ($mask=false, $forceStore=true)
	versionName ($lang=false)
Static Public Member Functions
static	create ($contentobjectID, $userID=false, $version=1, $initialLanguageCode=false)
static	definition ()
static	fetch ($id, $asObject=true)
static	fetchAttributes ($version, $contentObjectID, $language=false, $asObject=true)
static	fetchFiltered ($filters, $offset, $limit)
static	fetchForUser ($userID, $status=eZContentObjectVersion::STATUS_DRAFT)
static	fetchUserDraft ($objectID, $userID)
static	fetchVersion ($version, $contentObjectID, $asObject=true)
static	removeVersions ($versionStatus=false, $limit=false, $expiryTime=false, $fetchPortionSize=50)
static	statusList ($limit=false)
static	unserialize ($domNode, $contentObject, $ownerID, $sectionID, $activeVersion, $firstVersion, &$nodeList, &$options, $package, $handlerType= 'ezcontentobject')
Public Attributes
	$CurrentLanguage = false
const	STATUS_ARCHIVED = 3
const	STATUS_DRAFT = 0
const	STATUS_INTERNAL_DRAFT = 5
const	STATUS_PENDING = 2
const	STATUS_PUBLISHED = 1
const	STATUS_REJECTED = 4
const	STATUS_REPEAT = 6
Static Private Member Functions
static	mapLanguage ($language, $options)

Detailed Description

The class eZContentObjectVersion handles different versions of an content object.

Definition at line 38 of file ezcontentobjectversion.php.

Member Function Documentation

eZContentObjectVersion::assignToNode	(	$	nodeID,
		$	main = `0`,
		$	fromNodeID = `0`,
		$	sortField = `null`,
		$	sortOrder = `null`,
		$	remoteID = `0`
	)

Definition at line 743 of file ezcontentobjectversion.php.

eZContentObjectVersion::canVersionRead ( )

Returns:: true if the current user can read this version of the object.

Definition at line 334 of file ezcontentobjectversion.php.

eZContentObjectVersion::canVersionRemove ( )

Returns:: true if the current user can remove this version of the object.

Definition at line 346 of file ezcontentobjectversion.php.

eZContentObjectVersion::checkAccess	(	$	functionName,
		$	originalClassID = `false`,
		$	parentClassID = `false`,
		$	returnAccessList = `false`,
		$	language = `false`
	)

Definition at line 355 of file ezcontentobjectversion.php.

Referenced by canVersionRead(), and canVersionRemove().

eZContentObjectVersion::clearAlwaysAvailableLanguageID ( )

Definition at line 1695 of file ezcontentobjectversion.php.

eZContentObjectVersion::cloneVersion	(	$	newVersionNumber,
		$	userID,
		$	contentObjectID = `false`,
		$	status = `eZContentObjectVersion::STATUS_DRAFT`
	)

Clones the version with new version $newVersionNumber and creator $userID

Note:: The cloned version is not stored.

Definition at line 1023 of file ezcontentobjectversion.php.

eZContentObjectVersion::contentObject ( )

Definition at line 705 of file ezcontentobjectversion.php.

Referenced by hasConflicts(), name(), nonTranslatableAttributesToUpdate(), and tempMainNode().

eZContentObjectVersion::contentObjectAttributes	(	$	languageCode = `false`,
		$	asObject = `true`
	)

Returns the attributes for the current content object version. If $language is not specified it will use the initial language of the version.

Definition at line 1115 of file ezcontentobjectversion.php.

Referenced by dataMap(), postUnserialize(), removeTranslation(), and serialize().

static eZContentObjectVersion::create	(	$	contentobjectID,
		$	userID = `false`,
		$	version = `1`,
		$	initialLanguageCode = `false`
	)		`[static]`

Definition at line 832 of file ezcontentobjectversion.php.

Referenced by assignToNode(), and tempMainNode().

eZContentObjectVersion::creator ( )

Returns:: the creator of the current version.

Definition at line 1525 of file ezcontentobjectversion.php.

eZContentObjectVersion::dataMap ( )

Returns:: the content object attribute

Definition at line 787 of file ezcontentobjectversion.php.

eZContentObjectVersion::defaultTranslationList ( )

Returns:: An array with all translations except default language for the this version.

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 1106 of file ezcontentobjectversion.php.

static eZContentObjectVersion::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 59 of file ezcontentobjectversion.php.

Referenced by fetch(), fetchFiltered(), fetchForUser(), fetchUserDraft(), fetchVersion(), and eZContentObject\versions().

eZContentObjectVersion::eZContentObjectVersion ( $ row = array() )

Definition at line 49 of file ezcontentobjectversion.php.

Referenced by create().

static eZContentObjectVersion::fetch	(	$	id,
		$	asObject = `true`
	)		`[static]`

Returns:: true if the requested attribute exists in object.

Definition at line 168 of file ezcontentobjectversion.php.

Referenced by checkAccess(), contentObject(), creator(), initialLanguage(), and nonTranslatableAttributesToUpdate().

static eZContentObjectVersion::fetchAttributes	(	$	version,
		$	contentObjectID,
		$	language = `false`,
		$	asObject = `true`
	)		`[static]`

Returns the attributes for the content object version $version and content object $contentObjectID. $language defines the language to fetch.

See also:: attributes

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 1140 of file ezcontentobjectversion.php.

Referenced by contentObjectAttributes(), and eZContentObjectTranslation\objectAttributes().

static eZContentObjectVersion::fetchFiltered	(	$	filters,
		$	offset,
		$	limit
	)		`[static]`

Definition at line 211 of file ezcontentobjectversion.php.

Referenced by removeVersions().

static eZContentObjectVersion::fetchForUser	(	$	userID,
		$	status = `eZContentObjectVersion::STATUS_DRAFT`
	)		`[static]`

Definition at line 201 of file ezcontentobjectversion.php.

Referenced by eZContentObject\cleanupAllInternalDrafts().

static eZContentObjectVersion::fetchUserDraft	(	$	objectID,
		$	userID
	)		`[static]`

Definition at line 187 of file ezcontentobjectversion.php.

static eZContentObjectVersion::fetchVersion	(	$	version,
		$	contentObjectID,
		$	asObject = `true`
	)		`[static]`

Definition at line 176 of file ezcontentobjectversion.php.

Referenced by eZApproveCollaborationHandler\contentObjectVersion(), eZContentObjectTreeNode\contentObjectVersionObject(), eZContentObject\currentVersion(), eZPublishType\eventContent(), eZImageAliasHandler\initializeFromFile(), eZImageAliasHandler\initializeFromHTTPFile(), eZContentObjectPackageHandler\installSuspendedObjectRelations(), eZContentObjectAttribute\objectVersion(), eZObjectRelationListType\onPublish(), eZObjectRelationListType\removeRelationObject(), eZObjectRelationListType\storeObjectAttribute(), and eZContentObject\version().

eZContentObjectVersion::hasConflicts ( $ editLanguage = false )

Definition at line 1705 of file ezcontentobjectversion.php.

eZContentObjectVersion::initialLanguage ( )

Definition at line 1616 of file ezcontentobjectversion.php.

Referenced by initialLanguageCode().

eZContentObjectVersion::initialLanguageCode ( )

Definition at line 1621 of file ezcontentobjectversion.php.

Referenced by contentObjectAttributes(), hasConflicts(), serialize(), and versionName().

eZContentObjectVersion::languageMask ( )

Definition at line 1596 of file ezcontentobjectversion.php.

eZContentObjectVersion::mainParentNodeID ( )

Definition at line 714 of file ezcontentobjectversion.php.

static eZContentObjectVersion::mapLanguage	(	$	language,
		$	options
	)		`[static, private]`

Maps input lange to another one if defined in $options['language_map']. If it cannot map it returns the original language.

Returns:: string

Definition at line 1191 of file ezcontentobjectversion.php.

Referenced by unserialize().

eZContentObjectVersion::name ( $ lang = false )

Returns:: the name of the current version, optionally in the specific language $lang

Definition at line 273 of file ezcontentobjectversion.php.

eZContentObjectVersion::nodeAssignments ( )

Definition at line 738 of file ezcontentobjectversion.php.

Referenced by tempMainNode().

eZContentObjectVersion::nonTranslatableAttributesToUpdate ( )

Definition at line 1630 of file ezcontentobjectversion.php.

eZContentObjectVersion::nonTranslationList ( )

Returns:: an array with locale objects, these objects represents the languages the content objects are allowed to be translated into. The array will not include locales that has been translated in this version.

Definition at line 1576 of file ezcontentobjectversion.php.

eZContentObjectVersion::parentNodes ( )

Definition at line 727 of file ezcontentobjectversion.php.

eZContentObjectVersion::postUnserialize ( $ package )

Definition at line 1388 of file ezcontentobjectversion.php.

eZContentObjectVersion::relatedContentObjectArray ( )

Returns the related objects.

Definition at line 826 of file ezcontentobjectversion.php.

eZContentObjectVersion::removeAssignment ( $ nodeID )

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 768 of file ezcontentobjectversion.php.

eZContentObjectVersion::removeThis ( )

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 868 of file ezcontentobjectversion.php.

eZContentObjectVersion::removeTranslation ( $ languageCode )

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 930 of file ezcontentobjectversion.php.

static eZContentObjectVersion::removeVersions	(	$	versionStatus = `false`,
		$	limit = `false`,
		$	expiryTime = `false`,
		$	fetchPortionSize = `50`
	)		`[static]`

Will remove all version that match the status set in $versionStatus.

Parameters:

$versionStatus	can either be a single value or an array with values, if `false` the function will remove all status except published.
$limit	limits count of versions which should be removed.
$expiryTime	if not false then method will remove only versions which have modified time less than specified expiry time.
$fetchPortionSize	portion size for single fetch() call to avoid memory overflow erros (default 50).

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 959 of file ezcontentobjectversion.php.

eZContentObjectVersion::resetDataMap ( )

Definition at line 816 of file ezcontentobjectversion.php.

eZContentObjectVersion::reverseRelatedObjectList ( )

Definition at line 859 of file ezcontentobjectversion.php.

eZContentObjectVersion::serialize	(	$	package,
		$	options = `false`,
		$	contentNodeIDArray = `false`,
		$	topNodeIDArray = `false`
	)

Returns:: a DOM structure of the content object version, it's translations and attributes.

Parameters:

package
options	package options ( optional )
contentNodeIDArray	array of allowed nodes ( optional )
topNodeIDArray	array of top nodes in current package export (optional )

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 1409 of file ezcontentobjectversion.php.

eZContentObjectVersion::setAlwaysAvailableLanguageID ( $ languageID )

Definition at line 1661 of file ezcontentobjectversion.php.

Referenced by clearAlwaysAvailableLanguageID().

static eZContentObjectVersion::statusList ( $ limit = false ) [static]

Definition at line 145 of file ezcontentobjectversion.php.

eZContentObjectVersion::store ( $ fieldFilters = null )

Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it.

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 1732 of file ezcontentobjectversion.php.

Referenced by updateLanguageMask().

eZContentObjectVersion::tempMainNode ( )

Returns:: an eZContentObjectTreeNode object which doesn't really exist in the DB, this can be passed to a node view template.

Definition at line 227 of file ezcontentobjectversion.php.

eZContentObjectVersion::translation ( $ asObject = true )

Returns:: An array with all the translations for the current version.

Deprecated:

Definition at line 1051 of file ezcontentobjectversion.php.

eZContentObjectVersion::translationList	(	$	language = `false`,
		$	asObject = `true`
	)

Returns:: An array with all the translations for the current version.

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 1062 of file ezcontentobjectversion.php.

Referenced by defaultTranslationList(), nonTranslationList(), serialize(), translations(), and updateLanguageMask().

eZContentObjectVersion::translations ( $ asObject = true )

Returns:: An array with all the translations for the current version.

Definition at line 1042 of file ezcontentobjectversion.php.

Referenced by nonTranslationList(), postUnserialize(), and removeThis().

eZContentObjectVersion::unpublish ( )

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 1538 of file ezcontentobjectversion.php.

static eZContentObjectVersion::unserialize	(	$	domNode,
		$	contentObject,
		$	ownerID,
		$	sectionID,
		$	activeVersion,
		$	firstVersion,
		&$	nodeList,
		&$	options,
		$	package,
		$	handlerType = `'ezcontentobject'`
	)		`[static]`

Unserialize xml structure. Create object from xml input.

Parameters:

domNode	XML DOM Node
contentObject	contentobject
ownerID	owner ID
sectionID	section ID
activeVersion	new object, true if first version of new object
options
package

Returns:: created object, false if could not create object/xml invalid

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 1216 of file ezcontentobjectversion.php.