Cookie
Extends InputJoomla! Input Cookie Class
| since |
1.7.0 |
|---|---|
| deprecated |
5.0 Use Joomla\Input\Cookie instead |
| package |
Application |
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
arraySource data (Optional, default is $_REQUEST)- options
arrayArray 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
mixedName of the input object to retrieve.
Response
\Joomla\Input\InputThe 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
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 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(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
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 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(string name, mixed value, int expire, string path = '', string domain = '', bool secure = false, bool httpOnly = false) : void
| link | |
|---|---|
| see | \Joomla\CMS\Input\setcookie() |
| since |
1.7.0 |
| deprecated |
5.0 Use Joomla\Input\Cookie instead |
Arguments
- name
stringName of the value to set.- value
mixedValue to assign to the input.- expire
intThe time the cookie expires. This is a Unix timestamp so is in number of seconds since the epoch. In other words, you'll most likely set this with the time() function plus the number of seconds before you want it to expire. Or you might use mktime(). time()+606024*30 will set the cookie to expire in 30 days. If set to 0, or omitted, the cookie will expire at the end of the session (when the browser closes).- path
stringThe path on the server in which the cookie will be available on. If set to '/', the cookie will be available within the entire domain. If set to '/foo/', the cookie will only be available within the /foo/ directory and all sub-directories such as /foo/bar/ of domain. The default value is the current directory that the cookie is being set in.- domain
stringThe domain that the cookie is available to. To make the cookie available on all subdomains of example.com (including example.com itself) then you'd set it to '.example.com'. Although some browsers will accept cookies without the initial ., RFC 2109 requires it to be included. Setting the domain to 'www.example.com' or '.www.example.com' will make the cookie only available in the www subdomain.- secure
boolIndicates that the cookie should only be transmitted over a secure HTTPS connection from the client. When set to TRUE, the cookie will only be set if a secure connection exists. On the server-side, it's on the programmer to send this kind of cookie only on secure connection (e.g. with respect to $_SERVER["HTTPS"]).- httpOnly
boolWhen TRUE the cookie will be made accessible only through the HTTP protocol. This means that the cookie won't be accessible by scripting languages, such as JavaScript. This setting can effectively help to reduce identity theft through XSS attacks (although it is not supported by all browsers).
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
stringThe serialized input.
Response
\Joomla\CMS\Input\InputThe input object.
Properties
allowedGlobals
Container with allowed superglobals
inputs
Input objects