ilBPMN2Parser Class Reference

Class ilBPMN2Parser. More...

Collaboration diagram for ilBPMN2Parser:

Public Member Functions
	parseBPMN2XML ($bpmn2_xml, $workflow_name=null)
	convertXmlToArray ($xml)
	getProcessNodeFromArray ($bpmn2)
	getMessageNodesFromArray ($bpmn2)
	determineWorkflowClassName ($workflow_name, $bpmn2_array, $process)

Detailed Description

Class ilBPMN2Parser.

Author

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

Version

$Id$

/

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

Member Function Documentation

convertXmlToArray()

ilBPMN2Parser::convertXmlToArray

(

$xml

)

Parameters

string

$xml

Returns

mixed

Definition at line 128 of file class.ilBPMN2Parser.php.

Referenced by parseBPMN2XML().

        {
                require_once './Services/WorkflowEngine/classes/parser/class.ilBPMN2ParserUtils.php';
                $xml_to_array_parser = new ilBPMN2ParserUtils();
                $bpmn2               = $xml_to_array_parser->load_string( $xml );
                return $bpmn2;
        }

Here is the caller graph for this function:

determineWorkflowClassName()

ilBPMN2Parser::determineWorkflowClassName	(		$workflow_name,
			$bpmn2_array,
			$process
	)

Parameters

string	$workflow_name
array	$bpmn2_array
array	$process

Returns

mixed

Definition at line 181 of file class.ilBPMN2Parser.php.

Referenced by parseBPMN2XML().

        {
                if (!$workflow_name && !count( @$bpmn2_array['children'] ))
                {
                        $workflow_name = $bpmn2_array['attributes']['id'];
                }

                if (!$workflow_name)
                {
                        $workflow_name = $process['attributes']['id'];
                        return $workflow_name;
                }

                if ($workflow_name)
                {
                        $workflow_name = substr($workflow_name,0,strpos($workflow_name,'.'));
                }
                return $workflow_name;
        }

Here is the caller graph for this function:

getMessageNodesFromArray()

ilBPMN2Parser::getMessageNodesFromArray

(

$bpmn2

)

Parameters

array

$bpmn2

Returns

array

Definition at line 160 of file class.ilBPMN2Parser.php.

References $messages, and array.

Referenced by parseBPMN2XML().

        {
                $messages = array();
                foreach ((array)@$bpmn2['children'] as $bpmn2_part)
                {
                        if ($bpmn2_part['name'] == 'message')
                        {
                                $messages[] = $bpmn2_part;
                                break;
                        }
                }
                return $messages;
        }

Here is the caller graph for this function:

getProcessNodeFromArray()

ilBPMN2Parser::getProcessNodeFromArray

(

$bpmn2

)

Parameters

array

$bpmn2

Returns

array

Definition at line 141 of file class.ilBPMN2Parser.php.

References array.

Referenced by parseBPMN2XML().

        {
                $process = array();
                foreach ((array)@$bpmn2['children'] as $bpmn2_part)
                {
                        if ($bpmn2_part['name'] == 'process')
                        {
                                $process = $bpmn2_part;
                                break;
                        }
                }
                return $process;
        }

Here is the caller graph for this function:

parseBPMN2XML()

ilBPMN2Parser::parseBPMN2XML	(		$bpmn2_xml,
			$workflow_name = null
	)

Parameters

string	$bpmn2_xml
string | null	$workflow_name

Returns

string

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

References $code, $loader, $messages, array, convertXmlToArray(), determineWorkflowClassName(), getMessageNodesFromArray(), and getProcessNodeFromArray().

        {
                $bpmn2_array = $this->convertXmlToArray( $bpmn2_xml );
                $process = $this->getProcessNodeFromArray( $bpmn2_array );
                $messages = $this->getMessageNodesFromArray( $bpmn2_array );

                $workflow_name = $this->determineWorkflowClassName( $workflow_name, $bpmn2_array, $process );

                require_once './Services/WorkflowEngine/classes/parser/class.ilWorkflowScaffold.php';
                $class_object = new ilWorkflowScaffold($bpmn2_array);

                $constructor_method_content = '';

                $class_object->setWorkflowName($workflow_name);

                if(count(@$process['children']))
                {
                        $stashed_sequence_flows = array(); // There can be no assumption, that the workflow is modeled in sequence,
                                                                                           // so we need to stash the connectors to add them after the nodes.
                        $stashed_associations = array(); // There can be no assumption, that the workflow is modeled in sequence,
                                                                                           // so we need to stash the connectors to add them after the nodes.
                        $stashed_process_extensions = array(); // It was found that modelers add extensions at process level,
                                                                                           // they are stored for possible future use.
                        require_once './Services/WorkflowEngine/classes/parser/elements/class.ilBPMN2ElementLoader.php';

                        $loader = new ilBPMN2ElementLoader($bpmn2_array);

                        foreach($process['children'] as $element)
                        {
                                if($element['name'] == 'ioSpecification')
                                {
                                        foreach($element['children'] as $iospec_element)
                                        {
                                                $element_object = $loader->load($iospec_element['name']);
                                                $constructor_method_content .= $element_object->getPHP($iospec_element, $class_object);
                                        }

                                        continue;
                                }

                                if($element['name'] == 'sequenceFlow')
                                {
                                        $stashed_sequence_flows[] = $element;
                                } 
                                else if($element['name'] == 'association')
                                {
                                        $stashed_associations[] = $element;
                                }
                                else if($element['name'] == 'extensionElements')
                                {
                                        $stashed_process_extensions[] = $element;
                                }
                                else
                                {
                                        $element_object = $loader->load($element['name']);
                                        $constructor_method_content .= $element_object->getPHP($element, $class_object);
                                }
                        }

                        foreach($stashed_sequence_flows as $element)
                        {
                                $element_object = $loader->load($element['name']);
                                $constructor_method_content .= $element_object->getPHP($element, $class_object);
                        }

                        foreach($stashed_associations as $element)
                        {
                                $element_object = $loader->load($element['name']);
                                $constructor_method_content .= $element_object->getPHP($element, $class_object);
                        }
                }

                if(count($messages))
                {
                        $message_definitions = array();
                        foreach ($messages as $message)
                        {
                                $element_object = $loader->load('messageDefinition');
                                $message_definitions[] = $element_object->getMessageDefinitionArray($message);
                        }

                        $code = '
                        public static function getMessageDefinition($id)
                        {
                                $definitions = array('.implode(',', $message_definitions).'
                                );
                                return $definitions[$id];
                        }
                        ';
                        $class_object->addAuxilliaryMethod($code);
                }

                $class_object->setConstructorMethodContent($constructor_method_content);
                $class_source = '';

                if (strlen($constructor_method_content))
                {
                        $class_source .= $class_object->getPHP();
                }

                return "<?php\n" . $class_source . "\n?>"; // PHP Code
        }

Here is the call graph for this function:

---

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

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