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 162 of file class.ilWorkflowScaffold.php.

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

References $bpmn2_array, and registerRequire().

Here is the call graph for this function:

Member Function Documentation

addAuxilliaryMethod()

ilWorkflowScaffold::addAuxilliaryMethod

(

$auxilliary_method

)

Parameters

string

$auxilliary_method

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

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

getConstructorMethodContent()

ilWorkflowScaffold::getConstructorMethodContent

(

)

Returns

mixed

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

    {
        return $this->constructor_method_content;
    }

References $constructor_method_content.

getPHP()

ilWorkflowScaffold::getPHP

(

)

Returns

string

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

    {
        $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;
    }

References getRequires(), and getStartEventInfo().

Here is the call graph for this function:

getRequires()

ilWorkflowScaffold::getRequires

(

)

Returns

string

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

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

References $requires.

Referenced by getPHP().

Here is the caller graph for this function:

getStartEventInfo()

ilWorkflowScaffold::getStartEventInfo

(

)

Returns

string

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

    {
        $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;
                ';
        }
    }

References ilBPMN2ParserUtils\extractILIASEventDefinitionFromProcess(), and getTimeDateEventDefinition().

Referenced by getPHP().

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 219 of file class.ilWorkflowScaffold.php.

    {
        $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
        );
    }

Referenced by getStartEventInfo().

Here is the caller graph for this function:

registerRequire()

ilWorkflowScaffold::registerRequire

(

$require

)

Parameters

string

$require

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

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

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

Here is the caller graph for this function:

registerStartEventRef()

ilWorkflowScaffold::registerStartEventRef

(

$start_event_ref

)

Parameters

string

$start_event_ref

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

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

Referenced by ilStartEventElement\getPHP().

Here is the caller graph for this function:

registerStartSignalRef()

ilWorkflowScaffold::registerStartSignalRef

(

$start_event_ref

)

Parameters

string

$start_event_ref

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

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

Referenced by ilStartEventElement\getPHP().

Here is the caller graph for this function:

registerStartTimerRef()

ilWorkflowScaffold::registerStartTimerRef

(

$start_event_ref

)

Parameters

string

$start_event_ref

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

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

Referenced by ilStartEventElement\getPHP().

Here is the caller graph for this function:

setConstructorMethodContent()

ilWorkflowScaffold::setConstructorMethodContent

(

$constructor_method_content

)

Parameters

mixed

$constructor_method_content

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

    {
        $this->constructor_method_content = $constructor_method_content;
    }

References $constructor_method_content.

setWorkflowName()

ilWorkflowScaffold::setWorkflowName

(

$workflow_name

)

Parameters

mixed

$workflow_name

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

    {
        $this->workflow_name = $workflow_name;
    }

References $workflow_name.

Field Documentation

$auxilliary_methods

array ilWorkflowScaffold::$auxilliary_methods

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

$bpmn2_array

array ilWorkflowScaffold::$bpmn2_array

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

Referenced by __construct().

$constructor_method_content

string ilWorkflowScaffold::$constructor_method_content

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

Referenced by getConstructorMethodContent(), and setConstructorMethodContent().

$requires

array ilWorkflowScaffold::$requires = array()

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

Referenced by getRequires().

$start_event_refs

array ilWorkflowScaffold::$start_event_refs

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

$workflow_name

string 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