1. interface
  2. Hypervel
  3. \
  4. Contracts
  5. \
  6. Cookie
  7. \
  8. QueueingFactory

QueueingFactory

interface QueueingFactory implements Factory

Methods

Cookie
make(UnitEnum|string $name, string|null $value, int $minutes = 0, string|null $path = null, string|null $domain = null, bool|null $secure = null, bool $httpOnly = true, bool $raw = false, string|null $sameSite = null)

Create a new cookie instance.

from  Factory
Cookie
forever(UnitEnum|string $name, string $value, string|null $path = null, string|null $domain = null, bool|null $secure = null, bool $httpOnly = true, bool $raw = false, string|null $sameSite = null)

Create a cookie that lasts "forever" (400 days).

from  Factory
Cookie
forget(UnitEnum|string $name, string|null $path = null, string|null $domain = null)

Expire the given cookie.

from  Factory
bool
has(UnitEnum|string $key)

Determine if a cookie exists in the current request.

string|array|null
get(UnitEnum|string $key, string|array|null $default = null)

Get a cookie value from the current request.

void
queue(mixed ...$parameters)

Queue a cookie to send with the next response.

void
expire(UnitEnum|string $name, string|null $path = null, string|null $domain = null)

Queue a cookie to expire with the next response.

bool
hasQueued(UnitEnum|string $key, string|null $path = null)

Determine if a cookie has been queued.

void
unqueue(UnitEnum|string $name, string|null $path = null)

Remove a cookie from the queue.

array
getQueuedCookies()

Get the cookies which have been queued for the next request.

Details

in Factory at line 15
Cookie make(UnitEnum|string $name, string|null $value, int $minutes = 0, string|null $path = null, string|null $domain = null, bool|null $secure = null, bool $httpOnly = true, bool $raw = false, string|null $sameSite = null)

Create a new cookie instance.

Parameters

UnitEnum|string $name
string|null $value
int $minutes
string|null $path
string|null $domain
bool|null $secure
bool $httpOnly
bool $raw
string|null $sameSite

Return Value

Cookie

in Factory at line 20
Cookie forever(UnitEnum|string $name, string $value, string|null $path = null, string|null $domain = null, bool|null $secure = null, bool $httpOnly = true, bool $raw = false, string|null $sameSite = null)

Create a cookie that lasts "forever" (400 days).

Parameters

UnitEnum|string $name
string $value
string|null $path
string|null $domain
bool|null $secure
bool $httpOnly
bool $raw
string|null $sameSite

Return Value

Cookie

in Factory at line 25
Cookie forget(UnitEnum|string $name, string|null $path = null, string|null $domain = null)

Expire the given cookie.

Parameters

UnitEnum|string $name
string|null $path
string|null $domain

Return Value

Cookie

at line 15
bool has(UnitEnum|string $key)

Determine if a cookie exists in the current request.

Parameters

UnitEnum|string $key

Return Value

bool

at line 20
string|array|null get(UnitEnum|string $key, string|array|null $default = null)

Get a cookie value from the current request.

Parameters

UnitEnum|string $key
string|array|null $default

Return Value

string|array|null

at line 25
void queue(mixed ...$parameters)

Queue a cookie to send with the next response.

Parameters

mixed ...$parameters

Return Value

void

at line 30
void expire(UnitEnum|string $name, string|null $path = null, string|null $domain = null)

Queue a cookie to expire with the next response.

Parameters

UnitEnum|string $name
string|null $path
string|null $domain

Return Value

void

at line 35
bool hasQueued(UnitEnum|string $key, string|null $path = null)

Determine if a cookie has been queued.

Parameters

UnitEnum|string $key
string|null $path

Return Value

bool

at line 40
void unqueue(UnitEnum|string $name, string|null $path = null)

Remove a cookie from the queue.

Parameters

UnitEnum|string $name
string|null $path

Return Value

void

at line 47
array getQueuedCookies()

Get the cookies which have been queued for the next request.

Return Value

array