Path

ez components / documentation / api reference / latest / workflow


eZ Components latest

Workflow

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Source for file execution_plugin.php

Documentation is available at execution_plugin.php

 1. <?php
 2. /**
 3.  * File containing the ezcWorkflowExecutionPlugin class.
 4.  *
 5.  * @package Workflow
 6.  * @version 1.4
 7.  * @copyright Copyright (C) 2005-2009 eZ Systems AS. All rights reserved.
 8.  * @license http://ez.no/licenses/new_bsd New BSD License
 9.  */
10.  
11. /**
12.  * Abstract base class for workflow execution engine plugins.
13.  *
14.  * @package Workflow
15.  * @version 1.4
16.  */
17. abstract class ezcWorkflowExecutionPlugin
18. {
19.     /**
20.      * Called after an execution has been started.
21.      *
22.      * @param ezcWorkflowExecution $execution 
23.      */
24.     public function afterExecutionStartedezcWorkflowExecution $execution )
25.     {
26.     // @codeCoverageIgnoreStart
27.     }
28.     // @codeCoverageIgnoreEnd
29.  
30.     /**
31.      * Called after an execution has been suspended.
32.      *
33.      * @param ezcWorkflowExecution $execution 
34.      */
35.     public function afterExecutionSuspendedezcWorkflowExecution $execution )
36.     {
37.     // @codeCoverageIgnoreStart
38.     }
39.     // @codeCoverageIgnoreEnd
40.  
41.     /**
42.      * Called after an execution has been resumed.
43.      *
44.      * @param ezcWorkflowExecution $execution 
45.      */
46.     public function afterExecutionResumedezcWorkflowExecution $execution )
47.     {
48.     // @codeCoverageIgnoreStart
49.     }
50.     // @codeCoverageIgnoreEnd
51.  
52.     /**
53.      * Called after an execution has been cancelled.
54.      *
55.      * @param ezcWorkflowExecution $execution 
56.      */
57.     public function afterExecutionCancelledezcWorkflowExecution $execution )
58.     {
59.     // @codeCoverageIgnoreStart
60.     }
61.     // @codeCoverageIgnoreEnd
62.  
63.     /**
64.      * Called after an execution has successfully ended.
65.      *
66.      * @param ezcWorkflowExecution $execution 
67.      */
68.     public function afterExecutionEndedezcWorkflowExecution $execution )
69.     {
70.     // @codeCoverageIgnoreStart
71.     }
72.     // @codeCoverageIgnoreEnd
73.  
74.     /**
75.      * Called before a node is activated.
76.      *
77.      * @param ezcWorkflowExecution $execution 
78.      * @param ezcWorkflowNode      $node 
79.      * @return bool true, when the node should be activated, false otherwise
80.      */
81.     public function beforeNodeActivatedezcWorkflowExecution $executionezcWorkflowNode $node )
82.     {
83.     // @codeCoverageIgnoreStart
84.         return true;
85.     }
86.     // @codeCoverageIgnoreEnd
87.  
88.     /**
89.      * Called after a node has been activated.
90.      *
91.      * @param ezcWorkflowExecution $execution 
92.      * @param ezcWorkflowNode      $node 
93.      */
94.     public function afterNodeActivatedezcWorkflowExecution $executionezcWorkflowNode $node )
95.     {
96.     // @codeCoverageIgnoreStart
97.     }
98.     // @codeCoverageIgnoreEnd
99.  
100.     /**
101.      * Called after a node has been executed.
102.      *
103.      * @param ezcWorkflowExecution $execution 
104.      * @param ezcWorkflowNode      $node 
105.      */
106.     public function afterNodeExecutedezcWorkflowExecution $executionezcWorkflowNode $node )
107.     {
108.     // @codeCoverageIgnoreStart
109.     }
110.     // @codeCoverageIgnoreEnd
111.  
112.     /**
113.      * Called after a new thread has been started.
114.      *
115.      * @param ezcWorkflowExecution $execution 
116.      * @param int                  $threadId 
117.      * @param int                  $parentId 
118.      * @param int                  $numSiblings 
119.      */
120.     public function afterThreadStartedezcWorkflowExecution $execution$threadId$parentId$numSiblings )
121.     {
122.     // @codeCoverageIgnoreStart
123.     }
124.     // @codeCoverageIgnoreEnd
125.  
126.     /**
127.      * Called after a thread has ended.
128.      *
129.      * @param ezcWorkflowExecution $execution 
130.      * @param int                  $threadId 
131.      */
132.     public function afterThreadEndedezcWorkflowExecution $execution$threadId )
133.     {
134.     // @codeCoverageIgnoreStart
135.     }
136.     // @codeCoverageIgnoreEnd
137.  
138.     /**
139.      * Called before a variable is set.
140.      *
141.      * @param  ezcWorkflowExecution $execution 
142.      * @param  string               $variableName 
143.      * @param  mixed                $value 
144.      * @return mixed the value the variable should be set to
145.      */
146.     public function beforeVariableSetezcWorkflowExecution $execution$variableName$value )
147.     {
148.     // @codeCoverageIgnoreStart
149.         return $value;
150.     }
151.     // @codeCoverageIgnoreEnd
152.  
153.     /**
154.      * Called after a variable has been set.
155.      *
156.      * @param ezcWorkflowExecution $execution 
157.      * @param string               $variableName 
158.      * @param mixed                $value 
159.      */
160.     public function afterVariableSetezcWorkflowExecution $execution$variableName$value )
161.     {
162.     // @codeCoverageIgnoreStart
163.     }
164.     // @codeCoverageIgnoreEnd
165.  
166.     /**
167.      * Called before a variable is unset.
168.      *
169.      * @param  ezcWorkflowExecution $execution 
170.      * @param  string               $variableName 
171.      * @return bool true, when the variable should be unset, false otherwise
172.      */
173.     public function beforeVariableUnsetezcWorkflowExecution $execution$variableName )
174.     {
175.     // @codeCoverageIgnoreStart
176.         return true;
177.     }
178.     // @codeCoverageIgnoreEnd
179.  
180.     /**
181.      * Called after a variable has been unset.
182.      *
183.      * @param ezcWorkflowExecution $execution 
184.      * @param string               $variableName 
185.      */
186.     public function afterVariableUnsetezcWorkflowExecution $execution$variableName )
187.     {
188.     // @codeCoverageIgnoreStart
189.     }
190.     // @codeCoverageIgnoreEnd
191. }
192. ?>
Last updated: Mon, 21 Dec 2009