ilWorkflowScaffold Class Reference

Class ilWorkflowScaffold. More...

Collaboration diagram for ilWorkflowScaffold:

Public Member Functions
	registerRequire ($require)
	getRequires ()
	registerStartEventRef ($start_event_ref)
	registerStartSignalRef ($start_event_ref)
	registerStartTimerRef ($start_event_ref)
	getStartEventInfo ()
	setWorkflowName ($workflow_name)
	addAuxilliaryMethod ($auxilliary_method)
	__construct ($bpmn2_array)
	getConstructorMethodContent ()
	setConstructorMethodContent ($constructor_method_content)
	getPHP ()
	getTimeDateEventDefinition ($start_event_ref)

Data Fields
	$requires = array()
	$constructor_method_content
	$bpmn2_array
	$auxilliary_methods
	$workflow_name
	$start_event_refs

Detailed Description

Class ilWorkflowScaffold.

Author

Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

/

Definition at line 12 of file class.ilWorkflowScaffold.php.

Constructor & Destructor Documentation

__construct()

ilWorkflowScaffold::__construct

(

$bpmn2_array

)

Definition at line 170 of file class.ilWorkflowScaffold.php.

References $bpmn2_array, array, and registerRequire().

        {
                $this->registerRequire('./Services/WorkflowEngine/classes/workflows/class.ilBaseWorkflow.php');
                $this->bpmn2_array = $bpmn2_array;
                $this->auxilliary_methods = array();
        }

Here is the call graph for this function:

Member Function Documentation

addAuxilliaryMethod()

ilWorkflowScaffold::addAuxilliaryMethod

(

$auxilliary_method

)

Parameters

string

$auxilliary_method

Definition at line 165 of file class.ilWorkflowScaffold.php.

        {
                $this->auxilliary_methods[] = $auxilliary_method;
        }

getConstructorMethodContent()

ilWorkflowScaffold::getConstructorMethodContent

(

)

Returns

mixed

Definition at line 180 of file class.ilWorkflowScaffold.php.

References $constructor_method_content.

        {
                return $this->constructor_method_content;
        }

getPHP()

ilWorkflowScaffold::getPHP

(

)

Returns

string

Definition at line 196 of file class.ilWorkflowScaffold.php.

References getRequires(), and getStartEventInfo().

        {
                $pre_constructor_content = $this->getRequires();
                $pre_constructor_content .= "
                class " . $this->workflow_name . " extends ilBaseWorkflow
                {
                " . $this->getStartEventInfo() . "
                        public function __construct()
                        {
                ";

                $post_constructor_content = "
                        }";
                foreach($this->auxilliary_methods as $auxilliary_method)
                {
                        $post_constructor_content .= "

                        " . $auxilliary_method . "
                        ";
                }
                $post_constructor_content .= "
                }
                ";

                return $pre_constructor_content . $this->constructor_method_content . $post_constructor_content;
        }

Here is the call graph for this function:

getRequires()

ilWorkflowScaffold::getRequires

(

)

Returns

string

Definition at line 45 of file class.ilWorkflowScaffold.php.

References $requires.

Referenced by getPHP().

        {
                $requires = '';
                foreach($this->requires as $required_file)
                {
                        $requires .= "require_once '" . $required_file . "';\n";
                }
                return $requires;
        }

Here is the caller graph for this function:

getStartEventInfo()

ilWorkflowScaffold::getStartEventInfo

(

)

Returns

string

Definition at line 89 of file class.ilWorkflowScaffold.php.

References $code, array, ilBPMN2ParserUtils\extractILIASEventDefinitionFromProcess(), and getTimeDateEventDefinition().

Referenced by getPHP().

        {
                $event_definitions = array();
                foreach((array)$this->start_event_refs as $start_event_ref)
                {
                        $event_definition = array();
                        switch($start_event_ref['type'])
                        {
                                case 'message':
                                        $event_definition = ilBPMN2ParserUtils::extractILIASEventDefinitionFromProcess(
                                                $start_event_ref['ref'], 
                                                'message', 
                                                $this->bpmn2_array
                                        );
                                        break;
                                case 'signal':
                                        $event_definition = ilBPMN2ParserUtils::extractILIASEventDefinitionFromProcess(
                                                $start_event_ref['ref'],
                                                'signal',
                                                $this->bpmn2_array
                                        );
                                        break;
                                case 'timeDate':
                                        $event_definition = $this->getTimeDateEventDefinition($start_event_ref['ref']);
                                        break;
                        }
                        $event_definitions[] = $event_definition;
                }

                if(count($event_definitions))
                {
                        $code = '
                        public static $startEventRequired = true;
                        '."
                        public static function getStartEventInfo()
                        {";
                        foreach ($event_definitions as $event_definition)
                        {
                                $code .= '
                                $events[] = ' . "array(
                                        'type'                  => '".$event_definition['type'] ."', 
                                        'content'               => '".$event_definition['content'] ."', 
                                        'subject_type'  => '".$event_definition['subject_type'] ."', 
                                        'subject_id'    => '".$event_definition['subject_id'] ."', 
                                        'context_type'  => '".$event_definition['context_type'] ."', 
                                        'context_id'    => '".$event_definition['context_id'] ."', 
                                );
                                ";
                        }
                        $code .= '
                                return $events; 
                        }
                        ';
                        return $code;
                }
                else
                {
                        return '
                        public static $startEventRequired = false;
                ';
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getTimeDateEventDefinition()

ilWorkflowScaffold::getTimeDateEventDefinition

(

$start_event_ref

)

Parameters

string

$start_event_ref

Returns

array

Definition at line 228 of file class.ilWorkflowScaffold.php.

References $start, array, and date.

Referenced by getStartEventInfo().

        {
                $content = '';
                foreach((array)$this->bpmn2_array['children'] as $elements)
                {
                        foreach((array)$elements['children'] as $element)
                        {
                                if ($element['name'] == 'startEvent' && @$element['children'][0]['name'] == 'timerEventDefinition')
                                {
                                        $timer_element = $element['children'][0];
                                        $content = $timer_element['children'][0]['content'];
                                }
                        }
                }

                $start = date('U',strtotime($content));
                $end = 0;

                return array(
                        'type'                          => 'time_passed',
                        'content'                       => 'time_passed',
                        'subject_type'          => 'none',
                        'subject_id'            => 0,
                        'context_type'          => 'none',
                        'context_id'            => 0,
                        'listening_start'       => $start,
                        'listening_end'         => $end
                );
        }

Here is the caller graph for this function:

registerRequire()

ilWorkflowScaffold::registerRequire

(

$require

)

Parameters

string

$require

Definition at line 34 of file class.ilWorkflowScaffold.php.

Referenced by __construct(), ilCallActivityElement\getPHP(), ilComplexGatewayElement\getPHP(), ilServiceTaskElement\getPHP(), ilSendTaskElement\getPHP(), ilScriptTaskElement\getPHP(), ilReceiveTaskElement\getPHP(), ilManualTaskElement\getPHP(), ilParallelGatewayElement\getPHP(), ilInclusiveGatewayElement\getPHP(), ilExclusiveGatewayElement\getPHP(), ilEventBasedGatewayElement\getPHP(), ilIntermediateCatchEventElement\getPHP(), ilSequenceFlowElement\getPHP(), ilStartEventElement\getPHP(), ilEndEventElement\getPHP(), ilIntermediateThrowEventElement\getPHP(), ilAssociationElement\getPHP(), and ilTaskElement\getPHP().

        {
                if(!in_array($require, $this->requires))
                {
                        $this->requires[] = $require;
                }
        }

Here is the caller graph for this function:

registerStartEventRef()

ilWorkflowScaffold::registerStartEventRef

(

$start_event_ref

)

Parameters

string

$start_event_ref

Definition at line 65 of file class.ilWorkflowScaffold.php.

References array.

Referenced by ilStartEventElement\getPHP().

        {
                $this->start_event_refs[] = array('type' => 'message', 'ref' => $start_event_ref);
        }

Here is the caller graph for this function:

registerStartSignalRef()

ilWorkflowScaffold::registerStartSignalRef

(

$start_event_ref

)

Parameters

string

$start_event_ref

Definition at line 73 of file class.ilWorkflowScaffold.php.

References array.

Referenced by ilStartEventElement\getPHP().

        {
                $this->start_event_refs[] = array('type' => 'signal', 'ref' => $start_event_ref);
        }

Here is the caller graph for this function:

registerStartTimerRef()

ilWorkflowScaffold::registerStartTimerRef

(

$start_event_ref

)

Parameters

string

$start_event_ref

Definition at line 81 of file class.ilWorkflowScaffold.php.

References array.

Referenced by ilStartEventElement\getPHP().

        {
                $this->start_event_refs[] = array('type' => 'timeDate', 'ref' => $start_event_ref);
        }

Here is the caller graph for this function:

setConstructorMethodContent()

ilWorkflowScaffold::setConstructorMethodContent

(

$constructor_method_content

)

Parameters

mixed

$constructor_method_content

Definition at line 188 of file class.ilWorkflowScaffold.php.

References $constructor_method_content.

        {
                $this->constructor_method_content = $constructor_method_content;
        }

setWorkflowName()

ilWorkflowScaffold::setWorkflowName

(

$workflow_name

)

Parameters

mixed

$workflow_name

Definition at line 157 of file class.ilWorkflowScaffold.php.

References $workflow_name.

        {
                $this->workflow_name = $workflow_name;
        }

Field Documentation

$auxilliary_methods

ilWorkflowScaffold::$auxilliary_methods

Definition at line 26 of file class.ilWorkflowScaffold.php.

$bpmn2_array

ilWorkflowScaffold::$bpmn2_array

Definition at line 23 of file class.ilWorkflowScaffold.php.

Referenced by __construct().

$constructor_method_content

ilWorkflowScaffold::$constructor_method_content

Definition at line 20 of file class.ilWorkflowScaffold.php.

Referenced by getConstructorMethodContent(), and setConstructorMethodContent().

$requires

ilWorkflowScaffold::$requires = array()

Definition at line 17 of file class.ilWorkflowScaffold.php.

Referenced by getRequires().

$start_event_refs

ilWorkflowScaffold::$start_event_refs

Definition at line 60 of file class.ilWorkflowScaffold.php.

$workflow_name

ilWorkflowScaffold::$workflow_name

Definition at line 29 of file class.ilWorkflowScaffold.php.

Referenced by setWorkflowName().

---

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

• Services/WorkflowEngine/classes/parser/class.ilWorkflowScaffold.php