kernel/private/classes/ezpcontentpublishingprocess.php

Show:

inherited

Classes
- \ezpContentPublishingProcess

Table of Contents

File containing the ezpContentPublishingQueueProcess class.

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

\ezpContentPublishingProcess
jump to top

Package: kernel\content

This class provides a PersistentObject interface to a publishing queue process.

Parent(s): \eZPersistentObject
Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
Version: 4.6.0

Constants

 
                STATUS_WORKING
                = 1

 
                STATUS_FINISHED
                = 2

 
                STATUS_PENDING
                = 3

 
                STATUS_DEFERRED
                = 4

Set when an operation is deferred to crontab

 
                STATUS_UNKNOWN
                = 5

Joker status, used for non handling operation results

Properties


                 $PersistentDataDirty= ''

inheritedInherited from: \eZPersistentObject::$$PersistentDataDirty

Details

Type: n/a
Inherited_from: \eZPersistentObject::$$PersistentDataDirty


                 $versionObject= 'null'

Default valuenullDetails

Type: n/a

Methods

attribute(
           $attr,  $noFunction
              =
              false
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::attribute()

Parameters

Name	Type	Description
$attr
$noFunction

attributes(
          
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::attributes()

conditionText(
           $conditions
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::conditionText()

Parameters

Name	Type	Description
$conditions

conditionTextByRow(
           $conditions,  $row
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::conditionTextByRow()

Parameters

Name	Type	Description
$conditions
$row

count(
           $def,  $conds
              =
              null,  $field
              =
              null
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::count()

Parameters

Name	Type	Description
$def
$conds
$field

currentWorkingProcessCount(
          
          )
        
        :
          int

static

Returns the number of currently working publishing processes

Returns

Type	Description
int

definition(
          
          )
        
        :
          array

static

eZPersistentObject definition

Returns

Type	Description
array

eZPersistentObject(
           $row
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::eZPersistentObject()

Parameters

Name	Type	Description
$row

escapeArray(
           $array
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::escapeArray()

Parameters

Name	Type	Description
$array

fetchByContentObjectVersion(
          int $contentObjectId, int $version
          )
        
        :
          \ezpContentPublishingProcess

static

Fetches a process by its content object ID + version

Parameters

Name	Type	Description
$contentObjectId	int
$version	int

Returns

Type	Description
\ezpContentPublishingProcess

fetchByContentVersionId(
          int $contentObjectVersionId
          )
        
        :
          \ezpContentPublishingProcess

static

Fetches a process by its content object version

Parameters

Name	Type	Description
$contentObjectVersionId	int

Returns

Type	Description
\ezpContentPublishingProcess

fetchObject(
           $def,  $field_filters,  $conds,  $asObject
              =
              true,  $grouping
              =
              null,  $custom_fields
              =
              null
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::fetchObject()

Parameters

Name	Type	Description
$def
$field_filters
$conds
$asObject
$grouping
$custom_fields

fetchObjectList(
           $def,  $field_filters
              =
              null,  $conds
              =
              null,  $sorts
              =
              null,  $limit
              =
              null,  $asObject
              =
              true,  $grouping
              =
              false,  $custom_fields
              =
              null,  $custom_tables
              =
              null,  $custom_conds
              =
              null
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::fetchObjectList()

Parameters

Name	Type	Description
$def
$field_filters
$conds
$sorts
$limit
$asObject
$grouping
$custom_fields
$custom_tables
$custom_conds

fetchProcesses(
          int $status
          )
        
        :
          \array(

static

Fetches processes, filtered by status

Parameters

Name	Type	Description
$status	int	One of ezpContentPublishingProcess::STATUS_*

Returns

Type	Description
\array(	ezpContentPublishingProcess )

fill(
           $row
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::fill()

Parameters

Name	Type	Description
$row

getShortAttributeName(
           $db,  $def,  $attrName
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::getShortAttributeName()

Parameters

Name	Type	Description
$db
$def
$attrName

handleRows(
           $rows,  $class_name,  $asObject
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::handleRows()

Parameters

Name	Type	Description
$rows
$class_name
$asObject

hasAttribute(
           $attr
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::hasAttribute()

Parameters

Name	Type	Description
$attr

hasDirtyData(
          
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::hasDirtyData()

isAlive(
          
          )
        
        :
          bool

Checks if the system process is running

Returns

Type	Description
bool

Throws

Exception	Description
\Exception	if the process isn't in WORKING status

isProcessing(
          \eZContentObjectVersion $versionObject
          )
        
        :
          bool

static

Checks if an object is already being processed

Parameters

Name	Type	Description
$versionObject	\eZContentObjectVersion

Returns

Type	Description
bool

newObjectOrder(
           $def,  $orderField,  $conditions
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::newObjectOrder()

Parameters

Name	Type	Description
$def
$orderField
$conditions

publish(
          
          )
        
        :
          bool

Starts the publishing process for the linked version

Returns

Type	Description
bool

queue(
          \eZContentObjectVersion $version
          )
        
        :
          \ezpContentPublishingProcess

static

Adds a version to the publishing queue

Parameters

Name	Type	Description
$version	\eZContentObjectVersion

Returns

Type	Description
\ezpContentPublishingProcess

remove(
           $conditions
              =
              null,  $extraConditions
              =
              null
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::remove()

Parameters

Name	Type	Description
$conditions
$extraConditions

removeObject(
           $def,  $conditions
              =
              null,  $extraConditions
              =
              null
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::removeObject()

Parameters

Name	Type	Description
$def
$conditions
$extraConditions

reorderObject(
           $def,  $orderField,  $conditions,  $down
              =
              true
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::reorderObject()

Parameters

Name	Type	Description
$def
$orderField
$conditions
$down

replaceFieldsWithShortNames(
           $db,  $fieldDefs,  $fields
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::replaceFieldsWithShortNames()

Parameters

Name	Type	Description
$db
$fieldDefs
$fields

Resets the current process to the PENDING state

Details

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

setAttribute(
           $attr,  $val
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::setAttribute()

Parameters

Name	Type	Description
$attr
$val

setHasDirtyData(
           $hasDirtyData
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::setHasDirtyData()

Parameters

Name	Type	Description
$hasDirtyData

store(
           $fieldFilters
              =
              null
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::store()

Parameters

Name	Type	Description
$fieldFilters

storeObject(
           $obj,  $fieldFilters
              =
              null
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::storeObject()

Parameters

Name	Type	Description
$obj
$fieldFilters

swapRow(
           $table,  $keys,  $order_id,  $rows,  $id1,  $id2
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::swapRow()

Parameters

Name	Type	Description
$table
$keys
$order_id
$rows
$id1
$id2

sync(
           $fieldFilters
              =
              null
          )
        
        :
          void

inherited

Inherited from: \eZPersistentObject::sync()

Parameters

Name	Type	Description
$fieldFilters

updateObjectList(
           $parameters
          )
        
        :
          void

staticinherited

Inherited from: \eZPersistentObject::updateObjectList()

Parameters

Name	Type	Description
$parameters

version(
          
          )
        
        :
          \eZContentObjectVersion

Returns the version object the process is linked to

Returns

Type	Description
\eZContentObjectVersion

kernel/private/classes/ezpcontentpublishingprocess.php

\ezpContentPublishingProcessjump to top

Constants

Properties

Methods

\ezpContentPublishingProcess
jump to top