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

AbstractCookie

abstract class AbstractCookie implements CookieInterface (View source)

Base class, to be estended implementing a CookieInterface

Properties

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

Methods

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

Default cookie's constructor

CookieInterface
setName(string $name)

Set cookie name

string
getName()

Get cookie name

CookieInterface
setValue(string $value, bool $serialize)

Set value of cookie

string
getValue(bool $unserialize)

Get cookie value

CookieInterface
setExpire($timestamp)

Set cookie's expiration time

CookieInterface
setPath(string $location)

Set cookie's path

CookieInterface
setDomain(string $domain)

Set cookie's domain

CookieInterface
setSecure(bool $mode = true)

Set if the cookie should be transmitted only via https

CookieInterface
setHttponly($mode = true)

Set if cookie should be available only to HTTP protocol

boolean
save()

Set cookie

CookieInterface
load()

Get cookie

bool
delete()

Delete cookie

bool
exists()

Check if cookie exists

static boolean
erase(string $name)

Static method to quickly delete a cookie

Details

at line 91
__construct(string $name, int $max_cookie_size = null)

Default cookie's constructor

Parameters

string $name
int $max_cookie_size

Exceptions

CookieException

at line 114
CookieInterface setName(string $name)

Set cookie name

Parameters

string $name The cookie name.

Return Value

CookieInterface The invoked object.

Exceptions

CookieException

at line 127
string getName()

Get cookie name

Return Value

string Name of cookie

at line 136
abstract CookieInterface setValue(string $value, bool $serialize)

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

at line 141
abstract string getValue(bool $unserialize)

Get cookie value

Parameters

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

Return Value

string Value of cookie

at line 146
CookieInterface setExpire($timestamp)

Set cookie's expiration time

Parameters

$timestamp

Return Value

CookieInterface The invoked object.

Exceptions

CookieException

at line 159
CookieInterface setPath(string $location)

Set cookie's path

Parameters

string $location

Return Value

CookieInterface The invoked object.

Exceptions

CookieException

at line 172
CookieInterface setDomain(string $domain)

Set cookie's domain

Parameters

string $domain

Return Value

CookieInterface The invoked object.

Exceptions

CookieException

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.

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.

at line 207
boolean save()

Set cookie

Return Value

boolean

at line 226
CookieInterface load()

Get cookie

Return Value

CookieInterface The invoked object.

at line 239
bool delete()

Delete cookie

Return Value

bool

at line 260
bool exists()

Check if cookie exists

Return Value

bool

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