Block
extends Facade
in package
Facade base class Adds the ability to define a fallback instance.
Tags
Table of Contents
- $app : Application
- The application instance being facaded.
- $resolvedInstance : array<string|int, mixed>
- The resolved object instances.
- __callStatic() : mixed
- Handle dynamic, static calls to the object.
- append() :
- clearResolvedInstance() : void
- Clear a resolved facade instance.
- clearResolvedInstances() : void
- Clear all of the resolved instances.
- endBlock() :
- endPut() :
- get() :
- getFacadeApplication() : Application
- Get the application instance behind the facade.
- getFacadeRoot() : mixed
- Get the root object behind the facade.
- placeholder() :
- put() :
- reset() :
- set() :
- setFacadeApplication() : void
- Set the application instance.
- shouldReceive() : Expectation
- Initiate a mock expectation on the facade.
- spy() : void
- Convert the facade into a Mockery spy.
- startBlock() :
- swap() : void
- Hotswap the underlying instance behind the facade.
- createFreshMockInstance() : Expectation
- Create a fresh mock instance for the given class.
- createMock() : MockInterface
- Create a fresh mock instance for the given class.
- getFacadeAccessor() : string
- Get the registered name of the component.
- getFacadeInstance() : mixed
- If the accessor is not found via getFacadeAccessor, use this instance as a fallback.
- getMockableClass() : string|null
- Get the mockable class for the bound instance.
- isMock() : bool
- Determines whether a mock is set as the instance of the facade.
- resolveFacadeInstance() : mixed
- Resolve the facade root instance from the container.
Properties
$app
The application instance being facaded.
protected
static Application
$app
$resolvedInstance
The resolved object instances.
protected
static array<string|int, mixed>
$resolvedInstance
Methods
__callStatic()
Handle dynamic, static calls to the object.
public
static __callStatic(string $method, array<string|int, mixed> $args) : mixed
Parameters
- $method : string
- $args : array<string|int, mixed>
Tags
Return values
mixed —append()
public
static append(string $name, string $content) :
Parameters
- $name : string
- $content : string
Return values
—clearResolvedInstance()
Clear a resolved facade instance.
public
static clearResolvedInstance(string $name) : void
Parameters
- $name : string
Return values
void —clearResolvedInstances()
Clear all of the resolved instances.
public
static clearResolvedInstances() : void
Return values
void —endBlock()
public
static endBlock(bool $append = false) :
Parameters
- $append = false : bool
Return values
—endPut()
public
static endPut(bool $append = false) :
Parameters
- $append = false : bool
Return values
—get()
public
static get(string $name, string $default = null) :
Parameters
- $name : string
- $default = null : string
Return values
—getFacadeApplication()
Get the application instance behind the facade.
public
static getFacadeApplication() : Application
Return values
Application —getFacadeRoot()
Get the root object behind the facade.
public
static getFacadeRoot() : mixed
Return values
mixed —placeholder()
public
static placeholder(string $name, string $default = null) :
Parameters
- $name : string
- $default = null : string
Return values
—put()
public
static put(string $name) :
Parameters
- $name : string
Return values
—reset()
public
static reset() :
Return values
—set()
public
static set(string $name, string $content) :
Parameters
- $name : string
- $content : string
Return values
—setFacadeApplication()
Set the application instance.
public
static setFacadeApplication(Application $app) : void
Parameters
- $app : Application
Return values
void —shouldReceive()
Initiate a mock expectation on the facade.
public
static shouldReceive() : Expectation
Return values
Expectation —spy()
Convert the facade into a Mockery spy.
public
static spy() : void
Return values
void —startBlock()
public
static startBlock(string $name) :
Parameters
- $name : string
Return values
—swap()
Hotswap the underlying instance behind the facade.
public
static swap(mixed $instance) : void
Parameters
- $instance : mixed
Return values
void —createFreshMockInstance()
Create a fresh mock instance for the given class.
protected
static createFreshMockInstance() : Expectation
Return values
Expectation —createMock()
Create a fresh mock instance for the given class.
protected
static createMock() : MockInterface
Return values
MockInterface —getFacadeAccessor()
Get the registered name of the component.
protected
static getFacadeAccessor() : string
Return values
string —getFacadeInstance()
If the accessor is not found via getFacadeAccessor, use this instance as a fallback.
protected
static getFacadeInstance() : mixed
Return values
mixed —getMockableClass()
Get the mockable class for the bound instance.
protected
static getMockableClass() : string|null
Return values
string|null —isMock()
Determines whether a mock is set as the instance of the facade.
protected
static isMock() : bool
Return values
bool —resolveFacadeInstance()
Resolve the facade root instance from the container.
protected
static resolveFacadeInstance(string|object $name) : mixed
Parameters
- $name : string|object