Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JInputCookie
+ Graphe d'héritage de JInputCookie:
+ Graphe de collaboration de JInputCookie:

Liste de tous les membres

Fonctions membres publiques

 __construct (array $source=null, array $options=array())
 set ($name, $value, $expire=0, $path= '', $domain= '', $secure=false, $httpOnly=false)
- Fonctions membres publiques inherited from JInput
 __construct ($source=null, array $options=array())
 __get ($name)
 count ()
 get ($name, $default=null, $filter= 'cmd')
 getArray (array $vars=array(), $datasource=null)
 set ($name, $value)
 def ($name, $value)
 __call ($name, $arguments)
 getMethod ()
 serialize ()
 unserialize ($input)

Additional Inherited Members

- Fonctions membres protégées inherited from JInput
 loadAllInputs ()
- Attributs protégés inherited from JInput
 $options = array()
 $filter = null
 $data = array()
 $inputs = array()

Description détaillée

Définition à la ligne 19 du fichier cookie.php.


Documentation des constructeurs et destructeur

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

Constructor.

Paramètres:
array$sourceIgnored.
array$optionsArray of configuration parameters (Optional)
Depuis:
11.1

Définition à la ligne 29 du fichier cookie.php.

Références JFilterInput\getInstance().

{
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;
}

+ Voici le graphe d'appel pour cette fonction :


Documentation des fonctions membres

JInputCookie::set (   $name,
  $value,
  $expire = 0,
  $path = '',
  $domain = '',
  $secure = false,
  $httpOnly = false 
)

Sets a value

Paramètres:
string$nameName of the value to set.
mixed$valueValue to assign to the input.
integer$expireThe 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).
string$pathThe 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$domainThe 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$secureIndicates 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$httpOnlyWhen 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).
Renvoie:
void

setcookie() 11.1

Définition à la ligne 85 du fichier cookie.php.

{
setcookie($name, $value, $expire, $path, $domain, $secure, $httpOnly);
$this->data[$name] = $value;
}

La documentation de cette classe a été générée à partir du fichier suivant :