eZPublish  4.5
ezpContentPublishingProcess Class Reference
+ Inheritance diagram for ezpContentPublishingProcess:
+ Collaboration diagram for ezpContentPublishingProcess:

Public Member Functions

 isAlive ()
 Checks if the system process is running. More...
 
 publish ()
 Starts the publishing process for the linked version. More...
 
 reset ()
 Resets the current process to the PENDING state. More...
 
 version ()
 Returns the version object the process is linked to. More...
 
- 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 currentWorkingProcessCount ()
 Returns the number of currently working publishing processes. More...
 
static definition ()
 eZPersistentObject definition More...
 
static fetchByContentObjectVersion ($contentObjectId, $version)
 Fetches a process by its content object ID + version. More...
 
static fetchByContentVersionId ($contentObjectVersionId)
 Fetches a process by its content object version. More...
 
static fetchProcesses ($status)
 Fetches processes, filtered by status. More...
 
static isProcessing (eZContentObjectVersion $versionObject)
 Checks if an object is already being processed. More...
 
static queue (eZContentObjectVersion $version)
 Adds a version to the publishing queue. More...
 
- 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

const STATUS_DEFERRED = 4
 Set when an operation is deferred to crontab. More...
 
const STATUS_FINISHED = 2
 
const STATUS_PENDING = 3
 
const STATUS_UNKNOWN = 5
 Joker status, used for non handling operation results. More...
 
const STATUS_WORKING = 1
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 Whether the data is dirty, ie needs to be stored, or not. More...
 

Private Attributes

 $versionObject = null
 

Member Function Documentation

static ezpContentPublishingProcess::currentWorkingProcessCount ( )
static

Returns the number of currently working publishing processes.

Returns
int

Referenced by ezpContentPublishingQueueProcessor\isSlotAvailable().

static ezpContentPublishingProcess::definition ( )
static

eZPersistentObject definition

Returns
array

Referenced by ezpContentPublishingQueue\next().

static ezpContentPublishingProcess::fetchByContentObjectVersion (   $contentObjectId,
  $version 
)
static

Fetches a process by its content object ID + version.

Parameters
int$contentObjectId
int$version
Returns
ezpContentPublishingProcess

Referenced by ezpContentPublishingQueue\isQueued().

static ezpContentPublishingProcess::fetchByContentVersionId (   $contentObjectVersionId)
static

Fetches a process by its content object version.

Parameters
int$contentObjectVersionId
Returns
ezpContentPublishingProcess
static ezpContentPublishingProcess::fetchProcesses (   $status)
static

Fetches processes, filtered by status.

Parameters
int$statusOne of ezpContentPublishingProcess::STATUS_*
Returns
array( ezpContentPublishingProcess )

Referenced by ezpContentPublishingQueueProcessor\cleanupDeadProcesses().

ezpContentPublishingProcess::isAlive ( )

Checks if the system process is running.

Returns
bool
Exceptions
Exceptionif the process isn't in WORKING status
static ezpContentPublishingProcess::isProcessing ( eZContentObjectVersion  $versionObject)
static

Checks if an object is already being processed.

Parameters
eZContentObjectVersion$versionObject
Returns
bool
ezpContentPublishingProcess::publish ( )

Starts the publishing process for the linked version.

Returns
bool
static ezpContentPublishingProcess::queue ( eZContentObjectVersion  $version)
static

Adds a version to the publishing queue.

Parameters
eZContentObjectVersion$version
Returns
ezpContentPublishingProcess

Referenced by ezpContentPublishingQueue\add().

ezpContentPublishingProcess::reset ( )

Resets the current process to the PENDING state.

Todo:
Monitor the reset operation, using some kind of counter. The process must NOT get high priority, as it might block a slot if it fails constantly Maybe use a STATUS_RESET status, that gives lower priority to the item
ezpContentPublishingProcess::version ( )

Returns the version object the process is linked to.

Returns
eZContentObjectVersion

Referenced by publish().

Member Data Documentation

ezpContentPublishingProcess::$versionObject = null
private

Referenced by version().

const ezpContentPublishingProcess::STATUS_DEFERRED = 4

Set when an operation is deferred to crontab.

const ezpContentPublishingProcess::STATUS_FINISHED = 2
const ezpContentPublishingProcess::STATUS_PENDING = 3
const ezpContentPublishingProcess::STATUS_UNKNOWN = 5

Joker status, used for non handling operation results.

const ezpContentPublishingProcess::STATUS_WORKING = 1

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