Apache Zeta Components Manual :: File Source for execution_plugin_visualizer.php

Source for file execution_plugin_visualizer.php

Documentation is available at execution_plugin_visualizer.php

  1. <?php
  2. /**
  3.  * This file contains the ezcWorkflowExecutionVisualizerPluginOptions class.
  4.  *
  5.  * Licensed to the Apache Software Foundation (ASF) under one
  6.  * or more contributor license agreements.  See the NOTICE file
  7.  * distributed with this work for additional information
  8.  * regarding copyright ownership.  The ASF licenses this file
  9.  * to you under the Apache License, Version 2.0 (the
  10.  * "License"); you may not use this file except in compliance
  11.  * with the License.  You may obtain a copy of the License at
  12.  * 
  13.  *   http://www.apache.org/licenses/LICENSE-2.0
  14.  * 
  15.  * Unless required by applicable law or agreed to in writing,
  16.  * software distributed under the License is distributed on an
  17.  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  18.  * KIND, either express or implied.  See the License for the
  19.  * specific language governing permissions and limitations
  20.  * under the License.
  21.  *
  22.  * @package Workflow
  23.  * @version //autogentag//
  24.  * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
  25.  * @filesource
  26.  */
  27.  
  28. /**
  29.  * Options class for ezcWorkflowExecutionVisualizerPlugin.
  30.  *
  31.  * @property string $directory 
  32.  *            The directory to which the DOT files are written.
  33.  * @property bool $includeVariables 
  34.  *            Whether or not to include workflow variables.
  35.  * @package Workflow
  36.  * @version //autogen//
  37.  */
  38. {
  39.     /**
  40.      * Properties.
  41.      *
  42.      * @var array(string=>mixed) 
  43.      */
  44.     protected $properties = array(
  45.         'directory'        => null,
  46.         'includeVariables' => true,
  47.     );
  48.  
  49.     /**
  50.      * Property write access.
  51.      *
  52.      * @param string $propertyName  Name of the property.
  53.      * @param mixed  $propertyValue The value for the property.
  54.      *
  55.      * @throws ezcBasePropertyNotFoundException
  56.      *          If the the desired property is not found.
  57.      * @throws ezcBaseFileNotFoundException
  58.      *          When the directory does not exist.
  59.      * @throws ezcBaseFilePermissionException
  60.      *          When the directory is not writable.
  61.      * @ignore
  62.      */
  63.     public function __set$propertyName$propertyValue )
  64.     {
  65.         switch $propertyName )
  66.         {
  67.             case 'directory':
  68.                 if !is_string$propertyValue ) )
  69.                 {
  70.                     throw new ezcBaseValueException(
  71.                         $propertyName,
  72.                         $propertyValue,
  73.                         'string'
  74.                     );
  75.                 }
  76.  
  77.                 if !is_dir$propertyValue ) )
  78.                 {
  79.                     throw new ezcBaseFileNotFoundException$propertyValue'directory' );
  80.                 }
  81.  
  82.                 if !is_writable$propertyValue ) )
  83.                 {
  84.                     // @codeCoverageIgnoreStart
  85.                     throw new ezcBaseFilePermissionException$propertyValueezcBaseFileException::WRITE );
  86.                     // @codeCoverageIgnoreEnd
  87.                 }
  88.                 break;
  89.             case 'includeVariables':
  90.                 if !is_bool$propertyValue ) )
  91.                 {
  92.                     throw new ezcBaseValueException(
  93.                         $propertyName,
  94.                         $propertyValue,
  95.                         'bool'
  96.                     );
  97.                 }
  98.                 break;
  99.             default:
  100.                 throw new ezcBasePropertyNotFoundException$propertyName );
  101.         }
  102.         $this->properties[$propertyName$propertyValue;
  103.     }
  104. }
  105. ?>
Documentation generated by phpDocumentor 1.4.3