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

Class: Console_CommandLine_Action_StoreArray

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

Class Overview

Console_CommandLine_Action
   |
   --Console_CommandLine_Action_StoreArray

Class that represent the StoreArray action.


Author(s):

Version:

  • Release: 1.2.0

Copyright:

  • 2007 David JEAN LOUIS

Variables

Methods


Inherited Variables

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 45]
Class that represent the StoreArray action.

The execute method appends the value of the option entered by the user to the result option array entry.



[ Top ]


Class Variables

$firstPass =  true

[line 54]

Force a clean result when first called, overriding any defaults assigned.
  • Var: First time this action has been called.
  • Access: protected

Type:   object


[ Top ]



Method Detail

execute   [line 67]

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

Executes the action with the value entered by the user.
  • 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 Thu, 25 Oct 2012 08:00:07 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.