Json
Extends \Joomla\Input\InputJoomla! Input JSON Class
This class decodes a JSON string from the raw request data and makes it available via the standard Input interface.
| since |
1.0 |
|---|
Methods
__call
Magic method to get filtered input data.
__call(string $name, array $arguments) : mixed
| since |
1.0 |
|---|
Arguments
- $name
stringName of the filter type prefixed with 'get'.- $arguments
array[0] The name of the variable [1] The default value.
Response
mixedThe filtered input value.
__construct
Constructor.
__construct(array $source = null, array $options = array())
| since |
1.0 |
|---|
Arguments
- $source
arrayOptional source data. If omitted, a copy of the server variable '_REQUEST' is used.- $options
arrayAn optional associative array of configuration parameters: filter: An instance of Filter\Input. If omitted, a default filter is initialised.
__get
Magic method to get an input object
__get(mixed $name) : \Joomla\Input\Input
| since |
1.0 |
|---|
Arguments
- $name
mixedName of the input object to retrieve.
Response
\Joomla\Input\InputThe request input object
count
Get the number of variables.
count() : integer
| since |
1.0 |
|---|---|
| see | \Joomla\Input\Countable::count() |
Response
integerThe number of variables in the input.
def
Define a value. The value will only be set if there's no value for the name or if it is null.
def(string $name, mixed $value) : void
| since |
1.0 |
|---|
Arguments
- $name
stringName of the value to define.- $value
mixedValue to assign to the input.
exists
Check if a value name exists.
exists(string $name) : boolean
| since |
1.2.0 |
|---|
Arguments
- $name
stringValue name
Response
boolean
get
Gets a value from the input data.
get(string $name, mixed $default = null, string $filter = 'cmd') : mixed
| see | \Joomla\Filter\InputFilter::clean() |
|---|---|
| since |
1.0 |
Arguments
- $name
stringName of the value to get.- $default
mixedDefault value to return if variable does not exist.- $filter
stringFilter to apply to the value.
Response
mixedThe filtered input value.
getAlnum
getAlnum(mixed $name, mixed $default = null) : string
Get an alphanumeric string.
Arguments
- $name
mixed- $default
mixed
Response
string
getArray
Gets an array of values from the request.
getArray(array $vars = array(), mixed $datasource = null) : mixed
| since |
1.0 |
|---|
Arguments
- $vars
arrayAssociative 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 default case in JFilterInput::clean.- $datasource
mixedArray to retrieve data from, or null
Response
mixedThe filtered input data.
getBase64
getBase64(mixed $name, mixed $default = null) : string
Get a base64 encoded string.
Arguments
- $name
mixed- $default
mixed
Response
string
getBool
getBool(mixed $name, mixed $default = null) : boolean
Get a boolean value.
Arguments
- $name
mixed- $default
mixed
Response
boolean
getCmd
getCmd(mixed $name, mixed $default = null) : string
Get a CMD filtered string.
Arguments
- $name
mixed- $default
mixed
Response
string
getFloat
getFloat(mixed $name, mixed $default = null) : float
Get a floating-point number.
Arguments
- $name
mixed- $default
mixed
Response
float
getHtml
getHtml(mixed $name, mixed $default = null) : string
Get a HTML string.
Arguments
- $name
mixed- $default
mixed
Response
string
getInputForRequestMethod
Get the Input instance holding the data for the current request method
getInputForRequestMethod() : \Joomla\Input\Input
getInt
getInt(mixed $name, mixed $default = null) : integer
Get a signed integer.
Arguments
- $name
mixed- $default
mixed
Response
integer
getMethod
Gets the request method.
getMethod() : string
| since |
1.0 |
|---|
Response
stringThe request method.
getPath
getPath(mixed $name, mixed $default = null) : string
Get a file path.
Arguments
- $name
mixed- $default
mixed
Response
string
getRaw
Gets the raw JSON string from the request.
getRaw() : string
| since |
1.0 |
|---|
Response
stringThe raw JSON string from the request.
getString
getString(mixed $name, mixed $default = null) : string
Get a string.
Arguments
- $name
mixed- $default
mixed
Response
string
getUint
getUint(mixed $name, mixed $default = null) : integer
Get an unsigned integer.
Arguments
- $name
mixed- $default
mixed
Response
integer
getUsername
getUsername(mixed $name, mixed $default = null) : string
Get a username.
Arguments
- $name
mixed- $default
mixed
Response
string
getWord
getWord(mixed $name, mixed $default = null) : string
Get a word.
Arguments
- $name
mixed- $default
mixed
Response
string
loadAllInputs
Method to load all of the global inputs.
loadAllInputs() : void
| since |
1.0 |
|---|
serialize
Method to serialize the input.
serialize() : string
| since |
1.0 |
|---|
Response
stringThe serialized input.
set
Sets a value
set(string $name, mixed $value) : void
| since |
1.0 |
|---|
Arguments
- $name
stringName of the value to set.- $value
mixedValue to assign to the input.
unserialize
Method to unserialize the input.
unserialize(string $input) : void
| since |
1.0 |
|---|
Arguments
- $input
stringThe serialized input.
Properties
raw
The raw JSON string from the request.
| since |
1.0 |
|---|
Type(s)
string
allowedGlobals
Container with allowed superglobals
| since |
1.3.0 |
|---|---|
| note |
Once PHP 7.1 is the minimum supported version this should become a private constant |
Type(s)
array
options
Options array for the Input instance.
| since |
1.0 |
|---|
Type(s)
array
data
Input data.
| since |
1.0 |
|---|
Type(s)
array
loaded
Is all GLOBAL added
| since |
1.1.4 |
|---|
Type(s)
boolean
get
Type(s)
\Joomla\Input\Input
post
Type(s)
\Joomla\Input\Input
request
Type(s)
\Joomla\Input\Input
server
Type(s)
\Joomla\Input\Input
env
Type(s)
\Joomla\Input\Input
files
Type(s)
\Joomla\Input\Files
cookie
Type(s)
\Joomla\Input\Cookie