Zeta Components - high quality PHP components

• Tutorial
• API

eZ Components - WorkflowSignalSlotTiein

Introduction

The WorkflowSignalSlotTiein component allows you to hook into the workflow execution into using the SignalSlot component.

Class overview

ezcWorkflowSignalSlotPlugin

Emits signals for the workflow engine's plugin hooks.

Usage

Connect all signals to the slots provided by an object

This example shows how to connect all signals to the slots provided by an object.

1. <?php
2. // Connect signals to slots.
3. $signals  = new ezcSignalCollection;
4. $receiver = new MyReceiver;
6. $signals->connect( 'afterExecutionStarted', array( $receiver, 'afterExecutionStarted' ) );
7. $signals->connect( 'afterExecutionSuspended', array( $receiver, 'afterExecutionSuspended' ) );
8. $signals->connect( 'afterExecutionResumed', array( $receiver, 'afterExecutionResumed' ) );
9. $signals->connect( 'afterExecutionCancelled', array( $receiver, 'afterExecutionCancelled' ) );
10. $signals->connect( 'afterExecutionEnded', array( $receiver, 'afterExecutionEnded' ) );
11. $signals->connect( 'beforeNodeActivated', array( $receiver, 'beforeNodeActivated' ) );
12. $signals->connect( 'afterNodeActivated', array( $receiver, 'afterNodeActivated' ) );
13. $signals->connect( 'afterNodeExecuted', array( $receiver, 'afterNodeExecuted' ) );
14. $signals->connect( 'afterRolledBackServiceObject', array( $receiver, 'afterRolledBackServiceObject' ) );
15. $signals->connect( 'afterThreadStarted', array( $receiver, 'afterThreadStarted' ) );
16. $signals->connect( 'afterThreadEnded', array( $receiver, 'afterThreadEnded' ) );
17. $signals->connect( 'beforeVariableSet', array( $receiver, 'beforeVariableSet' ) );
18. $signals->connect( 'afterVariableSet', array( $receiver, 'afterVariableSet' ) );
19. $signals->connect( 'beforeVariableUnset', array( $receiver, 'beforeVariableUnset' ) );
20. $signals->connect( 'afterVariableUnset', array( $receiver, 'afterVariableUnset' ) );
22. // Set up database connection.
23. $db = ezcDbFactory::create( 'mysql://test@localhost/test' );
25. // Set up workflow definition storage (database).
26. $definition = new ezcWorkflowDatabaseDefinitionStorage( $db );
28. // Load latest version of workflow named "Test".
29. $workflow = $definition->loadByName( 'Test' );
31. // Set up database-based workflow executer.
32. $execution = new ezcWorkflowDatabaseExecution( $db );
34. // Pass workflow object to workflow executer.
35. $execution->workflow = $workflow;
37. // Register SignalSlot workflow engine plugin.
38. $plugin = new ezcWorkflowSignalSlotPlugin;
39. $plugin->signals = $signals;
41. $execution->addPlugin( $plugin );
43. // Start workflow execution.
44. $id = $execution->start();
45. ?>

This is a dummy implementation of the MyReceiver class.

1. <?php
2. class MyReceiver
3. {
4.     public function afterExecutionStarted( ezcWorkflowExecution $execution )
5.     {
6.     }
8.     public function afterExecutionSuspended( ezcWorkflowExecution $execution )
9.     {
10.     }
12.     public function afterExecutionResumed( ezcWorkflowExecution $execution )
13.     {
14.     }
16.     public function afterExecutionCancelled( ezcWorkflowExecution $execution )
17.     {
18.     }
20.     public function afterExecutionEnded( ezcWorkflowExecution $execution )
21.     {
22.     }
24.     public function beforeNodeActivated( ezcWorkflowExecution $execution, ezcWorkflowNode $node, ezcWorkflowSignalSlotReturnValue $return )
25.     {
26.     }
28.     public function afterNodeActivated( ezcWorkflowExecution $execution, ezcWorkflowNode $node )
29.     {
30.     }
32.     public function afterNodeExecuted( ezcWorkflowExecution $execution, ezcWorkflowNode $node )
33.     {
34.     }
36.     public function afterThreadStarted( ezcWorkflowExecution $execution, $threadId, $parentId, $numSiblings )
37.     {
38.     }
40.     public function afterThreadEnded( ezcWorkflowExecution $execution, $threadId )
41.     {
42.     }
44.     public function beforeVariableSet( ezcWorkflowExecution $execution, $variableName, $value, ezcWorkflowSignalSlotReturnValue $return )
45.     {
46.     }
48.     public function afterVariableSet( ezcWorkflowExecution $execution, $variableName, $value )
49.     {
50.     }
52.     public function beforeVariableUnset( ezcWorkflowExecution $execution, $variableName, ezcWorkflowSignalSlotReturnValue $return )
53.     {
54.     }
56.     public function afterVariableUnset( ezcWorkflowExecution $execution, $variableName )
57.     {
58.     }
59. }
60. ?>

Slots that receive an ezcWorkflowSignalSlotReturnValue object are special in the way that they can control if and how the current execution step will be performed. For more information on this advice mechanism please refer to the documentation of the workflow engine plugin system.

For more information on using the SignalSlot component please refer to its documentation.