eZPublish  4.4
eZContentObjectVersion Class Reference

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)
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 
 attributes ()
 
 eZPersistentObject ($row)
 
 fill ($row)
 
 hasAttribute ($attr)
 
 hasDirtyData ()
 
 remove ($conditions=null, $extraConditions=null)
 
 setAttribute ($attr, $val)
 
 setHasDirtyData ($hasDirtyData)
 
 store ($fieldFilters=null)
 
 sync ($fieldFilters=null)
 

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')
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 
static conditionTextByRow ($conditions, $row)
 
static count ($def, $conds=null, $field=null)
 
static definition ()
 
static escapeArray ($array)
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 
static fetchObjectList ($def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null, $custom_tables=null, $custom_conds=null)
 
static getShortAttributeName ($db, $def, $attrName)
 
static handleRows ($rows, $class_name, $asObject)
 
static newObjectOrder ($def, $orderField, $conditions)
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 
static updateObjectList ($parameters)
 

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
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 Whether the data is dirty, ie needs to be stored, or not. More...
 

Static Private Member Functions

static mapLanguage ($language, $options)
 

Detailed Description

The class eZContentObjectVersion handles different versions of an content object.

Member Function Documentation

eZContentObjectVersion::assignToNode (   $nodeID,
  $main = 0,
  $fromNodeID = 0,
  $sortField = null,
  $sortOrder = null,
  $remoteID = 0 
)
eZContentObjectVersion::canVersionRead ( )
Returns
true if the current user can read this version of the object.
eZContentObjectVersion::canVersionRemove ( )
Returns
true if the current user can remove this version of the object.
eZContentObjectVersion::checkAccess (   $functionName,
  $originalClassID = false,
  $parentClassID = false,
  $returnAccessList = false,
  $language = false 
)

Referenced by canVersionRead(), and canVersionRemove().

eZContentObjectVersion::clearAlwaysAvailableLanguageID ( )
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.
eZContentObjectVersion::contentObject ( )
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.

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

static eZContentObjectVersion::create (   $contentobjectID,
  $userID = false,
  $version = 1,
  $initialLanguageCode = false 
)
static
eZContentObjectVersion::creator ( )
Returns
the creator of the current version.
eZContentObjectVersion::dataMap ( )
Returns
the content object attribute
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.
eZContentObjectVersion::eZContentObjectVersion (   $row = array())

Referenced by create().

static eZContentObjectVersion::fetch (   $id,
  $asObject = true 
)
static
Returns
true if the requested attribute exists in object.
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.

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

static eZContentObjectVersion::fetchFiltered (   $filters,
  $offset,
  $limit 
)
static

Referenced by removeVersions().

static eZContentObjectVersion::fetchForUser (   $userID,
  $status = eZContentObjectVersion::STATUS_DRAFT 
)
static
static eZContentObjectVersion::fetchUserDraft (   $objectID,
  $userID 
)
static
eZContentObjectVersion::hasConflicts (   $editLanguage = false)
eZContentObjectVersion::initialLanguage ( )

Referenced by initialLanguageCode().

eZContentObjectVersion::initialLanguageCode ( )
eZContentObjectVersion::languageMask ( )
eZContentObjectVersion::mainParentNodeID ( )
static eZContentObjectVersion::mapLanguage (   $language,
  $options 
)
staticprivate

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

Returns
string

Referenced by unserialize().

eZContentObjectVersion::name (   $lang = false)
Returns
the name of the current version, optionally in the specific language $lang
eZContentObjectVersion::nodeAssignments ( )

Referenced by tempMainNode().

eZContentObjectVersion::nonTranslatableAttributesToUpdate ( )
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.
eZContentObjectVersion::parentNodes ( )
eZContentObjectVersion::postUnserialize (   $package)
eZContentObjectVersion::relatedContentObjectArray ( )

Returns the related objects.

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.
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.
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.
static eZContentObjectVersion::removeVersions (   $versionStatus = false,
  $limit = false,
  $expiryTime = false,
  $fetchPortionSize = 50 
)
static

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

Parameters
$versionStatuscan either be a single value or an array with values, if false the function will remove all status except published.
$limitlimits count of versions which should be removed.
$expiryTimeif not false then method will remove only versions which have modified time less than specified expiry time.
$fetchPortionSizeportion 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.

Referenced by eZContentObject\removeVersions().

eZContentObjectVersion::resetDataMap ( )
eZContentObjectVersion::reverseRelatedObjectList ( )
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
optionspackage options ( optional )
contentNodeIDArrayarray of allowed nodes ( optional )
topNodeIDArrayarray 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.
eZContentObjectVersion::setAlwaysAvailableLanguageID (   $languageID)
static eZContentObjectVersion::statusList (   $limit = false)
static
eZContentObjectVersion::store (   $fieldFilters = null)

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.
eZContentObjectVersion::translation (   $asObject = true)
Returns
An array with all the translations for the current version.
Deprecated:
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.

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

eZContentObjectVersion::translations (   $asObject = true)
Returns
An array with all the translations for the current version.

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.
static eZContentObjectVersion::unserialize (   $domNode,
  $contentObject,
  $ownerID,
  $sectionID,
  $activeVersion,
  $firstVersion,
$nodeList,
$options,
  $package,
  $handlerType = 'ezcontentobject' 
)
static

Unserialize xml structure. Create object from xml input.

Parameters
domNodeXML DOM Node
contentObjectcontentobject
ownerIDowner ID
sectionIDsection ID
activeVersionnew 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.

Referenced by eZContentObject\unserialize().

eZContentObjectVersion::updateLanguageMask (   $mask = false,
  $forceStore = true 
)

Referenced by removeTranslation().

eZContentObjectVersion::versionName (   $lang = false)
Returns
the name of the current version, optionally in the specific language $lang

Member Data Documentation

eZContentObjectVersion::$CurrentLanguage = false

Referenced by contentObjectAttributes().

const eZContentObjectVersion::STATUS_REJECTED = 4
const eZContentObjectVersion::STATUS_REPEAT = 6

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