Cli
Extends InputJoomla! Input CLI Class
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0
Use the |
package |
Joomla CMS |
Methods
__construct
Constructor.
__construct(mixed||string|int source = null, mixed||string|int options = []) :
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0
Use the |
Arguments
- source
array<string|int, mixed>
Source data (Optional, default is $_REQUEST)- options
array<string|int, mixed>
Array of configuration parameters (Optional)
Response
mixed
__get
Magic method to get an input object
__get( name) : \Joomla\Input\Input
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0. Use Joomla\Input\Input instead |
Arguments
- name
mixed
Name of the input object to retrieve.
Response
Input
The request input object
getArray
Gets an array of values from the request.
getArray(mixed||string|int vars = [], datasource = null, defaultFilter = 'unknown') :
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0. Use Joomla\Input\Input instead |
Arguments
- vars
array<string|int, mixed>
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(mixed||string|int vars = [], datasource = null, defaultFilter = 'unknown', recursion = false) :
since |
3.4.2 |
---|---|
deprecated |
4.3 will be removed in 6.0. Use Joomla\Input\Input instead |
Arguments
- vars
array<string|int, mixed>
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() :
Not supported: -abc c-value
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0
Use the |
Response
void
serialize
Method to serialize the input.
serialize() :
since |
3.0.0 |
---|---|
deprecated |
4.3 will be removed in 6.0
Use the |
Response
string
The serialized input.
unserialize
Method to unserialize the input.
unserialize( input) :
since |
3.0.0 |
---|---|
deprecated |
4.3 will be removed in 6.0
Use the |
Arguments
- input
string
The serialized input.
Response
void
Properties
allowedGlobals
Container with allowed superglobals
since |
3.8.9 |
---|---|
deprecated |
4.3 will be removed in 6.0. Use Joomla\Input\Input instead |
Type(s)
array<string|int, mixed>
inputs
Input objects
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0. Use Joomla\Input\Input instead |
Type(s)
array<string|int, Input>
executable
The executable that was called to run the CLI script.
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0
Use the |
Type(s)
string
args
The additional arguments passed to the script that are not associated with a specific argument name.
since |
1.7.0 |
---|---|
deprecated |
4.3 will be removed in 6.0
Use the |
Type(s)
array<string|int, mixed>