/usr/share/php/ezc/ConsoleTools/dialog/validators/menu_dialog_default.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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 | <?php
/**
* File containing the ezcConsoleMenuDialogDefaultValidator 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
*/
/**
* Default validator for ezcConsoleMenuDialog.
* This dialog contains a set of menu entries, defined in the $elements
* property. The result, provided by the user, is checked against the keys of
* this array. A conversion can be specified to relax the rules for validation
* (like coverting the result to lower case first). For possibly conversions
* see the CONVERT_* constants in this class If the user does not provide an
* answer, a possibly set default value is used.
*
* @package ConsoleTools
* @version //autogen//
*
* @property array $elements The elements of the menu.
* @property string $default The default value.
* @property int $conversion
* ezcConsoleDialogValidator::CONVERT_NONE (default) or
* ezcConsoleDialogValidator::CONVERT_LOWER or
* ezcConsoleDialogValidator::CONVERT_UPPER.
*/
class ezcConsoleMenuDialogDefaultValidator implements ezcConsoleMenuDialogValidator
{
/**
* Properties
*
* @var array
*/
protected $properties = array(
"elements" => array(),
"default" => null,
"conversion" => self::CONVERT_NONE,
);
/**
* Creates a new menu default validator.
* Creates a validator specified by the given parameters. The $elements
* array specifies the possible menu items to select from. The item
* identifier (the key of the array) is used to validate the result. The
* assigned text is displayed as the menu item text. If no result is
* provided and an optionally provided default value is used. The
* $conversion parameter can be used to get a conversion applied to the
* result before validating it.
*
* @param array $elements The elements of the menu.
* @param mixed $default The default value.
* @param int $conversion The conversion to apply.
* @return void
*/
public function __construct( array $elements = array(), $default = null, $conversion = self::CONVERT_NONE )
{
$this->elements = $elements;
$this->default = $default;
$this->conversion = $conversion;
}
/**
* Returns if the given result is valid.
* Checks if the given result is a valid key in the $elements property.
*
* @param mixed $result The received result.
* @return bool If the result is valid.
*/
public function validate( $result )
{
return isset( $this->elements[$result] );
}
/**
* Returns a fixed version of the result, if possible.
* Converts the given result according to the conversion defined in the
* $conversion property.
*
* @param mixed $result The received result.
* @return mixed The manipulated result.
*/
public function fixup( $result )
{
if ( $result === "" && $this->default !== null )
{
return $this->default;
}
switch ( $this->conversion )
{
case self::CONVERT_LOWER:
return strtolower( $result );
case self::CONVERT_UPPER:
return strtoupper( $result );
case self::CONVERT_NONE:
default:
return $result;
}
}
/**
* Returns a string representing the default value.
* For example "[y]" to indicate that "y" is the preselected result and
* will be chosen if no result is provided.
*
* @return string The result string.
*/
public function getResultString()
{
return $this->default === null ? "" : "[{$this->default}]";
}
/**
* Returns an array of the elements to display.
*
* @return array(string=>string) Elements to display.
*/
public function getElements()
{
return $this->elements;
}
/**
* Property read access.
*
* @param string $propertyName Name of the property.
* @return mixed Value of the property or null.
*
* @throws ezcBasePropertyNotFoundException
* If the the desired property is not found.
* @ignore
*/
public function __get( $propertyName )
{
if ( isset( $this->$propertyName ) )
{
return $this->properties[$propertyName];
}
throw new ezcBasePropertyNotFoundException( $propertyName );
}
/**
* Property write access.
*
* @param string $propertyName Name of the property.
* @param mixed $propertyValue The value for the property.
*
* @throws ezcBasePropertyNotFoundException
* If a the value for the property options is not an instance of
* @throws ezcBaseValueException
* If a the value for a property is out of range.
* @ignore
*/
public function __set( $propertyName, $propertyValue )
{
switch ( $propertyName )
{
case "elements":
if ( is_array( $propertyValue ) === false )
{
throw new ezcBaseValueException( $propertyName, $propertyValue, "array" );
}
break;
case "default":
if ( is_scalar( $propertyValue ) === false && $propertyValue !== null )
{
throw new ezcBaseValueException( $propertyName, $propertyValue, "scalar" );
}
break;
case "conversion":
if ( $propertyValue !== self::CONVERT_NONE && $propertyValue !== self::CONVERT_UPPER && $propertyValue !== self::CONVERT_LOWER )
{
throw new ezcBaseValueException( $propertyName, $propertyValue, "ezcConsoleMenuDialogDefaultValidator::CONVERT_*" );
}
break;
default:
throw new ezcBasePropertyNotFoundException( $propertyName );
}
$this->properties[$propertyName] = $propertyValue;
}
/**
* Property isset access.
*
* @param string $propertyName Name of the property.
* @return bool True is the property is set, otherwise false.
* @ignore
*/
public function __isset( $propertyName )
{
return array_key_exists( $propertyName, $this->properties );
}
}
?>
|