Class Cookie
Joomla! Input Cookie Class
-
Joomla\Input\Input
implements
Serializable,
Countable
-
Joomla\Input\Cookie
Methods summary
public
|
#
__construct( array $source = null, array $options = array() )
Constructor.
Parameters
- $source
array - $source Ignored.
- $options
array - $options Array of configuration parameters (Optional)
Since
1.0
Overrides
|
public
|
#
set( string $name, mixed $value, integer $expire = 0, string $path = '', string $domain = '', boolean $secure = false, boolean $httpOnly = false )
Sets a value
Parameters
- $name
string - $name Name of the value to set.
- $value
mixed - $value Value to assign to the input.
- $expire
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()+60*60*24*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
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.
- $domain
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.
- $secure
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"]).
- $httpOnly
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).
Since
1.0
See
setcookie()
Link
Overrides
|
__call()
,
__get()
,
count()
,
def()
,
exists()
,
get()
,
getArray()
,
getMethod()
,
loadAllInputs()
,
serialize()
,
unserialize()
Magic methods summary
getAlnum()
,
getBase64()
,
getBool()
,
getCmd()
,
getFloat()
,
getHtml()
,
getInt()
,
getPath()
,
getString()
,
getUint()
,
getUsername()
,
getWord()
Properties summary
$data
,
$filter
,
$inputs
,
$loaded
,
$options
$cookie
,
$files
,
$get
,
$post
,
$request
,
$server