Class Cli

Joomla! Input CLI Class

Joomla\Input\Input implements Serializable, Countable

Extended by

Joomla\Input\Cli

Namespace: Joomla\Input
Since: 1.0
Located at vendor/joomla/input/src/Cli.php

Methods summary

`public`	# `__construct( array $source = null, array $options = array() )` Constructor. Constructor. Parameters `$source` `array` - $source Source data (Optional, default is $_REQUEST) `$options` `array` - $options Array of configuration parameters (Optional) Since 1.0 Overrides `Joomla\Input\Input::__construct`
`public string`	# `serialize( )` Method to serialize the input. Method to serialize the input. Returns `string` - The serialized input. Since 1.0 Overrides `Joomla\Input\Input::serialize`
`public mixed`	# `get( string $name, mixed $default = null, string $filter = 'string' )` Gets a value from the input data. Gets a value from the input data. Parameters `$name` `string` - $name Name of the value to get. `$default` `mixed` - $default Default value to return if variable does not exist. `$filter` `string` - $filter Filter to apply to the value. Returns `mixed` - The filtered input value. Since 1.0 Overrides `Joomla\Input\Input::get`
`public Joomla\Input\Input`	# `unserialize( string $input )` Method to unserialize the input. Method to unserialize the input. Parameters `$input` `string` - $input The serialized input. Returns `Joomla\Input\Input` - The input object. Since 1.0 Overrides `Joomla\Input\Input::unserialize`
`protected`	# `parseArguments( )` Initialise the options and arguments Initialise the options and arguments Not supported: -abc c-value Since 1.0

Methods inherited from Joomla\Input\Input

__call(), __get(), count(), def(), exists(), getArray(), getMethod(), loadAllInputs(), set()

Magic methods summary

Magic methods inherited from Joomla\Input\Input

getAlnum(), getBase64(), getBool(), getCmd(), getFloat(), getHtml(), getInt(), getPath(), getString(), getUint(), getUsername(), getWord()

Properties summary

`public string`	`$executable`	# The executable that was called to run the CLI script. The executable that was called to run the CLI script. Since 1.0
`public array`	`$args`	# The additional arguments passed to the script that are not associated with a specific argument name. The additional arguments passed to the script that are not associated with a specific argument name. Since 1.0

Properties inherited from Joomla\Input\Input

$data, $filter, $inputs, $loaded, $options

Magic properties inherited from Joomla\Input\Input

$cookie, $files, $get, $post, $request, $server