1. class
  2. Comodojo
  3. \
  4. Cookies
  5. \
  6. SecureCookie

SecureCookie

class SecureCookie extends EncryptedCookie (View source)

AES-encrypted cookie using client-specific key

Properties

protected string $name The cookie name from AbstractCookie
protected string $value Cookie value (native string or serialized one) from AbstractCookie
protected integer $expire Expiration time from AbstractCookie
protected string $path Path of cookie from AbstractCookie
protected string $domain Domain of cookie from AbstractCookie
protected bool $secure Secure flag from AbstractCookie
protected bool $httponly Httponly flag from AbstractCookie
$max_cookie_size from AbstractCookie

Methods

__construct(string $name, string $key, int $max_cookie_size = null)

Encrypted cookie constructor

from EncryptedCookie
CookieInterface
setName(string $name)

Set cookie name

from AbstractCookie
string
getName()

Get cookie name

from AbstractCookie
CookieInterface
setValue(string $value, bool $serialize = true)

Set value of cookie

from EncryptedCookie
string
getValue(bool $unserialize = true)

Get cookie value

from EncryptedCookie
CookieInterface
setExpire($timestamp)

Set cookie's expiration time

from AbstractCookie
CookieInterface
setPath(string $location)

Set cookie's path

from AbstractCookie
CookieInterface
setDomain(string $domain)

Set cookie's domain

from AbstractCookie
CookieInterface
setSecure(bool $mode = true)

Set if the cookie should be transmitted only via https

from AbstractCookie
CookieInterface
setHttponly($mode = true)

Set if cookie should be available only to HTTP protocol

from AbstractCookie
boolean
save()

Set cookie

from AbstractCookie
CookieInterface
load()

Get cookie

from AbstractCookie
bool
delete()

Delete cookie

from AbstractCookie
bool
exists()

Check if cookie exists

from AbstractCookie
static boolean
erase(string $name)

Static method to quickly delete a cookie

from AbstractCookie
static EncryptedCookie
create($name, $key, array $properties = [], $serialize = true)

Static method to quickly create a cookie

from EncryptedCookie
static EncryptedCookie
retrieve(string $name, string $key)

Static method to quickly get a cookie

from EncryptedCookie
static string
encryptKey(string $key)

Create a client-specific key using provided key, the client remote address and (in case) the value of HTTP_X_FORWARDED_FOR header

Details

in EncryptedCookie at line 44
__construct(string $name, string $key, int $max_cookie_size = null)

Encrypted cookie constructor

Setup cookie name and key

Parameters

string $name
string $key
int $max_cookie_size

Exceptions

CookieException

in AbstractCookie at line 114
CookieInterface setName(string $name)

Set cookie name

Parameters

string $name The cookie name.

Return Value

CookieInterface The invoked object.

Exceptions

CookieException

in AbstractCookie at line 127
string getName()

Get cookie name

Return Value

string Name of cookie

in EncryptedCookie at line 55
CookieInterface setValue(string $value, bool $serialize = true)

Set value of cookie

Parameters

string $value The value of cookie.
bool $serialize If true, cookie will be serialized (default)

Return Value

CookieInterface The invoked object.

Exceptions

CookieException

in EncryptedCookie at line 82
string getValue(bool $unserialize = true)

Get cookie value

Parameters

bool $unserialize If true, cookie will be unserialized (default)

Return Value

string Value of cookie

in AbstractCookie at line 146
CookieInterface setExpire($timestamp)

Set cookie's expiration time

Parameters

$timestamp

Return Value

CookieInterface The invoked object.

Exceptions

CookieException

in AbstractCookie at line 159
CookieInterface setPath(string $location)

Set cookie's path

Parameters

string $location

Return Value

CookieInterface The invoked object.

Exceptions

CookieException

in AbstractCookie at line 172
CookieInterface setDomain(string $domain)

Set cookie's domain

Parameters

string $domain

Return Value

CookieInterface The invoked object.

Exceptions

CookieException

in AbstractCookie at line 185
CookieInterface setSecure(bool $mode = true)

Set if the cookie should be transmitted only via https

Parameters

bool $mode

Return Value

CookieInterface The invoked object.

in AbstractCookie at line 196
CookieInterface setHttponly($mode = true)

Set if cookie should be available only to HTTP protocol

Parameters

$mode

Return Value

CookieInterface The invoked object.

in AbstractCookie at line 207
boolean save()

Set cookie

Return Value

boolean

in AbstractCookie at line 226
CookieInterface load()

Get cookie

Return Value

CookieInterface The invoked object.

in AbstractCookie at line 239
bool delete()

Delete cookie

Return Value

bool

in AbstractCookie at line 260
bool exists()

Check if cookie exists

Return Value

bool

in AbstractCookie at line 275
static boolean erase(string $name)

Static method to quickly delete a cookie

Parameters

string $name The cookie name

Return Value

boolean

Exceptions

CookieException

in EncryptedCookie at line 118
static EncryptedCookie create($name, $key, array $properties = [], $serialize = true)

Static method to quickly create a cookie

Parameters

$name
$key
array $properties
$serialize

Return Value

EncryptedCookie

Exceptions

CookieException

in EncryptedCookie at line 149
static EncryptedCookie retrieve(string $name, string $key)

Static method to quickly get a cookie

Parameters

string $name The cookie name
string $key

Return Value

EncryptedCookie

Exceptions

CookieException

at line 32
static protected string encryptKey(string $key)

Create a client-specific key using provided key, the client remote address and (in case) the value of HTTP_X_FORWARDED_FOR header

Parameters

string $key

Return Value

string