eZPublishCommunityProject(LegacyStack)  2013.6
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)
 Returns the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched. More...
 
 attributes ()
 Returns the attributes for this object, taken from the definition fields and function attributes. More...
 
 eZPersistentObject ($row)
 Initializes the object with the $row. More...
 
 fill ($row)
 Tries to fill in the data in the object by using the object definition which is returned by the function definition() and the database row data $row. More...
 
 hasAttribute ($attr)
 Checks if $attr is part of the definition fields or function attributes. More...
 
 hasDirtyData ()
 Returns true if the data is considered dirty and needs to be stored. More...
 
 remove ($conditions=null, $extraConditions=null)
 Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. More...
 
 setAttribute ($attr, $val)
 Sets the attribute $attr to the value $val. More...
 
 setHasDirtyData ($hasDirtyData)
 Sets whether the object has dirty data or not. More...
 
 store ($fieldFilters=null)
 Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it. More...
 
 sync ($fieldFilters=null)
 Makes sure data is stored if the data is considered dirty. More...
 

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)
 Calls conditionTextByRow with an empty row and $conditions. More...
 
static conditionTextByRow ($conditions, $row)
 Generates an SQL sentence from the conditions $conditions and row data $row. More...
 
static count ($def, $conds=null, $field=null)
 Fetches the number of rows by using the object definition. More...
 
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array. More...
 
static escapeArray ($array)
 Escapes strings in an array with the help of eZDBInterface::escapeString(). More...
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 Fetches and returns an object based on the given parameters and returns is either as an object or as an array. More...
 
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)
 Creates an SQL query out of the different parameters and returns an array with the result. More...
 
static getShortAttributeName ($db, $def, $attrName)
 Returns the short attribute name (alias) if it's defined, given attribute name otherwise. More...
 
static handleRows ($rows, $class_name, $asObject)
 Creates PHP objects out of the database rows $rows. More...
 
static newObjectOrder ($def, $orderField, $conditions)
 Returns an order value which can be used for new items in table, for instance placement. More...
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 Deletes the object from the table defined in $def with conditions $conditions and extra conditions $extraConditions. More...
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 Moves a row in a database table. More...
 
static replaceFieldsWithShortNames ($db, $fieldDefs, &$fields)
 For the given array $fields treats its keys (for associative array) or values (for non-associative array) as table fields names and replaces them with short names (aliases) found in $fieldDefs. More...
 
static storeObject ($obj, $fieldFilters=null)
 Stores the data in $obj to database. More...
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 Sets row id $id2 to have the placement of row id $id1. More...
 
static updateObjectList ($parameters)
 Updates rows matching the given parameters. More...
 

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
 

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.

After publishing, the child process is terminated.

Returns
false|int false if the fork fails, the pid of the child process after the fork
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

Referenced by publish().

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: