kernel/content/ezcontentoperationcollection.php

Show:

inherited

Classes
- \eZContentOperationCollection

Table of Contents

File containing the eZContentOperationCollection class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Package: kernel
Version: 4.6.0

\eZContentOperationCollection
jump to top

Package: kernel

File containing the eZContentOperationCollection class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Version: 4.6.0

Methods

UpdateMainAssignment(
          int $mainAssignmentID,  $ObjectID, int $mainAssignmentParentID
          )
        
        :
          array

static

Update a node's main assignment

Parameters

Name	Type	Description
$mainAssignmentID	int
$ObjectID
$mainAssignmentParentID	int

Returns

Type	Description
array	An array with operation status, always true

addAssignment(
          int $nodeID,  $objectID, array $selectedNodeIDArray
          )
        
        :
          array

static

Adds a new nodeAssignment

Parameters

Name	Type	Description
$nodeID	int
$objectID
$selectedNodeIDArray	array

Returns

Type	Description
array	An array with operation status, always true

attributePublishAction(
           $objectID,  $versionNum
          )
        
        :
          void

static

Parameters

Name	Type	Description
$objectID
$versionNum

beginPublish(
          
          )
        
        :
          void

changeHideStatus(
          int $nodeID
          )
        
        :
          array

static

Changes an contentobject's status

Parameters

Name	Type	Description
$nodeID	int

Returns

Type	Description
array	An array with operation status, always true

changeSortOrder(
          int $nodeID, string $sortingField, bool $sortingOrder
              =
              false
          )
        
        :
          array

static

Changes the sort order for a node

Parameters

Name	Type	Description
$nodeID	int
$sortingField	string
$sortingOrder	bool

Returns

Type	Description
array	An array with operation status, always true

changeTranslationAvailableStatus(
          int $objectID, int $status
              =
              false
          )
        
        :
          array

static

Changes the status of a translation

Parameters

Name	Type	Description
$objectID	int
$status	int

Returns

Type	Description
array	An array with operation status, always true

clearObjectViewCache(
           $objectID,  $versionNum
              =
              true,  $additionalNodeList
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$objectID
$versionNum
$additionalNodeList

copyTranslations(
           $objectID,  $versionNum
          )
        
        :
          void

static

Parameters

Name	Type	Description
$objectID
$versionNum

createFeedForNode(
          int $nodeID
          )
        
        :
          void

static

Creates a RSS/ATOM Feed export for a node

Parameters

Name	Type	Description
$nodeID	int	Node ID

Details

Since: 4.3

createNotificationEvent(
           $objectID,  $versionNum
          )
        
        :
          void

static

Parameters

Name	Type	Description
$objectID
$versionNum

deleteObject(
          array $deleteIDArray, bool $moveToTrash
              =
              false
          )
        
        :
          array

static

Deletes a content object, or a list of content objects

Parameters

Name	Type	Description
$deleteIDArray	array
$moveToTrash	bool

Returns

Type	Description
array	An array with operation status, always true

eZContentOperationCollection(
          
          )
        
        :
          void

endPublish(
          
          )
        
        :
          void

executePrePublishTrigger(
          int $objectID, int $version
          )
        
        :
          void

static

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

Parameters

Name	Type	Description
$objectID	int	Object ID
$version	int	Version number

Details

Since: 4.2

generateObjectViewCache(
           $objectID
          )
        
        :
          void

static

Parameters

Name	Type	Description
$objectID

loopNodeAssignment(
           $objectID,  $versionNum
          )
        
        :
          void

static

Parameters

Name	Type	Description
$objectID
$versionNum

loopNodes(
           $nodeID
          )
        
        :
          void

static

Parameters

Name	Type	Description
$nodeID

moveNode(
          int $nodeID, int $objectID, int $newParentNodeID
          )
        
        :
          array

static

Moves a node

Parameters

Name	Type	Description
$nodeID	int
$objectID	int
$newParentNodeID	int

Returns

Type	Description
array	An array with operation status, always true

publishNode(
           $parentNodeID,  $objectID,  $versionNum,  $mainNodeID
          )
        
        :
          void

static

Parameters

Name	Type	Description
$parentNodeID
$objectID
$versionNum
$mainNodeID

publishObjectExtensionHandler(
           $contentObjectID,  $contentObjectVersion
          )
        
        :
          void

Parameters

Name	Type	Description
$contentObjectID
$contentObjectVersion

readNode(
           $nodeID
          )
        
        :
          void

static

Parameters

Name	Type	Description
$nodeID

readObject(
           $nodeID,  $userID,  $languageCode
          )
        
        :
          void

static

Parameters

Name	Type	Description
$nodeID
$userID
$languageCode

registerSearchObject(
          int $objectID, int $versionNum
          )
        
        :
          void

static

Registers the object in search engine.

Parameters

Name	Type	Description
$objectID	int	Id of the object.
$versionNum	int	Version of the object.

Details

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.

removeAssignment(
          int $nodeID, int $objectID, array $removeList, bool $moveToTrash
          )
        
        :
          array

static

Removes a nodeAssignment or a list of nodeAssigments

Parameters

Name	Type	Description
$nodeID	int
$objectID	int
$removeList	array
$moveToTrash	bool

Returns

Type	Description
array	An array with operation status, always true

Details

Deprecated: since 4.3

removeFeedForNode(
          int $nodeID
          )
        
        :
          void

static

Removes a RSS/ATOM Feed export for a node

Parameters

Name	Type	Description
$nodeID	int	Node ID

Details

Since: 4.3

removeNodes(
          array $removeNodeIdList
          )
        
        :
          array

static

Removes nodes

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

Parameters

Name	Type	Description
$removeNodeIdList	array	Array of Node ID to remove

Returns

Type	Description
array	An array with operation status, always true

removeOldNodes(
           $objectID,  $versionNum
          )
        
        :
          void

static

Parameters

Name	Type	Description
$objectID
$versionNum

removeTemporaryDrafts(
           $objectID,  $versionNum
          )
        
        :
          void

static

Parameters

Name	Type	Description
$objectID
$versionNum

removeTranslation(
          int $objectID,  $languageIDArray
          )
        
        :
          array

static

Removes a translation for a contentobject

Parameters

Name	Type	Description
$objectID	int
$languageIDArray		array

Returns

Type	Description
array	An array with operation status, always true

resetNodeassignmentOpcodes(
           $objectID,  $versionNum
          )
        
        :
          void

static

Parameters

Name	Type	Description
$objectID
$versionNum

sendToPublishingQueue(
          int $objectId, int $version
          )
        
        :
          \array(

static

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

Parameters

Name	Type	Description
$objectId	int
$version	int

Returns

Type	Description
\array(	status => int )

Details

Since: 4.5

setObjectStatusPublished(
           $objectID,  $versionNum
          )
        
        :
          void

static

Parameters

Name	Type	Description
$objectID
$versionNum

setVersionStatus(
           $objectID,  $versionNum,  $status
          )
        
        :
          void

static

Parameters

Name	Type	Description
$objectID
$versionNum
$status

swapNode(
          int $nodeID, int $selectedNodeID, array $nodeIdList
              =
              array()
          )
        
        :
          array

static

Swap a node with another one

Parameters

Name	Type	Description
$nodeID	int
$selectedNodeID	int
$nodeIdList	array

Returns

Type	Description
array	An array with operation status, always true

updateAlwaysAvailable(
          int $objectID, int $newAlwaysAvailable
          )
        
        :
          array

static

Set the always available flag for a content object

Parameters

Name	Type	Description
$objectID	int
$newAlwaysAvailable	int

Returns

Type	Description
array	An array with operation status, always true

updateInitialLanguage(
          int $objectID, int $newInitialLanguageID
          )
        
        :
          array

static

Updates an contentobject's initial language

Parameters

Name	Type	Description
$objectID	int
$newInitialLanguageID	int

Returns

Type	Description
array	An array with operation status, always true

updateNontranslatableAttributes(
           $objectID,  $versionNum
          )
        
        :
          void

static

Parameters

Name	Type	Description
$objectID
$versionNum

updateObjectState(
          int $objectID, int $selectedStateIDList
          )
        
        :
          array

static

Update a contentobject's state

Parameters

Name	Type	Description
$objectID	int
$selectedStateIDList	int

Returns

Type	Description
array	An array with operation status, always true

updatePriority(
          int $nodeID, array | array $priorityArray
              =
              array(),  $priorityIDArray
              =
              array()
          )
        
        :
          array

static

Updates the priority of a node

Parameters

Name	Type	Description
$nodeID	int
$priorityArray	array \| array
$priorityIDArray

Returns

Type	Description
array	An array with operation status, always true

updateSection(
          int $nodeID, int $selectedSectionID
          )
        
        :
          array

static

Assigns a node to a section

Parameters

Name	Type	Description
$nodeID	int
$selectedSectionID	int

Returns

Type	Description
array	An array with operation status, always true

updateSectionID(
           $objectID,  $versionNum
          )
        
        :
          void

static

Parameters

Name	Type	Description
$objectID
$versionNum

kernel/content/ezcontentoperationcollection.php

\eZContentOperationCollectionjump to top

Methods

\eZContentOperationCollection
jump to top