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

Class: Console_CommandLine_Action_StoreInt

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

Class Overview

Console_CommandLine_Action
   |
   --Console_CommandLine_Action_StoreInt

Class that represent the StoreInt action.


Author(s):

Version:

  • Release: 1.2.0

Copyright:

  • 2007 David JEAN LOUIS

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 46]
Class that represent the StoreInt action.

The execute method store the value of the option entered by the user as an integer in the result option array entry, if the value passed is not an integer an Exception is raised.



[ Top ]


Method Detail

execute   [line 59]

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

Executes the action with the value entered by the user.
  • Throws: Console_CommandLine_Exception
  • 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 array of optional parameters

[ Top ]


Documentation generated on Thu, 25 Oct 2012 08:00:07 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.