Files
Extends InputJoomla! Input Files Class
| since |
1.7.0 |
|---|---|
| deprecated |
4.3 will be removed in 6.0. Use Joomla\Input\Files instead |
| package |
Joomla CMS |
Methods
__construct
The class constructor.
__construct(mixed||string|int source = null, mixed||string|int options = []) :
| since |
3.0.0 |
|---|---|
| deprecated |
4.3 will be removed in 6.0. Use Joomla\Input\Files instead |
Arguments
- source
array<string|int, mixed>The source argument is ignored. $_FILES is always used.- options
array<string|int, mixed>An optional array of configuration options: filter : a custom InputFilter object.
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
mixedName of the input object to retrieve.
Response
InputThe request input object
decodeData
Method to decode a data array.
decodeData(mixed||string|int data) : mixed||string|int
| since |
1.7.0 |
|---|---|
| deprecated |
4.3 will be removed in 6.0. Use Joomla\Input\Files instead |
Arguments
- data
array<string|int, mixed>The data array to decode.
Response
array<string|int, mixed>
get
Gets a value from the input data.
get( name, default = null, filter = 'cmd') :
| see | InputFilter::clean() |
|---|---|
| since |
1.7.0 |
| deprecated |
4.3 will be removed in 6.0. Use Joomla\Input\Files instead |
Arguments
- name
stringThe name of the input property (usually the name of the files INPUT tag) to get.- default
mixedThe default value to return if the named property does not exist.- filter
stringThe filter to apply to the value.
Response
mixedThe filtered input value.
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
mixedArray to retrieve data from, or null.- defaultFilter
stringDefault filter used in InputFilter::clean if vars is empty and datasource is null. If 'unknown', the default case is used in InputFilter::clean.
Response
mixedThe 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
mixedArray to retrieve data from, or null.- defaultFilter
stringDefault filter used in InputFilter::clean if vars is empty and datasource is null. If 'unknown', the default case is used in InputFilter::clean.- recursion
boolFlag to indicate a recursive function call.
Response
mixedThe filtered input data.
set
Sets a value.
set( name, value) :
| since |
1.7.0 |
|---|---|
| deprecated |
4.3 will be removed in 6.0. Use Joomla\Input\Files instead |
Arguments
- name
stringThe name of the input property to set.- value
mixedThe value to assign to the input property.
Response
void
unserialize
Method to unserialize the input.
unserialize( input) :
| since |
3.0.0 |
|---|---|
| deprecated |
4.3 will be removed in 6.0. Use Joomla\Input\Input instead |
Arguments
- input
stringThe 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>
decodedData
The pivoted data from a $_FILES or compatible array.
| since |
1.7.0 |
|---|---|
| deprecated |
4.3 will be removed in 6.0. Use Joomla\Input\Files instead |
Type(s)
array<string|int, mixed>