Class PublishImmediately

Description

A pipeline class that publishes all items submitted immediately

Located in /core/pipelines/PublishImmediately.inc (line 17)

pipelineBase
   |
   --PublishImmediately
Method Summary
object returns getObjectInPipeline (string $GUID)
array getStatus (mixed $GUID)
void processPipeline ()
bool submitToStart (string $_guid, object $_data)
Variables

Inherited Variables

Inherited from pipelineBase

pipelineBase::$context
Methods
getObjectInPipeline (line 92)

returns the data associated with a GUID

  • return: the object data, or NULL if not successful
  • access: public
object returns getObjectInPipeline (string $GUID)
  • string $GUID: the guid to get the data for

Redefinition of:
pipelineBase::getObjectInPipeline()
gets the data for a PagePart, no matter where it is in the Pipeline processing
getStatus (line 81)

gets the status of an object in the pipeline

  • return: returns an array: array(["status"]=> Pending|Published; ["description"]=> extended description)
  • access: public
  • todo: should return status=> "ERROR" if the GUID does not exist
array getStatus (mixed $GUID)

Redefinition of:
pipelineBase::getStatus()
gets an associative array with data describing the status of a PagePart inside of the Pipeline
processPipeline (line 71)

called when the pipeline is processed

  • access: public
void processPipeline ()

Redefinition of:
pipelineBase::processPipeline()
process all items in the pipeline. Moves items to the next stage of the Pipeline if they are ready.
submitToStart (line 25)

submits data with a given guid to the start of the pipeline

  • return: returns TRUE if successfully submitted, FALSE if not
  • access: public
bool submitToStart (string $_guid, object $_data)
  • string $_guid: the guid of the data being submitted
  • object $_data: any object that will be submitted to the start

Redefinition of:
pipelineBase::submitToStart()
adds an object to the pipeline, and stores it.

Inherited Methods

Inherited From pipelineBase

pipelineBase::__construct()
pipelineBase::getObjectInPipeline()
pipelineBase::getStatus()
pipelineBase::processPipeline()
pipelineBase::submitToStart()

Documentation generated on Tue, 4 Oct 2005 21:59:29 -0700 by phpDocumentor 1.3.0RC3