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


Classes:
Console_CommandLine
Console_CommandLine_Action
Console_CommandLine_Action_Callback
Console_CommandLine_Action_Counter
Console_CommandLine_Action_Help
Console_CommandLine_Action_List
Console_CommandLine_Action_Password
Console_CommandLine_Action_StoreArray
Console_CommandLine_Action_StoreFalse
Console_CommandLine_Action_StoreFloat
Console_CommandLine_Action_StoreInt
Console_CommandLine_Action_StoreString
Console_CommandLine_Action_StoreTrue
Console_CommandLine_Action_Version
Console_CommandLine_Argument
Console_CommandLine_Command
Console_CommandLine_Element
Console_CommandLine_Exception
Console_CommandLine_MessageProvider_Default
Console_CommandLine_Option
Console_CommandLine_Outputter_Default
Console_CommandLine_Renderer_Default
Console_CommandLine_Result
Console_CommandLine_XmlParser
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
ex5.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_Argument

Source Location: /Console_CommandLine-1.2.0/Console/CommandLine/Argument.php

Class Overview

Console_CommandLine_Element
   |
   --Console_CommandLine_Argument

Class that represent a command line argument.


Author(s):

Version:

  • Release: 1.2.0

Copyright:

  • 2007 David JEAN LOUIS

Variables

Methods

Inherited Variables

Class: Console_CommandLine_Element

Console_CommandLine_Element::$default
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 42]
Class that represent a command line argument.


[ Top ]

Class Variables

$choices = array()

[line 69]

An array of possible values for the argument.
  • Var: Valid choices for the argument
  • Access: public

Type:   array


[ Top ]

$multiple =  false

[line 52]

Setting this to true will tell the parser that the argument expects more than one argument and that argument values should be stored in an array.
  • Var: Whether the argument expects multiple values
  • Access: public

Type:   boolean


[ Top ]

$optional =  false

[line 62]

Setting this to true will tell the parser that the argument is optional and can be ommited.

Note that it is not a good practice to make arguments optional, it is the role of the options to be optional, by essence.

  • Var: Whether the argument is optional or not.
  • Access: public

Type:   boolean


[ Top ]


Method Detail

validate   [line 81]

void validate( )

Validates the argument instance.
  • Todo: use exceptions
  • Throws: Console_CommandLine_Exception
  • Access: public

Overrides Console_CommandLine_Element::validate() (Validates the element instance and set it's default values.)
[ Top ]
Documentation generated on Thu, 25 Oct 2012 08:00:03 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.