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_Action_List

Source Location: /Console_CommandLine-1.2.0/Console/CommandLine/Action/List.php

Class Overview

Console_CommandLine_Action
   |
   --Console_CommandLine_Action_List

Class that represent the List action, a special action that simply output an array as a list.


Author(s):

Version:

  • Release: 1.2.0

Copyright:

  • 2007 David JEAN LOUIS

Methods

Inherited Variables

Class: Console_CommandLine_Action

Console_CommandLine_Action::$option
Console_CommandLine_Action::$parser
Console_CommandLine_Action::$result

Inherited Methods

Class: Console_CommandLine_Action

Console_CommandLine_Action::__construct()
Constructor
Console_CommandLine_Action::execute()
Executes the action with the value entered by the user.
Console_CommandLine_Action::format()
Allow a value to be pre-formatted prior to being used in a choices test.
Console_CommandLine_Action::getResult()
Convenience method to retrieve the value of result->options[name].
Console_CommandLine_Action::setResult()
Convenience method to assign the result->options[name] value.

Class Details

[line 43]
Class that represent the List action, a special action that simply output an array as a list.


[ Top ]

Method Detail

execute   [line 61]

string execute( [mixed $value = false], [array $params = array()])

Executes the action with the value entered by the user.

Possible parameters are:

  • message: an alternative message to display instead of the default message,
  • delimiter: an alternative delimiter instead of the comma,
  • post: a string to append after the message (default is the new line char).

  • Access: public

Overrides Console_CommandLine_Action::execute() (Executes the action with the value entered by the user.)

Parameters:

mixed   $value   —  The option value
array   $params   —  An optional array of parameters

[ Top ]
Documentation generated on Mon, 11 Mar 2019 15:51:32 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.