UserFrosting API

Config extends Facade

Implements facade for the "config" service.

Adapted from the Laravel Facade class: https://github.com/laravel/framework/blob/5.3/src/Illuminate/Support/Facades/Facade.php

Tags
author

Alex Weissman (https://alexanderweissman.com)

Table of Contents

$container The Pimple container being facaded. ContainerInterface
$resolvedInstance The resolved object instances. array
getFacadeAccessor() Get the registered name of the component. string
swap() Hotswap the underlying service instance behind the facade. mixed
shouldReceive() Initiate a mock expectation on the facade. Expectation
createFreshMockInstance() Create a fresh mock instance for the given class. Expectation
createMockByName() Create a fresh mock instance for the given class. Expectation
isMock() Determines whether a mock is set as the instance of the facade. bool
getMockableClass() Get the mockable class for the bound instance. string|null
getFacadeRoot() Get the root object behind the facade. mixed
getFacadeAccessor() Get the registered name of the component. mixed
resolveFacadeInstance() Resolve the facade root instance from the container. mixed
clearResolvedInstance() Clear a resolved facade instance. mixed
clearResolvedInstances() Clear all of the resolved instances. mixed
getFacadeContainer() Get the container instance behind the facade. ContainerInterface
setFacadeContainer() Set the container instance. mixed
__callStatic() Handle dynamic, static calls to the object. mixed

Properties

$container

The Pimple container being facaded.

protected static ContainerInterface $container

$resolvedInstance

The resolved object instances.

protected static array $resolvedInstance

Methods

getFacadeAccessor()

Get the registered name of the component.

protected static getFacadeAccessor( ) : string
Return values
string

swap()

Hotswap the underlying service instance behind the facade.

public static swap( $instance : mixed ) : mixed
Parameters
$instance : mixed
Return values
mixed

shouldReceive()

Initiate a mock expectation on the facade.

public static shouldReceive( ) : Expectation
Return values
Expectation

createFreshMockInstance()

Create a fresh mock instance for the given class.

protected static createFreshMockInstance( $name : string ) : Expectation
Parameters
$name : string
Return values
Expectation

createMockByName()

Create a fresh mock instance for the given class.

protected static createMockByName( $name : string ) : Expectation
Parameters
$name : string
Return values
Expectation

isMock()

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

protected static isMock( ) : bool
Return values
bool

getMockableClass()

Get the mockable class for the bound instance.

protected static getMockableClass( ) : string|null
Return values
string|null

getFacadeRoot()

Get the root object behind the facade.

public static getFacadeRoot( ) : mixed
Return values
mixed

getFacadeAccessor()

Get the registered name of the component.

protected static getFacadeAccessor( ) : mixed
Tags
throws
RuntimeException
Return values
mixed

resolveFacadeInstance()

Resolve the facade root instance from the container.

protected static resolveFacadeInstance( $name : string|object ) : mixed
Parameters
$name : string|object
Return values
mixed

clearResolvedInstance()

Clear a resolved facade instance.

public static clearResolvedInstance( $name : string ) : mixed
Parameters
$name : string
Return values
mixed

clearResolvedInstances()

Clear all of the resolved instances.

public static clearResolvedInstances( ) : mixed
Return values
mixed

getFacadeContainer()

Get the container instance behind the facade.

public static getFacadeContainer( ) : ContainerInterface
Return values
ContainerInterface

setFacadeContainer()

Set the container instance.

public static setFacadeContainer( $container : ContainerInterface ) : mixed
Parameters
$container : ContainerInterface
Return values
mixed

__callStatic()

Handle dynamic, static calls to the object.

public static __callStatic( $method : string , $args : array ) : mixed
Parameters
$method : string
$args : array
Tags
throws
RuntimeException
Return values
mixed

Search results