Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Workflow_Bundle_Edit_Fns Class Reference
Inheritance diagram for Workflow_Bundle_Edit_Fns:
Asset_Edit_Fns MySource_Object

Public Member Functions

 __construct ()
 
 paintCurrentStatus (Workflow_Bundle $asset, Backend_Outputter $o, $prefix)
 
 paintCustomStatusChange (Workflow_Bundle $asset, Backend_Outputter $o, $prefix)
 
 processCustomStatusChange (Workflow_Bundle $asset, Backend_Outputter $o, $prefix)
 
 paintFutureStatus (Workflow_Bundle $asset, Backend_Outputter $o, $prefix)
 
 processFutureStatus (Workflow_Bundle $asset, Backend_Outputter $o, $prefix)
 
 paintWorkflow (Workflow_Bundle $asset, Backend_Outputter $o, $prefix)
 
 processWorkflow (Workflow_Bundle $asset, Backend_Outputter $o, $prefix)
 
 showIfCanApprove (Workflow_Bundle $asset)
 
 bundleRequiresComment (Workflow_Bundle $asset)
 
- Public Member Functions inherited from Asset_Edit_Fns
 Asset_Edit_Fns ()
 
 paintPaths (&$asset, &$o, $prefix)
 
 paintEditRemapURLs (&$asset, &$o, $prefix)
 
 processPaths (&$asset, &$o, $prefix)
 
 processEditRemapURLs (&$asset, &$o, $prefix)
 
 paintURLs (&$asset, &$o, $prefix)
 
 paintAddRemapURLs (&$asset, &$o, $prefix)
 
 processAddRemapURLs (&$asset, &$o, $prefix)
 
 isWorkflowComplete (&$asset)
 
 paintNoticeLinkedAsset (&$asset, $link_value, $type_codes=Array(), $field_name='', $multiple=FALSE)
 
 processNoticeLinkedAsset (&$asset, $link_value, $field_name='', $multiple=FALSE)
 
 isSearchInstalled (&$asset, $prefix)
 
 isBeingCreated (&$asset)
 
 isNotBeingCreated (&$asset)
 
 paintAutomaticRemapSetting (&$asset, &$o, $prefix)
 
 paintCreateLink (&$asset, &$o, $prefix)
 
- Public Member Functions inherited from MySource_Object
 MySource_Object ()
 
 __sleep ()
 
 __wakeup ()
 

Additional Inherited Members

- Data Fields inherited from Asset_Edit_Fns
 $static_screens
 

Detailed Description

Definition at line 35 of file workflow_bundle_edit_fns.inc.

Constructor & Destructor Documentation

__construct ( )

Constructor

Definition at line 43 of file workflow_bundle_edit_fns.inc.

Member Function Documentation

bundleRequiresComment ( Workflow_Bundle  $asset)

Test whether approving or rejecting the bundle requires a comment

If at least one of the currently in-workflow-step assets requires a comment (either through being marked as such for the current workflow step, or through "unlisted users"), then the bundle should require one to proceed.

Parameters
Workflow_Bundle$assetThe bundle to test
Returns
boolean

Definition at line 538 of file workflow_bundle_edit_fns.inc.

paintCurrentStatus ( Workflow_Bundle  $asset,
Backend_Outputter  $o,
  $prefix 
)

Handles painting of the Current Status field

Here since it needs custom processing

Parameters
Workflow_Bundle$assetThe asset being processed
Backend_Outputter$oThe outputter class being used
string$prefixPrefix for form elements
Returns
boolean

Definition at line 61 of file workflow_bundle_edit_fns.inc.

paintCustomStatusChange ( Workflow_Bundle  $asset,
Backend_Outputter  $o,
  $prefix 
)

Handles painting of the Status Change field

Here since it needs custom processing

Parameters
Workflow_Bundle$assetThe asset being processed
Backend_Outputter$oThe outputter class being used
string$prefixPrefix for form elements
Returns
boolean

Definition at line 82 of file workflow_bundle_edit_fns.inc.

paintFutureStatus ( Workflow_Bundle  $asset,
Backend_Outputter  $o,
  $prefix 
)

Handles painting of the Future Status section

Here since it needs custom processing. Much the same as printing the future status sections in the normal Details static screen.

Parameters
Workflow_Bundle$assetThe asset being processed
Backend_Outputter$oThe outputter class being used
string$prefixPrefix for form elements
Returns
boolean

Definition at line 295 of file workflow_bundle_edit_fns.inc.

paintWorkflow ( Workflow_Bundle  $asset,
Backend_Outputter  $o,
  $prefix 
)

Paints the custom workflow screen for the bundle

Parameters
Workflow_Bundle$assetThe asset being processed
Backend_Outputter$oThe outputter class being used
string$prefixPrefix for form elements
Returns
boolean

Definition at line 357 of file workflow_bundle_edit_fns.inc.

processCustomStatusChange ( Workflow_Bundle  $asset,
Backend_Outputter  $o,
  $prefix 
)

Handles custom processing of the Status Change field

Makes it use the "Edit Bundled Asset Status" HIPO instead of the normal "Edit Status" HIPO.

NB: called from the paint function since there is nothing that should stop this from running (since being allowed to change is determined by the status object). If we were to call it from the edit interface XML, the lack of write access would block anything from happening.

Parameters
Workflow_Bundle$assetThe asset being processed
Backend_Outputter$oThe outputter class being used
string$prefixPrefix for form elements
Returns
boolean

Definition at line 246 of file workflow_bundle_edit_fns.inc.

processFutureStatus ( Workflow_Bundle  $asset,
Backend_Outputter  $o,
  $prefix 
)

Handles processing of the New Future Status section

Parameters
Workflow_Bundle$assetThe asset being processed
Backend_Outputter$oThe outputter class being used
string$prefixPrefix for form elements
Returns
boolean

Definition at line 338 of file workflow_bundle_edit_fns.inc.

processWorkflow ( Workflow_Bundle  $asset,
Backend_Outputter  $o,
  $prefix 
)

Processes the custom workflow screen for the bundle

NB: called from the paint function since there is nothing that should stop this from running (since being allowed to change is determined by being in a current workflow step). If we were to call it from the edit interface XML, the lack of write access would block anything from happening.

Parameters
Workflow_Bundle$assetThe asset being processed
Backend_Outputter$oThe outputter class being used
string$prefixPrefix for form elements
Returns
boolean

Definition at line 450 of file workflow_bundle_edit_fns.inc.

showIfCanApprove ( Workflow_Bundle  $asset)

Show-if for the custom workflow screen

Show the custom workflow if:

  • We are an admin for the asset (since we can always reject), or
  • We can approve at least one asset in the bundle
Parameters
Workflow_Bundle$assetThe bundle to test
Returns
boolean

Definition at line 496 of file workflow_bundle_edit_fns.inc.


The documentation for this class was generated from the following file: