setrawcookie

Description
Syntax
Examples
Links

Description

The setrawcookie of Network for PHP send a cookie without urlencoding the cookie value.

Syntax

 setrawcookie(
    string $name,
    string $value = ?,
    int $expires_or_options = 0,
    string $path = ?,
    string $domain = ?,
    bool $secure = false,
    bool $httponly = false
): bool

setrawcookie(
    string $name,
    string $value = ?,
    array $options = []
): bool

Parameters

value

The value of the cookie. This value is stored on the clients computer; do not store sensitive information. Assuming the name is 'cookiename', this value is retrieved through $_COOKIE['cookiename']

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).

NOTE: You may notice the expires parameter takes on a Unix timestamp, as opposed to the date format Wdy, DD-Mon-YYYY HH:MM:SS GMT, this is because PHP does this conversion internally.

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 '/test/', the cookie will only be available within the /test/ directory and all sub-directories such as /test/stuff/ of domain. The default value is the current directory that the cookie is being set in.

domain

The (sub)domain that the cookie is available to. Setting this to a subdomain (such as 'www.example.com') will make the cookie available to that subdomain and all other sub-domains of it (i.e. w2.www.example.com). To make the cookie available to the whole domain (including all subdomains of it), simply set the value to the domain name ('example.com', in this case). Older browsers still implementing the deprecated » RFC 2109 may require a leading . to match all subdomains.

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

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. It has been suggested that this setting can effectively help to reduce identity theft through XSS attacks (although it is not supported by all browsers), but that claim is often disputed. Added in PHP 5.2.0. TRUE or FALSE

options

An associative array which may have any of the keys expires, path, domain, secure, httponly and samesite. If any other key is present an error of level E_WARNING is generated. The values have the same meaning as described for the parameters with the same name. The value of the samesite element should be either None, Lax or Strict. If any of the allowed options are not given, their default values are the same as the default values of the explicit parameters. If the samesite element is omitted, no SameSite cookie attribute is set.

<?

$name = "myname";

$return = setrawcookie($name);

var_export($return);

true

2 · value

<?

$name = "myname";
$value = "myvalue";

$return = setrawcookie($name, $value);

var_export($return);

true

3 · expires_or_options

<?

$name = "myname";
$value = "myvalue";
$expires_or_options = strtotime("1 year 1 month 1 week 1 day 1 hour 1 minute 1 second");

$return = setrawcookie($name, $value, $expires_or_options);

var_export($return);

true

4 · path

<?

$name = "myname";
$value = "myvalue";
$expires_or_options = 0;
$path = "/";

$return = setrawcookie($name, $value, $expires_or_options, $path);

var_export($return);

true

5 · domain

<?

$name = "myname";
$value = "myvalue";
$expires_or_options = 0;
$path = "/";
$domain = "osbo.com";

$return = setrawcookie($name, $value, $expires_or_options, $path, $domain);

var_export($return);

true

6 · secure

<?

$name = "myname";
$value = "myvalue";
$expires_or_options = 0;
$path = "/";
$domain = "osbo.com";
$secure = true;

$return = setrawcookie($name, $value, $expires_or_options, $path, $domain, $secure);

var_export($return);

true

7 · httponly

<?

$name = "myname";
$value = "myvalue";
$expires_or_options = 0;
$path = "/";
$domain = "osbo.com";
$secure = true;
$httponly = true;

$return = setrawcookie($name, $value, $expires_or_options, $path, $domain, $secure, $httponly);

var_export($return);

true

8 · options

<?

$name = "myname";
$value = "myvalue";
$options =
[
    "expires" => 0,
    "path" => "/",
    "domain" => "osbo.com",
    "secure" => true,
    "httponly" => true,
    "samesite" => "strict"
];

$return = setrawcookie($name, $value, $options);

var_export($return);

true