1. class
  2. Joomla
  3. CMS
  4. Input
  5. Cookie

Cookie

class Cookie extends Input

Joomla! Input Cookie Class

Methods

__construct( array $source = null, array $options = array())

Constructor.

Input
__get( mixed $name)

Magic method to get an input object

from Input
mixed
getArray( array $vars = array(), mixed $datasource = null, string $defaultFilter = 'unknown')

Gets an array of values from the request.

from Input
Input
unserialize( string $input)

Method to unserialize the input.

from Input
void
set( string $name, mixed $value, integer $expire, string $path = '', string $domain = '', boolean $secure = false, boolean $httpOnly = false)

Sets a value

Details

__construct( array $source = null, array $options = array())

Constructor.

Parameters

array $source Source data (Optional, default is $_REQUEST)
array $options Array of configuration parameters (Optional)

Input __get( mixed $name)

Magic method to get an input object

Parameters

mixed $name Name of the input object to retrieve.

Return Value

Input The request input object

mixed getArray( array $vars = array(), mixed $datasource = null, string $defaultFilter = 'unknown')

Gets an array of values from the request.

Parameters

array $vars 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 JFilterInput::clean.
mixed $datasource Array to retrieve data from, or null.
string $defaultFilter Default filter used in JFilterInput::clean if vars is empty and datasource is null. If 'unknown', the default case is used in JFilterInput::clean.

Return Value

mixed The filtered input data.

Input unserialize( string $input)

Method to unserialize the input.

Parameters

string $input The serialized input.

Return Value

Input The input object.

void set( string $name, mixed $value, integer $expire, string $path = '', string $domain = '', boolean $secure = false, boolean $httpOnly = false)

Sets a value

Parameters

string $name Name of the value to set.
mixed $value Value to assign to the input.
integer $expire The 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).
string $path The 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.
string $domain The 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.
boolean $secure Indicates 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"]).
boolean $httpOnly When 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).

Return Value

void

See also

setcookie()