1. interface
  2. Comodojo
  3. \
  4. Cookies
  5. \
  6. CookieInterface

CookieInterface

interface CookieInterface (View source)

Object cookie interface

Constants

COOKIE_MAX_SIZE

Methods

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(integer $time)

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)

Set if the cookie should be transmitted only via https

CookieInterface
setHttponly($mode)

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

Details

at line 41
CookieInterface setName(string $name)

Set cookie name

Parameters

string $name The cookie name.

Return Value

CookieInterface The invoked object.

Exceptions

CookieException

at line 49
string getName()

Get cookie name

Return Value

string Name of cookie

at line 65
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 76
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 88
CookieInterface setExpire(integer $time)

Set cookie's expiration time

Parameters

integer $time

Return Value

CookieInterface The invoked object.

Exceptions

CookieException

at line 100
CookieInterface setPath(string $location)

Set cookie's path

Parameters

string $location

Return Value

CookieInterface The invoked object.

Exceptions

CookieException

at line 112
CookieInterface setDomain(string $domain)

Set cookie's domain

Parameters

string $domain

Return Value

CookieInterface The invoked object.

Exceptions

CookieException

at line 122
CookieInterface setSecure(bool $mode)

Set if the cookie should be transmitted only via https

Parameters

bool $mode

Return Value

CookieInterface The invoked object.

at line 130
CookieInterface setHttponly($mode)

Set if cookie should be available only to HTTP protocol

Parameters

$mode

Return Value

CookieInterface The invoked object.

at line 137
boolean save()

Set cookie

Return Value

boolean

at line 145
CookieInterface load()

Get cookie

Return Value

CookieInterface The invoked object.

at line 152
bool delete()

Delete cookie

Return Value

bool

at line 159
bool exists()

Check if cookie exists

Return Value

bool