class Cookie extends Facade

Constants

protected STATE_CONTEXT_KEY

The context key for the coroutine-local facade roots.

Properties

static protected Container|null $app

The application instance being facaded.

from  Facade
static protected array $resolvedInstance

The resolved object instances.

from  Facade
static protected array<string, true> $scopedAccessors

Accessors whose resolved objects belong to a coroutine scope.

from  Facade
static protected array<string, int> $coroutineAccessors

Accessors with coroutine-local roots, and their current generation.

from  Facade
static protected bool $cached

Indicates if the resolved instance should be cached.

from  Facade

Methods

static void
resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from  Facade
static MockInterface|null
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static CompositeExpectation|Expectation|HigherOrderMessage
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage
expects()

Initiate a mock expectation on the facade.

from  Facade
static MockInterface
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static MockInterface
createMock()

Create a fresh mock instance for the given class.

from  Facade
static bool
isMock()

Determines whether a mock is set as the instance of the facade.

from  Facade
static string|null
getMockableClass()

Get the mockable class for the bound instance.

from  Facade
static void
swap(mixed $instance)

Hotswap the underlying instance behind the facade.

from  Facade
static bool
isFake()

Determines whether a "fake" has been set as the facade instance.

from  Facade
static mixed
getFacadeRoot()

Get the root object behind the facade.

from  Facade
static string
getFacadeAccessor()

Get the registered name of the component.

static mixed
resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

from  Facade
static void
clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

from  Facade
static void
clearResolvedInstances()

Clear all of the resolved instances.

from  Facade
static Collection
defaultAliases()

Get the application default aliases.

from  Facade
static Container|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Container|null $app)

Set the application instance.

from  Facade
static mixed
__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from  Facade
static bool
has(UnitEnum|string $key)

Determine if a cookie exists on the request.

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

Retrieve a cookie from the request.

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

No description

static void
flushMacros()

No description

static CookieJar
flushQueuedCookies()

No description

static void
flushState()

No description

static 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')

No description

static Cookie
forget(UnitEnum|string $name, string|null $path = 'null', string|null $domain = 'null')

No description

static void
array()

<int, \Symfony\Component\HttpFoundation\Cookie> getQueuedCookies()

static bool
hasMacro(string $name)

No description

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

No description

static void
macro(string $name, callable|object $macro)

No description

static 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')

No description

static void
mixin(object $mixin, bool $replace = 'true')

No description

static void
queue(mixed ...$parameters)

No description

void
static()

($default is null ? null|\Symfony\Component\HttpFoundation\Cookie : mixed) queued(\UnitEnum|string $key, mixed $default = 'null', string|null $path = 'null')

static CookieJar
setDefaultPathAndDomain(string $path, string|null $domain, bool|null $secure = 'false', string|null $sameSite = 'null')

No description

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

No description

Details

in Facade at line 85
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.

Parameters

Closure $callback

Return Value

void

in Facade at line 106
static MockInterface|null spy()

Convert the facade into a Mockery spy.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface|null

in Facade at line 125
static MockInterface partialMock()

Initiate a partial mock on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 142
static CompositeExpectation|Expectation|HigherOrderMessage shouldReceive()

Initiate a mock expectation on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|HigherOrderMessage

in Facade at line 159
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage expects()

Initiate a mock expectation on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|ExpectsHigherOrderMessage

in Facade at line 176
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 189
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 199
static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

in Facade at line 210
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 226
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Replaces the worker-wide resolved facade instance and container binding; runtime use races across coroutines and changes every subsequent facade call.

Parameters

mixed $instance

Return Value

void

in Facade at line 239
static bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

in Facade at line 250
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 63
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

in Facade at line 266
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 312
static void clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

Later facade calls everywhere resolve again; only references already held keep the previous instance.

Parameters

string|null $name

Return Value

void

in Facade at line 330
static void clearResolvedInstances()

Clear all of the resolved instances.

Later facade calls everywhere resolve again; only references already held keep the previous instances.

Return Value

void

in Facade at line 344
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 404
static Container|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Container|null

in Facade at line 415
static void setFacadeApplication(Container|null $app)

Set the application instance.

Replaces the worker-wide facade application reference; runtime use races across coroutines and breaks every facade lookup.

Parameters

Container|null $app

Return Value

void

in Facade at line 427
static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException
Throwable

at line 37
static bool has(UnitEnum|string $key)

Determine if a cookie exists on the request.

Parameters

UnitEnum|string $key

Return Value

bool

at line 51
static mixed get(UnitEnum|string|null $key = null, mixed $default = null)

Retrieve a cookie from the request.

Parameters

UnitEnum|string|null $key
mixed $default

Return Value

mixed

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

No description

Parameters

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

Return Value

void

at line 32
static void flushMacros()

No description

Return Value

void

at line 32
static CookieJar flushQueuedCookies()

No description

Return Value

CookieJar

at line 32
static void flushState()

No description

Return Value

void

at line 32
static 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')

No description

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

at line 32
static Cookie forget(UnitEnum|string $name, string|null $path = 'null', string|null $domain = 'null')

No description

Parameters

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

Return Value

Cookie

at line 32
static void array()

<int, \Symfony\Component\HttpFoundation\Cookie> getQueuedCookies()

Return Value

void

at line 32
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 32
static bool hasQueued(UnitEnum|string $key, string|null $path = 'null')

No description

Parameters

UnitEnum|string $key
string|null $path

Return Value

bool

at line 32
static void macro(string $name, callable|object $macro)

No description

Parameters

string $name
callable|object $macro

Return Value

void

at line 32
static 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')

No description

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

at line 32
static void mixin(object $mixin, bool $replace = 'true')

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 32
static void queue(mixed ...$parameters)

No description

Parameters

mixed ...$parameters

Return Value

void

at line 32
void static()

($default is null ? null|\Symfony\Component\HttpFoundation\Cookie : mixed) queued(\UnitEnum|string $key, mixed $default = 'null', string|null $path = 'null')

Return Value

void

at line 32
static CookieJar setDefaultPathAndDomain(string $path, string|null $domain, bool|null $secure = 'false', string|null $sameSite = 'null')

No description

Parameters

string $path
string|null $domain
bool|null $secure
string|null $sameSite

Return Value

CookieJar

at line 32
static void unqueue(UnitEnum|string $name, string|null $path = 'null')

No description

Parameters

UnitEnum|string $name
string|null $path

Return Value

void