Apache Zeta Components Manual :: File Source for question_dialog_regex.php
Source for file question_dialog_regex.php
Documentation is available at question_dialog_regex.php
* File containing the ezcConsoleQuestionDialogRegexValidator 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
* Regex validator for ezcConsoleQuestionDialog
* Validator class for ezcConsoleQuestionDialog objects that validates by
* matching a certain regular expression.
* @property string $pattern
* The pattern to use for validation. Delimiters and modifiers
* @property mixed $default
* A default value if no (an empty string) result given.
* @var array(string=>mixed)
* Create a new question dialog regex validator.
* Create a new question dialog regex validator, which validates the result
* specified against a given regular expression. The delimiters and
* eventual modifiers must be included in the pattern. If not value is
* provided by the user a possibly set $default value is used instead.
* @param string $pattern Pattern to validate against.
* @param mixed $default Default value.
public function __construct( $pattern, $default =
null )
$this->pattern =
$pattern;
$this->default =
$default;
* Returns if the given result is valid.
* Returns if the result matches the regular expression.
* @param mixed $result The received result.
* @return bool If the result is valid.
return $this->default !==
null;
* Returns a fixed version of the result, if possible.
* If no result was provided by the user, the default value will be
* @param mixed $result The received result.
* @return mixed The manipulated result.
public function fixup( $result )
if ( $result ===
"" &&
$this->default !==
null )
* Returns a string representing valid results.
* Returns the string that will be displayed with the question to
* indicate valid results to the user and a possibly set default, if
return "(match {$this->pattern})
" . ( $this->default !==
null ?
" [{
$this->default}]
" : "" );
* @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 ( $this->__isset( $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 ( is_string( $propertyValue ) === false || strlen( $propertyValue ) < 2 )
throw new ezcBaseValueException( $propertyName, $propertyValue, "string, length > 1" );
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 );