Apache Zeta Components Manual :: File Source for question_dialog_type.php
Source for file question_dialog_type.php
Documentation is available at question_dialog_type.php
* File containing the ezcConsoleQuestionDialogTypeValidator 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
* @version //autogentag//
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
* Validator class to validate a certain data type.
* Validator class for ezcConsoleQuestionDialog objects that validates a
* One of ezcConsoleQuestionDialogTypeValidator::TYPE_*. The type to
* check against and convert results to.
* @property mixed $default
* A default value if no result given.
* The results 1 and "true" will be cased to true, 0 and "false" to false.
"type" =>
self::TYPE_STRING,
* Creates a new question dialog type validator.
* Creates a new question dialog type validator, which validates the result
* specified to be of a certaon type. The $type must be one of the TYPE_*
* constants in this class. If no value is provided by the user a possibly
* set $default value is used instead.
* @param int $type One of ezcConsoleQuestionDialogTypeValidator::TYPE_*.
* @param mixed $default Default value according to $type.
public function __construct( $type =
self::TYPE_STRING, $default =
null )
$this->default =
$default;
* Returns if the given result is valid.
* Returns if the result is of the given type.
* @param mixed $result The result to check.
* @return bool True if the result is valid. Otherwise false.
return $this->default !==
null;
* Returns a fixed version of the result, if possible.
* Returns the value casted into the correct type or the default value, if
* it exists and the result is empty.
* @param mixed $result The result received.
* @return mixed The manipulated result.
public function fixup( $result )
if ( $result ===
"" &&
$this->default !==
null )
return ( preg_match( "/^[0-9\-]+$/", $result ) !==
0 ) ? (int)
$result :
$result;
return ( preg_match( "/^[0-9.E\-]+$/i", $result ) !==
0 ) ? (float)
$result :
$result;
* Returns a string representing valid results.
* Returns the string that can will be displayed with the question to
* indicate valid results to the user and a possibly set default, if
$res =
"(<%s>)" .
( $this->default !==
null ?
" [{$this->default}]
" : "" );
return sprintf( $res, "int" );
return sprintf( $res, "float" );
return sprintf( $res, "bool" );
return sprintf( $res, "string" );
* @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.
public function __get( $propertyName )
if ( isset( $this->$propertyName ) )
throw new ezcBasePropertyNotFoundException( $propertyName );
* @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.
public function __set( $propertyName, $propertyValue )
if ( $propertyValue !== self::TYPE_STRING && $propertyValue !== self::TYPE_INT && $propertyValue !== self::TYPE_FLOAT && $propertyValue !== self::TYPE_BOOL )
throw new ezcBaseValueException( $propertyName, $propertyValue, "ezcConsoleQuestionDialogTypeValidator::TYPE_*" );
if ( is_scalar( $propertyValue ) === false && $propertyValue !== null )
throw new ezcBaseValueException( $propertyName, $propertyValue, "scalar" );
throw new ezcBasePropertyNotFoundException( $propertyName );
$this->properties[$propertyName] =
$propertyValue;
* @param string $propertyName Name of the property.
* @return bool True is the property is set, otherwise false.
public function __isset( $propertyName )
return array_key_exists( $propertyName, $this->properties );