Class pipelineBase

Description

An abstract class that defines the functions needed for child pipeline classes.

Pipelines are used by the Pomo Website Management System to handle the storage and retrieval of PagePart data.

Examples of possible Pipelines include:

  • Publishing data immediately (the simplest case, implemented in PublishImmediately.inc)
  • Publish data only after approval
  • Publish data only after several approval steps
  • Publish data of only the current revision
Each page can have a Pipeline associated with it, or will inherit it from a parent page. This allows for different sections of your site to have different processing rules.

Located in /core/pipelines/pipelineBase.class.inc (line 29)


	
			
Direct descendents
Class Description
PublishImmediately A pipeline class that publishes all items submitted immediately
Variable Summary
mixed $context
Method Summary
pipelineBase __construct (Context $_context)
mixed getObjectInPipeline (string $GUID)
array getStatus (string $GUID)
void processPipeline ()
bool submitToStart (string $_guid, Mixed $_data)
Variables
mixed $context (line 31)
  • access: public
Methods
Constructor __construct (line 36)

Create the Pipeline Object

pipelineBase __construct (Context $_context)
getObjectInPipeline (line 75)

gets the data for a PagePart, no matter where it is in the Pipeline processing

  • return: the data associated with the PagePart, or NULL on error
  • access: public
  • abstract:
mixed getObjectInPipeline (string $GUID)
  • string $GUID: the GUID of the PagePart that data is requested for.

Redefined in descendants as:
getStatus (line 66)

gets an associative array with data describing the status of a PagePart inside of the Pipeline

  • return: returns an array: array(["status"]=> 'Pending'|'Published'; ["description"]=> 'extended description of status')
  • access: public
  • abstract:
array getStatus (string $GUID)
  • string $GUID: the GUID of the PagePart that data is requested for.

Redefined in descendants as:
processPipeline (line 56)

process all items in the pipeline. Moves items to the next stage of the Pipeline if they are ready.

This function is not currently implemented or well defined.

  • access: public
  • abstract:
void processPipeline ()

Redefined in descendants as:
submitToStart (line 49)

adds an object to the pipeline, and stores it.

  • return: TRUE if submitted and stored, FALSE otherwise
  • access: public
  • abstract:
bool submitToStart (string $_guid, Mixed $_data)
  • string $_guid: The GUID of the PagePart we are submitting data for
  • Mixed $_data: The data to serialize and store in the pipeline

Redefined in descendants as:

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