PHP Class WorkflowRequest, googleads-php-lib

Only one workflow request can be active for any given page; however, a page may have a number of historical, closed workflow requests. The WorkflowRequest object shouldn't be directly edited. Instead, you call "workflow step" methods on the object, that will update the object appropriately. To create or retrieve a WorkflowRequest object, call {@link SiteTreeCMSWorkflow::openOrNewWorkflowRequest()} or {@link SiteTreeCMSWorkflow::openWorkflowRequest()} on the relevant {@link SiteTree} object. The following examples show how a workflow can be created. Request publication:


$wf = $page->openOrNewWorkflowRequest('WorkflowPublicationRequest')
$wf->request("Can you please publish this page");

Reject changes:


$wf = $page->openWorkflowRequest()
$wf->deny("It's not acceptable.  Please correct the spelling.");

Approve changes:


$wf = $page->openWorkflowRequest()
$wf->approve("Thanks, looks good now");

Make the changes 'go live' changes:


$wf = $page->openWorkflowRequest()
$wf->action();

{@link WorkflowRequest::Changes()} will provide a list of the changes that the workflow has gone through, suitable for presentation as a discussion thread attached to the page.

Inheritance: extends DataObject, implements i18nEntityProvider

Show file Open project: googleads/googleads-php-lib Class Usage Examples

Public Properties

Property	Type	Description
$entityId	integer
$entityType	tnsWorkflowEntityType
$id	integer
$type	tnsWorkflowRequestType
$workflowRuleName	string

Public Methods

Method	Description
__construct ( $id = null, $workflowRuleName = null, $entityId = null, $entityType = null, $type = null )
getNamespace ( ) : string	Gets the namesapce of this class
getXsiTypeName ( ) : string	Gets the xsi:type name of this class

Method Details

__construct() public method

public __construct ( $id = null, $workflowRuleName = null, $entityId = null, $entityType = null, $type = null )

getNamespace() public method

Gets the namesapce of this class

public getNamespace ( ) : string
return	string	the namespace of this class

getXsiTypeName() public method

Gets the xsi:type name of this class

public getXsiTypeName ( ) : string
return	string	the xsi:type name of this class

Property Details

$entityId public property

public int $entityId
return	integer

$entityType public property

public tnsWorkflowEntityType $entityType
return	tnsWorkflowEntityType

$id public property

public int $id
return	integer

$type public property

public tnsWorkflowRequestType $type
return	tnsWorkflowRequestType

$workflowRuleName public property

public string $workflowRuleName
return	string