[ class tree: Console_CommandLine ] [ index: Console_CommandLine ] [ all elements ]

Packages:
Console_CommandLine

Classes:

Files:

Action.php
Argument.php
Callback.php
Command.php
CommandLine.php
Counter.php
CustomMessageProvider.php
Default.php
Default.php
Default.php
Element.php
ex1.php
ex2.php
ex3.php
ex4.php
Exception.php
Help.php
List.php
MessageProvider.php
Option.php
Outputter.php
Password.php
Renderer.php
Result.php
StoreArray.php
StoreFalse.php
StoreFloat.php
StoreInt.php
StoreString.php
StoreTrue.php
Version.php
XmlParser.php

Class: Console_CommandLine_Option

Source Location: /Console_CommandLine-1.1.3/Console/CommandLine/Option.php

Class Overview

Console_CommandLine_Element
 |
 --Console_CommandLine_Option

Class that represent a commandline option.

Author(s):

David JEAN LOUIS <izimobil at gmail.com>

Version:

Release: 1.1.3

Copyright:

2007 David JEAN LOUIS

Inherited Variables

Class: Console_CommandLine_Element

Console_CommandLine_Element::$description
Console_CommandLine_Element::$help_name
Console_CommandLine_Element::$messages
Console_CommandLine_Element::$name

Inherited Methods

Class: Console_CommandLine_Element

Console_CommandLine_Element::__construct(): Constructor.
Console_CommandLine_Element::toString(): Returns the string representation of the element.
Console_CommandLine_Element::validate(): Validates the element instance and set it's default values.

Class Details

[line 43]
Class that represent a commandline option.

Author: David JEAN LOUIS <izimobil@gmail.com>
Version: Release: 1.1.3
Copyright: 2007 David JEAN LOUIS
Link: http://pear.php.net/package/Console_CommandLine
Since: Class available since release 0.1.0
License: MIT License

[ Top ]

Class Variables

$action = 'StoreString'

[line 66]

The option action, defaults to "StoreString".

Var: Option action
Access: public

Type: string

[ Top ]

$action_params = array()

[line 127]

An associative array of additional params to pass to the class corresponding to the action, this array will also be passed to the callback defined for an action of type Callback, Example:

 // for a custom action

 $parser->addOption('myoption', array(
   'short_name'  => '-m',
   'long_name'   => '--myoption',
   'action'    => 'MyCustomAction',
   'action_params' => array('foo'=>true, 'bar'=>false)
 ));

 // if the user type:
 // $ <yourprogram> -m spam
 // in your MyCustomAction class the execute() method will be called
 // with the value 'spam' as first parameter and
 // array('foo'=>true, 'bar'=>false) as second parameter

Var: Additional parameters to pass to the action
Access: public

Type: array

[ Top ]

$add_list_option = false

[line 144]

For options that uses the "choice" property only.

Adds a --list-<choice> option to the parser that displays the list of choices for the option.

Var: Whether to add a list option or not
Access: public

Type: bool

[ Top ]

$argument_optional = false

[line 135]

For options that expect an argument, this property tells the parser if the option argument is optional and can be ommited.

Var: Whether the option arg is optional or not
Access: public

Type: bool

[ Top ]

$callback =

[line 102]

The callback function (or method) to call for an action of type Callback, this can be any callable supported by the php function call_user_func.

Example:

 $parser->addOption('myoption', array(

   'short_name' => '-m',
   'long_name' => '--myoption',
   'action'   => 'Callback',
   'callback'  => 'myCallbackFunction'
 ));

Var: The option callback
Access: public

Type: callable

[ Top ]

$choices = array()

[line 82]

An array of possible values for the option. If this array is not empty and the value passed is not in the array an exception is raised.

This only make sense for actions that accept values of course.

Var: Valid choices for the option
Access: public

Type: array

[ Top ]

$default =

[line 73]

The default value of the option if not provided on the command line.

Var: Default value of the option.
Access: public

Type: mixed

[ Top ]

$long_name =

[line 59]

The option long name (ex: --verbose).

Var: Long name of the option
Access: public

Type: string

[ Top ]

$short_name =

[line 52]

The option short name (ex: -v).

Var: Short name of the option
Access: public

Type: string

[ Top ]

Method Detail

__construct (Constructor) [line 167]

void __construct(
[string
$name = null], [array
$params = array()])

Constructor.

Access: public

Overrides Console_CommandLine_Element::__construct() (Constructor.)

Parameters:

string $name — The name of the option

array $params — An optional array of parameters

[ Top ]

dispatchAction [line 241]

void dispatchAction(
mixed
$value, Console_CommandLine_Result
$result, Console_CommandLine
$parser)

Formats the value $value according to the action of the option and updates the passed Console_CommandLine_Result object.

Throws: Console_CommandLine_Exception
Access: public

Parameters:

mixed $value — The value to format

Console_CommandLine_Result $result — The result instance

Console_CommandLine $parser — The parser instance

[ Top ]

expectsArgument [line 217]

bool expectsArgument(
)

Returns true if the option requires one or more argument and false otherwise.

Return: Whether the option expects an argument or not
Access: public

[ Top ]

setDefaults [line 344]

void setDefaults(
)

Set the default value according to the configured action.

Note that for backward compatibility issues this method is only called when the 'force_options_defaults' is set to true, it will become the default behaviour in the next major release of Console_CommandLine.

Access: public

[ Top ]

toString [line 188]

string toString(
[string
$delim = ", "])

Returns the string representation of the option.

Return: The string representation of the option
Todo: use __toString() instead
Access: public

Overrides Console_CommandLine_Element::toString() (Returns the string representation of the element.)

Parameters:

string $delim — Delimiter to use between short and long option

[ Top ]

validate [line 280]

void validate(
)

Validates the option instance.

Todo: use exceptions instead
Throws: Console_CommandLine_Exception
Access: public

Overrides Console_CommandLine_Element::validate() (Validates the element instance and set it's default values.)

[ Top ]