Path

ez components / documentation / api reference / 2008.1 / workflow


Workflow

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

Source for file is_equal.php

Documentation is available at is_equal.php

 1. <?php
 2. /**
 3.  * File containing the ezcWorkflowConditionIsEqual class.
 4.  *
 5.  * @package Workflow
 6.  * @version 1.2
 7.  * @copyright Copyright (C) 2005-2008 eZ systems as. All rights reserved.
 8.  * @license http://ez.no/licenses/new_bsd New BSD License
 9.  */
10.  
11. /**
12.  * Condition that checks if a value is equal to a reference value.
13.  *
14.  * Typically used together with ezcWorkflowConditionVariable to use the
15.  * condition on a workflow variable.
16.  *
17.  * <code>
18.  * <?php
19.  * $condition = new ezcWorkflowConditionVariable(
20.  *   'variable name',
21.  *   new ezcWorkflowConditionIsEqual( $comparisonValue )
22.  * );
23.  * ?>
24.  * </code>
25.  *
26.  * @package Workflow
27.  * @version 1.2
28.  */
29. class ezcWorkflowConditionIsEqual extends ezcWorkflowConditionComparison
30. {
31.     /**
32.      * @var mixed 
33.      */
34.     protected $operator = '==';
35.  
36.     /**
37.      * Evaluates this condition with $value and returns true if it is false or false if it is not.
38.      *
39.      * @param  mixed $value 
40.      * @return boolean true when the condition holds, false otherwise.
41.      * @ignore
42.      */
43.     public function evaluate$value )
44.     {
45.         return $value == $this->value;
46.     }
47. }
48. ?>
Last updated: Wed, 18 Jun 2008