/usr/share/php/ezc/ConsoleTools/structs/option_rule.php is in php-zeta-console-tools 1.7-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 | <?php
/**
* File containing the ezcConsoleOptionRule class.
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
* @package ConsoleTools
* @version //autogentag//
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
* @filesource
*/
/**
* Struct class to store a parameter rule.
*
* This struct stores relation rules between parameters. A relation consists of
* a parameter that the relation refers to and optionally the value(s) the
* referred parameter may have assigned. Rules may be used for dependencies and
* exclusions between parameters.
*
* The ezcConsoleOptionRule class has the following properties:
* - <b>option</b> <i>ezcConsoleOption</i>, contains the parameter that this rule refers to.
* - <b>values</b> <i>array(string)</i>, contains a list of values that are accepted.
*
* @see ezcConsoleOption
*
* @package ConsoleTools
* @version //autogen//
*/
class ezcConsoleOptionRule
{
/**
* Properties.
*
* @var array
*/
protected $properties = array(
'option' => null,
'values' => array(),
'ifSet' => true
);
/**
* Creates a new option rule.
*
* Creates a new option rule. Per default the $values parameter
* is an empty array, which determines that the option may accept any
* value. To indicate that a option may only have certain values,
* place them inside tha $values array. For example to indicate an option
* may have the values 'a', 'b' and 'c' use:
*
* <code>
* $rule = new ezcConsoleOptionRule( $option, array( 'a', 'b', 'c' ) );
* </code>
*
* If you want to allow only 1 specific value for an option, you do not
* need to wrap this into an array, when creating the rule. Simply use
*
* <code>
* $rule = new ezcConsoleOptionRule( $option, 'a' );
* </code>
*
* to create a rule, that allows the desired option only to accept the
* value 'a'.
*
* The $ifSet parameter determines, if the rule is validated when its option
* is set or left out. If $ifSet is true, the rule is validated when the
* option is set. Otherwise the rule is validated if the option was not set
* by the user.
*
* @param ezcConsoleOption $option The option to refer to.
* @param mixed $values The affected values.
* @param bool $ifSet
*/
public function __construct( ezcConsoleOption $option, array $values = array(), $ifSet = true )
{
$this->__set( 'option', $option );
$this->__set( 'values', $values );
$this->__set( 'ifSet', $ifSet );
}
/**
* Property read access.
*
* @throws ezcBasePropertyNotFoundException
* If the the desired property is not found.
*
* @param string $propertyName Name of the property.
* @return mixed Value of the property or null.
* @ignore
*/
public function __get( $propertyName )
{
switch ( $propertyName )
{
case 'option':
return $this->properties['option'];
case 'values':
return $this->properties['values'];
case 'ifSet':
return $this->properties['ifSet'];
}
throw new ezcBasePropertyNotFoundException( $propertyName );
}
/**
* Property write access.
*
* @param string $propertyName Name of the property.
* @param mixed $propertyValue The value for the property.
*
* @throws ezcBasePropertyPermissionException
* If the property you try to access is read-only.
* @throws ezcBasePropertyNotFoundException
* If the the desired property is not found.
* @ignore
*/
public function __set( $propertyName, $propertyValue )
{
switch ( $propertyName )
{
case 'option':
if ( !( $propertyValue instanceof ezcConsoleOption ) )
{
throw new ezcBaseValueException( $propertyName, $propertyValue, 'ezcConsoleOption' );
}
$this->properties['option'] = $propertyValue;
return;
case 'values':
if ( !is_array( $propertyValue ) )
{
throw new ezcBaseValueException( $propertyName, $propertyValue, 'array' );
}
$this->properties['values'] = $propertyValue;
return;
case 'ifSet':
if ( !is_bool( $propertyValue ) )
{
throw new ezcBaseValueException( $propertyName, $propertyValue, 'bool' );
}
$this->properties['ifSet'] = $propertyValue;
return;
}
throw new ezcBasePropertyNotFoundException( $propertyName );
}
/**
* Property isset access.
*
* @param string $propertyName Name of the property to check.
* @return bool If the property exists or not.
* @ignore
*/
public function __isset( $propertyName )
{
switch ( $propertyName )
{
case 'option':
case 'values':
case 'ifSet':
return true;
}
return false;
}
}
?>
|