Apache Zeta Components Manual :: File Source for argument.php
Source for file argument.php
Documentation is available at argument.php
* File containing the ezcConsoleArgument 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
* The ezcConsoleArgument class represents an argument on the console.
* This class is the container to store information about an argument submitted
* to a shell application. It is used to define the appearance of an argument
* before parsing the parameter string and contains the received value
* afterwards. Argument objects are stored in an instance of the set class
* {@link ezcConsoleArguments} which is stored in
* {ezcConsoleInput::$argumentDefinition}.
* @property string $name The name for the argument. Must be unique.
* @property int $type The value type.
* @property string $shorthelp A short help text.
* @property string $longhelp A long help text-
* @property bool $mandatory Whether the argument is mandatory.
* @property mixed $default A default value, if not mandatory.
* @property bool $multiple Whether the argument accepts multiple values.
* @property-read mixed $value The value parsed from the parameter string, using
* {@link ezcConsoleInput::process()}.
"type" =>
ezcConsoleInput::TYPE_STRING,
"shorthelp" =>
"No help available.",
"longhelp" =>
"There is no help for this argument available.",
* Creates a new console argument object.
* Creates a new console argument object, which represents a single
* argument on the shell. Arguments are stored insiede
* {@link ezcConsoleArguments} which is used with {@link ezcConsoleInput}.
* For the type property see {@link ezcConsoleInput::TYPE_STRING} and
* {@link ezcConsoleInput::TYPE_INT}. If 1 argument is defined as optional
* ($mandatory = false), all following arguments are autolamtically
* considered optional, too.
* @param string $name The name for the argument. Must be unique.
* @param int $type The value type.
* @param string $shorthelp A short help text.
* @param string $longhelp A long help text-
* @param bool $mandatory Whether the argument is mandatory.
* @param bool $multiple Whether the argument accepts multiple values.
* @param mixed $default A default value, if not mandatory.
$type =
ezcConsoleInput::TYPE_STRING,
$shorthelp =
"No help available.",
$longhelp =
"There is no help for this argument available.",
$this->shorthelp =
$shorthelp;
$this->longhelp =
$longhelp;
$this->mandatory =
$mandatory;
$this->multiple =
$multiple;
$this->default =
$default;
* @param string $propertyName Name of the property.
* @param string $propertyValue Valze for the property.
public function __set( $propertyName, $propertyValue )
if ( is_bool( $propertyValue ) ===
false )
if ( is_scalar( $propertyValue ) ===
false &&
is_array( $propertyValue ) ===
false &&
$propertyValue !==
null )
if ( is_scalar( $propertyValue ) ===
false &&
is_array( $propertyValue ) ===
false &&
$propertyValue !==
null )
$this->properties[$propertyName] =
$propertyValue;
* @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.
public function __get( $propertyName )
if ( isset
( $this->$propertyName ) )
* @param string $propertyName Name of the property.
* @return bool True is the property is set, otherwise false.
public function __isset( $propertyName )