class JInputCLI extends JInput


Located at : UKNOWVA_ROOT/libraries/joomla/application/input/cli.php

Joomla! Input CLI Class

Properties

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

Methods

__construct(array $source = null, array $options = array())

Constructor.

__get(mixed $name)

Magic method to get an input object

from JInput
mixed
get(string $name, mixed $default = null, string $filter = 'cmd')

Gets a value from the input data.

from JInput
mixed
getArray(array $vars, mixed $datasource = null)

Gets an array of values from the request.

from JInput
void
set(string $name, mixed $value)

Sets a value

from JInput
boolean
__call(mixed $name, string $arguments)

Magic method to get filtered input data.

from JInput
string
getMethod(mixed $name, string $arguments)

Gets the request method.

from JInput

Details

at line 50
JInput __construct(array $source = null, array $options = array())

Constructor.

Parameters

array $source Source data (Optional, default is $_REQUEST)
array $options Array of configuration parameters (Optional)

Return Value

JInput

in JInput at line 96
JInput __get(mixed $name)

Magic method to get an input object

Parameters

mixed $name Name of the input object to retrieve.

Return Value

JInput The request input object

in JInput at line 128
mixed get(string $name, mixed $default = null, string $filter = 'cmd')

Gets a value from the input data.

Parameters

string $name Name of the value to get.
mixed $default Default value to return if variable does not exist.
string $filter Filter to apply to the value.

Return Value

mixed The filtered input value.

in JInput at line 147
mixed getArray(array $vars, mixed $datasource = null)

Gets an array of values from the request.

Parameters

array $vars Associative array of keys and filter types to apply.
mixed $datasource Array to retrieve data from, or null

Return Value

mixed The filtered input data.

in JInput at line 180
void set(string $name, mixed $value)

Sets a value

Parameters

string $name Name of the value to set.
mixed $value Value to assign to the input.

Return Value

void

in JInput at line 195
boolean __call(mixed $name, string $arguments)

Magic method to get filtered input data.

Parameters

mixed $name Name of the value to get.
string $arguments Default value to return if variable does not exist.

Return Value

boolean The filtered boolean input value.

in JInput at line 220
string getMethod(mixed $name, string $arguments)

Gets the request method.

Parameters

mixed $name Name of the value to get.
string $arguments Default value to return if variable does not exist.

Return Value

string The request method.