Cli
Extends InputJoomla! Input CLI Class
since |
1.7.0 |
---|---|
deprecated |
5.0 Use the |
package |
Joomla CMS |
Methods
__construct
Constructor.
__construct(array source = null, array options = array()) : mixed
since |
1.7.0 |
---|---|
deprecated |
5.0 Use Joomla\Input\Input instead |
Arguments
- source
array
Source data (Optional, default is $_REQUEST)- options
array
Array of configuration parameters (Optional)
Response
mixed
__get
Magic method to get an input object
__get(mixed name) : \Joomla\Input\Input
since |
1.7.0 |
---|---|
deprecated |
5.0 Use Joomla\Input\Input instead |
Arguments
- name
mixed
Name of the input object to retrieve.
Response
\Joomla\Input\Input
The request input object
getArray
Gets an array of values from the request.
getArray(array vars = array(), mixed datasource = null, string defaultFilter = 'unknown') : mixed
since |
1.7.0 |
---|---|
deprecated |
5.0 Use Joomla\Input\Input instead |
Arguments
- vars
array
Associative array of keys and filter types to apply. If empty and datasource is null, all the input data will be returned but filtered using the filter given by the parameter defaultFilter in InputFilter::clean.- datasource
mixed
Array to retrieve data from, or null.- defaultFilter
string
Default filter used in InputFilter::clean if vars is empty and datasource is null. If 'unknown', the default case is used in InputFilter::clean.
Response
mixed
The filtered input data.
getArrayRecursive
Gets an array of values from the request.
getArrayRecursive(array vars = array(), mixed datasource = null, string defaultFilter = 'unknown', bool recursion = false) : mixed
since |
3.4.2 |
---|---|
deprecated |
5.0 Use Joomla\Input\Input instead |
Arguments
- vars
array
Associative array of keys and filter types to apply. If empty and datasource is null, all the input data will be returned but filtered using the filter given by the parameter defaultFilter in InputFilter::clean.- datasource
mixed
Array to retrieve data from, or null.- defaultFilter
string
Default filter used in InputFilter::clean if vars is empty and datasource is null. If 'unknown', the default case is used in InputFilter::clean.- recursion
bool
Flag to indicate a recursive function call.
Response
mixed
The filtered input data.
parseArguments
Initialise the options and arguments
parseArguments() : void
Not supported: -abc c-value
since |
1.7.0 |
---|---|
deprecated |
5.0 Use the |
serialize
Method to serialize the input.
serialize() : string
since |
3.0.0 |
---|---|
deprecated |
5.0 Use the |
Response
string
The serialized input.
unserialize
Method to unserialize the input.
unserialize(string input) : \Joomla\CMS\Input\Input
since |
3.0.0 |
---|---|
deprecated |
5.0 Use Joomla\Input\Input instead |
Arguments
- input
string
The serialized input.
Response
\Joomla\CMS\Input\Input
The input object.
Properties
executable
The executable that was called to run the CLI script.
args
The additional arguments passed to the script that are not associated with a specific argument name.
allowedGlobals
Container with allowed superglobals
inputs
Input objects