t3lib_cli Class Reference

Inheritance diagram for t3lib_cli:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 t3lib_cli ()
 cli_getArgArray ($option, $argv)
 cli_isArg ($option)
 cli_argValue ($option, $idx=0)
 cli_getArgIndex ()
 cli_validateArgs ()
 cli_keyboardInput ()
 cli_keyboardInput_yes ($msg='')
 cli_echo ($string='', $force=FALSE)
 cli_help ()
 cli_indent ($str, $indent)

Public Attributes

 $cli_args = array()
 $cli_options
 $cli_help
 $stdin = NULL

Detailed Description

Definition at line 60 of file class.t3lib_cli.php.

Member Function Documentation

t3lib_cli::t3lib_cli (  ) 

Constructor Make sure child classes also call this!

Returns:
void

Definition at line 86 of file class.t3lib_cli.php.

t3lib_cli::cli_getArgArray ( $  option,
$  argv 
)

Finds the arg token (like "-s") in argv and returns the rest of argv from that point on. This should only be used in special cases since this->cli_args should already be prepared with an index of values!

Parameters:
string Option string, eg. "-s"
array Input argv array
Returns:
array Output argv array with all options AFTER the found option.

Definition at line 99 of file class.t3lib_cli.php.

t3lib_cli::cli_isArg ( $  option  ) 

Return true if option is found

Parameters:
string Option string, eg. "-s"
Returns:
boolean TRUE if option found

Definition at line 116 of file class.t3lib_cli.php.

t3lib_cli::cli_argValue ( $  option,
$  idx = 0 
)

Return argument value

Parameters:
string Option string, eg. "-s"
integer Value index, default is 0 (zero) = the first one...
Returns:
boolean TRUE if option found

Definition at line 127 of file class.t3lib_cli.php.

t3lib_cli::cli_getArgIndex (  ) 

Will parse "_SERVER[argv]" into an index of options and values Argument names (eg. "-s") will be keys and values after (eg. "-s value1 value2 ..." or "-s=value1") will be in the array. Array is empty if no values

Returns:
array

Definition at line 138 of file class.t3lib_cli.php.

t3lib_cli::cli_validateArgs (  ) 

Validates if the input arguments in this->cli_args are all listed in this->cli_options and if not, will exit with an error.

Definition at line 162 of file class.t3lib_cli.php.

t3lib_cli::cli_keyboardInput (  ) 

Asks stdin for keyboard input and returns the line (after enter is pressed)

Returns:
string

Definition at line 203 of file class.t3lib_cli.php.

t3lib_cli::cli_keyboardInput_yes ( $  msg = ''  ) 

Asks for Yes/No from shell and returns true if "y" or "yes" is found as input.

Parameters:
string String to ask before...
Returns:
boolean TRUE if "y" or "yes" is the input (case insensitive)

Definition at line 221 of file class.t3lib_cli.php.

t3lib_cli::cli_echo ( $  string = '',
$  force = FALSE 
)

Echos strings to shell, but respective silent-modes

Parameters:
string The string
boolean If string should be written even if -s is set (-ss will subdue it!)
Returns:
boolean Returns TRUE if string was outputted.

Definition at line 233 of file class.t3lib_cli.php.

t3lib_cli::cli_help (  ) 

Prints help-output from ->cli_help array

Returns:
void

Definition at line 248 of file class.t3lib_cli.php.

t3lib_cli::cli_indent ( $  str,
$  indent 
)

Indentation function for 75 char wide lines.

Parameters:
string String to break and indent.
integer Number of space chars to indent.
Returns:
string Result

Definition at line 286 of file class.t3lib_cli.php.

The documentation for this class was generated from the following file:
This documentation has been generated automatically from TYPO3 source code using Doxygen and is provided as is by Cast Iron Coding as a courtesy to other TYPO3 developers and users. Please consider Cast Iron Coding — a full-service web development agency in Portland, Oregon specializing in TYPO3 extension development — for all of your TYPO3 development and consulting needs!