eZPublish  4.5
eZContentOperationCollection Class Reference

The class eZContentOperationCollection does. More...

Public Member Functions

 beginPublish ()
 
 endPublish ()
 
 eZContentOperationCollection ()
 
 publishObjectExtensionHandler ($contentObjectID, $contentObjectVersion)
 

Static Public Member Functions

static addAssignment ($nodeID, $objectID, $selectedNodeIDArray)
 Adds a new nodeAssignment. More...
 
static attributePublishAction ($objectID, $versionNum)
 
static changeHideStatus ($nodeID)
 Changes an contentobject's status. More...
 
static changeSortOrder ($nodeID, $sortingField, $sortingOrder=false)
 Changes the sort order for a node. More...
 
static changeTranslationAvailableStatus ($objectID, $status=false)
 Changes the status of a translation. More...
 
static clearObjectViewCache ($objectID, $versionNum=true, $additionalNodeList=false)
 
static copyTranslations ($objectID, $versionNum)
 
static createFeedForNode ($nodeID)
 Creates a RSS/ATOM Feed export for a node. More...
 
static createNotificationEvent ($objectID, $versionNum)
 
static deleteObject ($deleteIDArray, $moveToTrash=false)
 Deletes a content object, or a list of content objects. More...
 
static executePrePublishTrigger ($objectID, $version)
 Executes the pre-publish trigger for this object, and handles specific return statuses from the workflow. More...
 
static generateObjectViewCache ($objectID)
 
static loopNodeAssignment ($objectID, $versionNum)
 
static loopNodes ($nodeID)
 
static moveNode ($nodeID, $objectID, $newParentNodeID)
 Moves a node. More...
 
static publishNode ($parentNodeID, $objectID, $versionNum, $mainNodeID)
 
static readNode ($nodeID)
 
static readObject ($nodeID, $userID, $languageCode)
 
static registerSearchObject ($objectID, $versionNum)
 Registers the object in search engine. More...
 
static removeAssignment ($nodeID, $objectID, $removeList, $moveToTrash)
 Removes a nodeAssignment or a list of nodeAssigments. More...
 
static removeFeedForNode ($nodeID)
 Removes a RSS/ATOM Feed export for a node. More...
 
static removeNodes (array $removeNodeIdList)
 Removes nodes. More...
 
static removeOldNodes ($objectID, $versionNum)
 
static removeTemporaryDrafts ($objectID, $versionNum)
 
static removeTranslation ($objectID, $languageIDArray)
 Removes a translation for a contentobject. More...
 
static resetNodeassignmentOpcodes ($objectID, $versionNum)
 
static sendToPublishingQueue ($objectId, $version)
 Sends the published object/version for publishing to the queue Used by the content/publish operation. More...
 
static setObjectStatusPublished ($objectID, $versionNum)
 
static setVersionStatus ($objectID, $versionNum, $status)
 
static swapNode ($nodeID, $selectedNodeID, $nodeIdList=array())
 Swap a node with another one. More...
 
static updateAlwaysAvailable ($objectID, $newAlwaysAvailable)
 Set the always available flag for a content object. More...
 
static updateInitialLanguage ($objectID, $newInitialLanguageID)
 Updates an contentobject's initial language. More...
 
static UpdateMainAssignment ($mainAssignmentID, $ObjectID, $mainAssignmentParentID)
 Update a node's main assignment. More...
 
static updateNontranslatableAttributes ($objectID, $versionNum)
 
static updateObjectState ($objectID, $selectedStateIDList)
 Update a contentobject's state. More...
 
static updatePriority ($nodeID, $priorityArray=array(), $priorityIDArray=array())
 Updates the priority of a node. More...
 
static updateSection ($nodeID, $selectedSectionID)
 Assigns a node to a section. More...
 
static updateSectionID ($objectID, $versionNum)
 

Detailed Description

Member Function Documentation

static eZContentOperationCollection::addAssignment (   $nodeID,
  $objectID,
  $selectedNodeIDArray 
)
static

Adds a new nodeAssignment.

Parameters
int$nodeID
int$objectId
array$selectedNodeIDArray
Returns
array An array with operation status, always true
static eZContentOperationCollection::attributePublishAction (   $objectID,
  $versionNum 
)
static
eZContentOperationCollection::beginPublish ( )

Start global transaction.

Deprecated:
since version 4.1.0, this method will be removed in future major releases
static eZContentOperationCollection::changeHideStatus (   $nodeID)
static

Changes an contentobject's status.

Parameters
int$nodeID
Returns
array An array with operation status, always true
static eZContentOperationCollection::changeSortOrder (   $nodeID,
  $sortingField,
  $sortingOrder = false 
)
static

Changes the sort order for a node.

Parameters
int$nodeID
string$sortingField
bool$sortingOrder
Returns
array An array with operation status, always true
static eZContentOperationCollection::changeTranslationAvailableStatus (   $objectID,
  $status = false 
)
static

Changes the status of a translation.

Parameters
int$objectID
int$status
Returns
array An array with operation status, always true
static eZContentOperationCollection::clearObjectViewCache (   $objectID,
  $versionNum = true,
  $additionalNodeList = false 
)
static

Clears the related viewcaches for the content object using the smart viewcache system.

Parameters
$objectIDThe ID of the content object to clear caches for
$versionNumThe version of the object to use or true for current version
$additionalNodeListAn array with node IDs to add to clear list, or false for no additional nodes.
static eZContentOperationCollection::copyTranslations (   $objectID,
  $versionNum 
)
static

Copies missing translations from published version to the draft.

static eZContentOperationCollection::createFeedForNode (   $nodeID)
static

Creates a RSS/ATOM Feed export for a node.

Parameters
int$nodeIDNode ID
Since
4.3
static eZContentOperationCollection::createNotificationEvent (   $objectID,
  $versionNum 
)
static
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 eZContentOperationCollection::deleteObject (   $deleteIDArray,
  $moveToTrash = false 
)
static

Deletes a content object, or a list of content objects.

Parameters
array$deleteIDArray
bool$moveToTrash
Returns
array An array with operation status, always true
eZContentOperationCollection::endPublish ( )

Stop (commit) global transaction.

Deprecated:
since version 4.1.0, this method will be removed in future major releases
static eZContentOperationCollection::executePrePublishTrigger (   $objectID,
  $version 
)
static

Executes the pre-publish trigger for this object, and handles specific return statuses from the workflow.

Parameters
int$objectIDObject ID
int$versionVersion number
Since
4.2
eZContentOperationCollection::eZContentOperationCollection ( )

Constructor

static eZContentOperationCollection::generateObjectViewCache (   $objectID)
static

Generates the related viewcaches (PreGeneration) for the content object. It will only do this if [ContentSettings]/PreViewCache in site.ini is enabled.

Parameters
$objectIDThe ID of the content object to generate caches for.
static eZContentOperationCollection::loopNodeAssignment (   $objectID,
  $versionNum 
)
static
static eZContentOperationCollection::loopNodes (   $nodeID)
static
static eZContentOperationCollection::moveNode (   $nodeID,
  $objectID,
  $newParentNodeID 
)
static

Moves a node.

Parameters
int$nodeID
int$objectID
int$newParentNodeID
Returns
array An array with operation status, always true
static eZContentOperationCollection::publishNode (   $parentNodeID,
  $objectID,
  $versionNum,
  $mainNodeID 
)
static
eZContentOperationCollection::publishObjectExtensionHandler (   $contentObjectID,
  $contentObjectVersion 
)
static eZContentOperationCollection::readNode (   $nodeID)
static
static eZContentOperationCollection::readObject (   $nodeID,
  $userID,
  $languageCode 
)
static
static eZContentOperationCollection::registerSearchObject (   $objectID,
  $versionNum 
)
static

Registers the object in search engine.

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.
Parameters
int$objectIDId of the object.
int$versionNumVersion of the object.

Referenced by removeAssignment(), removeNodes(), and removeTranslation().

static eZContentOperationCollection::removeAssignment (   $nodeID,
  $objectID,
  $removeList,
  $moveToTrash 
)
static

Removes a nodeAssignment or a list of nodeAssigments.

Deprecated:
since 4.3
Parameters
int$nodeID
int$objectID
array$removeList
bool$moveToTrash
Returns
array An array with operation status, always true
static eZContentOperationCollection::removeFeedForNode (   $nodeID)
static

Removes a RSS/ATOM Feed export for a node.

Parameters
int$nodeIDNode ID
Since
4.3
static eZContentOperationCollection::removeNodes ( array  $removeNodeIdList)
static

Removes nodes.

This function does not check about permissions, this is the responsibility of the caller!

Parameters
array$removeNodeIdListArray of Node ID to remove
Returns
array An array with operation status, always true
static eZContentOperationCollection::removeOldNodes (   $objectID,
  $versionNum 
)
static
static eZContentOperationCollection::removeTemporaryDrafts (   $objectID,
  $versionNum 
)
static
static eZContentOperationCollection::removeTranslation (   $objectID,
  $languageIDArray 
)
static

Removes a translation for a contentobject.

Parameters
int$objectID
array
Returns
array An array with operation status, always true
static eZContentOperationCollection::resetNodeassignmentOpcodes (   $objectID,
  $versionNum 
)
static
static eZContentOperationCollection::sendToPublishingQueue (   $objectId,
  $version 
)
static

Sends the published object/version for publishing to the queue Used by the content/publish operation.

Parameters
int$objectId
int$version
Returns
array( status => int )
Since
4.5
static eZContentOperationCollection::setObjectStatusPublished (   $objectID,
  $versionNum 
)
static
static eZContentOperationCollection::setVersionStatus (   $objectID,
  $versionNum,
  $status 
)
static
static eZContentOperationCollection::swapNode (   $nodeID,
  $selectedNodeID,
  $nodeIdList = array() 
)
static

Swap a node with another one.

Parameters
int$nodeID
int$selectedNodeID
array$nodeIdList
Returns
array An array with operation status, always true
static eZContentOperationCollection::updateAlwaysAvailable (   $objectID,
  $newAlwaysAvailable 
)
static

Set the always available flag for a content object.

Parameters
int$objectID
int$newAlwaysAvailable
Returns
array An array with operation status, always true
static eZContentOperationCollection::updateInitialLanguage (   $objectID,
  $newInitialLanguageID 
)
static

Updates an contentobject's initial language.

Parameters
int$objectID
int$newInitialLanguageID
Returns
array An array with operation status, always true
static eZContentOperationCollection::UpdateMainAssignment (   $mainAssignmentID,
  $ObjectID,
  $mainAssignmentParentID 
)
static

Update a node's main assignment.

Parameters
int$mainAssignmentID
int$objectID
int$mainAssignmentParentID
Returns
array An array with operation status, always true
static eZContentOperationCollection::updateNontranslatableAttributes (   $objectID,
  $versionNum 
)
static

Updates non-translatable attributes.

static eZContentOperationCollection::updateObjectState (   $objectID,
  $selectedStateIDList 
)
static

Update a contentobject's state.

Parameters
int$objectID
int$selectedStateIDList
Returns
array An array with operation status, always true

Referenced by stateEditActionCheck().

static eZContentOperationCollection::updatePriority (   $nodeID,
  $priorityArray = array(),
  $priorityIDArray = array() 
)
static

Updates the priority of a node.

Parameters
int$nodeID
array$priorityArray
array$priorityArray
Returns
array An array with operation status, always true
static eZContentOperationCollection::updateSection (   $nodeID,
  $selectedSectionID 
)
static

Assigns a node to a section.

Parameters
int$nodeID
int$selectedSectionID
Returns
array An array with operation status, always true

Referenced by sectionEditActionCheck().

static eZContentOperationCollection::updateSectionID (   $objectID,
  $versionNum 
)
static

Referenced by publishNode().


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