t3lib_cli Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	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)
Öffentliche Attribute
	$cli_args = array()
	$cli_options
	$cli_help
	$stdin = NULL

---

Dokumentation der Elementfunktionen

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

Return argument value

Parameter:

	string	Option string, eg. "-s"
	integer	Value index, default is 0 (zero) = the first one...

Rückgabe:

boolean TRUE if option found

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

Echos strings to shell, but respective silent-modes

Parameter:

	string	The string
	boolean	If string should be written even if -s is set (-ss will subdue it!)

Rückgabe:

boolean Returns TRUE if string was outputted.

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!

Parameter:

	string	Option string, eg. "-s"
	array	Input argv array

Rückgabe:

array Output argv array with all options AFTER the found option.

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

Rückgabe:

array

t3lib_cli::cli_help

(

)

Prints help-output from ->cli_help array

Rückgabe:

void

t3lib_cli::cli_indent	(	$	str,
		$	indent
	)

Indentation function for 75 char wide lines.

Parameter:

	string	String to break and indent.
	integer	Number of space chars to indent.

Rückgabe:

string Result

t3lib_cli::cli_isArg

(

$

option

)

Return true if option is found

Parameter:

string

Option string, eg. "-s"

Rückgabe:

boolean TRUE if option found

t3lib_cli::cli_keyboardInput

(

)

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

Rückgabe:

string

t3lib_cli::cli_keyboardInput_yes

(

$

msg = ''

)

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

Parameter:

string

String to ask before...

Rückgabe:

boolean TRUE if "y" or "yes" is the input (case insensitive)

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.

t3lib_cli::t3lib_cli

(

)

Constructor Make sure child classes also call this!

Rückgabe:

void

---

Dokumentation der Datenelemente

t3lib_cli::$cli_help

Initialisierung:

 array(
                        'name' => 'CLI base class (overwrite this...)',
                        'synopsis' => '###OPTIONS###',
                        'description' => 'Class with basic functionality for CLI scripts (overwrite this...)',
                        'examples' => 'Give examples...',
                        'options' => '',
                        'license' => 'GNU GPL - free software!',
                        'author' => '[Author name]',
                )

t3lib_cli::$cli_options

Initialisierung:

 array(
                array('-s','Silent operation, will only output errors and important messages.'),
                array('--silent','Same as -s'),
                array('-ss','Super silent, will not even output errors or important messages.'),
        )

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /srv/www/vhosts/typo3.local/typo3_src-4.2.10/t3lib/class.t3lib_cli.php