joomla_test/libraries/joomla/input/cookie.php
2020-01-02 22:20:31 +07:00

92 lines
4.0 KiB
PHP

<?php
/**
* @package Joomla.Platform
* @subpackage Input
*
* @copyright Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Joomla! Input Cookie Class
*
* @package Joomla.Platform
* @subpackage Input
* @since 11.1
*/
class JInputCookie extends JInput
{
/**
* Constructor.
*
* @param array $source Ignored.
* @param array $options Array of configuration parameters (Optional)
*
* @since 11.1
*/
public function __construct(array $source = null, array $options = array())
{
if (isset($options['filter']))
{
$this->filter = $options['filter'];
}
else
{
$this->filter = JFilterInput::getInstance();
}
// Set the data source.
$this->data = & $_COOKIE;
// Set the options for the class.
$this->options = $options;
}
/**
* Sets a value
*
* @param string $name Name of the value to set.
* @param mixed $value Value to assign to the input.
* @param 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).
* @param 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.
* @param 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.
* @param 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"]).
* @param 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 void
*
* @link http://www.ietf.org/rfc/rfc2109.txt
* @see setcookie()
* @since 11.1
*/
public function set($name, $value, $expire = 0, $path = '', $domain = '', $secure = false, $httpOnly = false)
{
setcookie($name, $value, $expire, $path, $domain, $secure, $httpOnly);
$this->data[$name] = $value;
}
}