Zikula_Core
[ class tree: Zikula_Core ] [ index: Zikula_Core ] [ all elements ]

Class: pnWorkflow

Source Location: /includes/pnobjlib/WorkflowUtil.class.php

Class Overview


pnWorkflow class


Variables

Methods



Class Details

[line 461]
pnWorkflow class



[ Top ]


Class Variables

$actionMap =

[line 684]


Type:   mixed


[ Top ]

$description =

[line 682]


Type:   mixed


[ Top ]

$id =

[line 680]


Type:   mixed


[ Top ]

$module =

[line 679]


Type:   mixed


[ Top ]

$stateMap =

[line 683]


Type:   mixed


[ Top ]

$title =

[line 681]


Type:   mixed


[ Top ]

$workflowData =

[line 685]


Type:   mixed


[ Top ]



Class Methods


constructor pnWorkflow [line 474]

object pnWorkflow pnWorkflow( $id $schema, $title $module, $description 2, $states 3, $actions 4, $configurations 5)

Enter description here...



Parameters:

$description   2  
$states   3  
$actions   4  
$configurations   5  
$id   $schema  
$title   $module  

[ Top ]

method executeAction [line 553]

mixed executeAction( string $actionID, &$obj, [string $stateID = 'initial'], array $obj)

execute workflow action



Tags:

return:  array or false


Parameters:

string   $actionID  
array   $obj  
string   $stateID  
   &$obj  

[ Top ]

method executeOperation [line 614]

mixed executeOperation( string $operation, &$obj, $nextState, array $data)

execute workflow operation within action



Tags:

return:  or false


Parameters:

string   $operation  
array   $data  
   &$obj  
   $nextState  

[ Top ]

method getDescription [line 664]

string getDescription( )

get workflow description



Tags:

return:  description


[ Top ]

method getID [line 642]

string getID( )

get workflow ID



Tags:

return:  workflow schema name


[ Top ]

method getModule [line 675]

string getModule( )

get workflow Module



Tags:

return:  module name


[ Top ]

method getTitle [line 653]

string getTitle( )

get workflow title



Tags:

return:  title


[ Top ]

method registerWorkflow [line 497]

bool registerWorkflow( &$obj, [ $stateID = null], object $workflow, array $data, string $state)

register workflow by $metaId



Parameters:

object   $workflow  
array   $data  
string   $state   default=null;
   &$obj  
   $stateID  

[ Top ]

method updateWorkflowState [line 529]

bool updateWorkflowState( string $stateID, [string $debug = null])

update workflow state



Parameters:

string   $stateID  
string   $debug  

[ Top ]


Documentation generated on Fri, 18 Jul 2008 21:59:17 +0200 by phpDocumentor 1.4.1