/usr/share/php/ezc/ConsoleTools/dialog/validators/question_dialog_mapping.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 | <?php
/**
* File containing the ezcConsoleQuestionDialogMappingValidator 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
*/
/**
* Validator class to map certain results to others.
* This validator class, for {@link ezcConsoleQuestionDialog} objects,
* validates a given result against a set of predefined values, exactly like
* {@link ezcConsoleQuestionDialogCollectionValidator} does, but allows in
* addition to map certain results to other results. The $map property contains
* an array of mappings that are checked before a received result is validated.
* If a mapping matches, the received result is converted to the mapping target
* before being validated.
*
* A valid $map looks like this:
* <code>
* array(
* 'yes' => 'y',
* 'no' => 'n',
* '1' => 'y',
* '0' => 'n'
* )
* </code>
* While the corresponding collection of valid answers would look like
* this:
* <code>
* array(
* 'y', 'n'
* )
* </code>
* If the answer 'yes' is received by the validator, it is mapped to 'y',
* therefore considered valid and 'y' is returned as the received value.
*
* @package ConsoleTools
* @version //autogen//
*
* @property array(string) $collection
* The collection of valid answers.
* @property mixed $default
* Default value.
* @property int $conversion
* ezcConsoleDialogValidator::CONVERT_NONE (default) or
* ezcConsoleDialogValidator::CONVERT_LOWER or
* ezcConsoleDialogValidator::CONVERT_UPPER.
* @property array(string=>string) $map
* Mapping of answers to valid answers (e.g. array('yes' => 'y') to
* map 'yes' to 'y' while 'y' must be in $collection).
*/
class ezcConsoleQuestionDialogMappingValidator extends ezcConsoleQuestionDialogCollectionValidator
{
/**
* Creates a new question dialog mapping validator.
* Creates a new question dialog mapping validator, which validates the
* result specified by the user against an array of valid results
* ($collection). If not value is provided by the user a possibly set
* $default value is used instead. The $conversion parameter can optionally
* define a conversion to be performed on the result before validating it.
* Valid conversions are defined by the CONVERT_* constants in this class.
*
* While this functionality is already provided by {@link
* ezcConsoleQuestionDialogCollectionValidator}, the additional $map
* paramater allows the sepcification of a map of result values. These
* mapping is then checked for matches, before a received answer is
* validated against the collection.
*
* @param array(string) $collection The collection of valid results.
* @param mixed $default Optional default value.
* @param int $conversion CONVERT_* constant.
* @param array(string=>string) $map
* @return void
*/
public function __construct( array $collection, $default = null, $conversion = self::CONVERT_NONE, array $map = array() )
{
// Initialize additional property
$this->properties['map'] = $map;
parent::__construct( $collection, $default, $conversion );
}
/**
* 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_UPPER:
$result = strtoupper( $result );
break;
case self::CONVERT_LOWER:
$result = strtolower( $result );
break;
}
return ( isset( $this->map[$result] ) ? $this->map[$result] : $result );
}
/**
* 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 "map":
if ( is_array( $propertyValue ) === false )
{
throw new ezcBaseValueException( $propertyName, $propertyValue, "array" );
}
break;
default:
return parent::__set( $propertyName, $propertyValue );
}
$this->properties[$propertyName] = $propertyValue;
}
}
?>
|