Documentation

Swift_DependencyContainer
in package

Application

Dependency Injection container.

TYPE_ALIAS

Constant for aliases


    public
    mixed
    TYPE_ALIAS
    = 0x1000

TYPE_ARRAY

Constant for arrays


    public
    mixed
    TYPE_ARRAY
    = 0x10000

TYPE_INSTANCE

Constant for new instance types


    public
    mixed
    TYPE_INSTANCE
    = 0x10

TYPE_SHARED

Constant for shared instance types


    public
    mixed
    TYPE_SHARED
    = 0x100

TYPE_VALUE

Constant for literal value types


    public
    mixed
    TYPE_VALUE
    = 0x1

$endPoint

The current endpoint in the data container


    private
        mixed
    $endPoint

$instance

Singleton instance


    private
    static    mixed
    $instance
     = 
ull

$store

The data container


    private
        mixed
    $store
     = []

__construct()

Constructor should not be used.


    public
                __construct() : mixed

Use instead.

Return values

mixed —

addConstructorLookup()

Specify a dependency lookup for the constructor of the previously registered item.


    public
                addConstructorLookup(string $lookup) : $this

Parameters

$lookup : string

Return values

$this —

addConstructorValue()

Specify a literal (non looked up) value for the constructor of the previously registered item.


    public
                addConstructorValue(mixed $value) : $this

Parameters

$value : mixed

Return values

$this —

asAliasOf()

Specify the previously registered item as an alias of another item.


    public
                asAliasOf(string $lookup) : $this

Parameters

$lookup : string

Return values

$this —

asArray()

Specify the previously registered item as array of dependencies.


    public
                asArray() : $this

must be called before this will work.

Return values

$this —

asNewInstanceOf()

Specify the previously registered item as a new instance of $className.


    public
                asNewInstanceOf(string $className) : $this

must be called before this will work. Any arguments can be set with , or .

Parameters

$className : string

Return values

$this —

asSharedInstanceOf()

Specify the previously registered item as a shared instance of $className.


    public
                asSharedInstanceOf(string $className) : $this

must be called before this will work.

Parameters

$className : string

Return values

$this —

asValue()

Specify the previously registered item as a literal value.


    public
                asValue(mixed $value) : $this

must be called before this will work.

Parameters

$value : mixed

Return values

$this —

createDependenciesFor()

Create an array of arguments passed to the constructor of $itemName.


    public
                createDependenciesFor(string $itemName) : array<string|int, mixed>

Parameters

$itemName : string

Return values

array<string|int, mixed> —

getInstance()

Returns a singleton of the DependencyContainer.


    public
            static    getInstance() : self

Return values

self —

has()

Test if an item is registered in this container with the given name.


    public
                has(string $itemName) : bool

Parameters

$itemName : string

Return values

bool —

listItems()

List the names of all items stored in the Container.


    public
                listItems() : array<string|int, mixed>

Return values

array<string|int, mixed> —

lookup()

Lookup the item with the given $itemName.


    public
                lookup(string $itemName) : mixed

Parameters

$itemName : string

Return values

mixed —

register()


    public
                register(string $itemName) : $this

This method returns the current DependencyContainer instance because it requires the use of the fluid interface to set the specific details for the dependency.

Parameters

$itemName : string

Return values

$this —

withDependencies()

Specify a list of injected dependencies for the previously registered item.


    public
                withDependencies(array<string|int, mixed> $lookups) : $this

This method takes an array of lookup names.

Parameters

$lookups : array<string|int, mixed>

Return values

$this —

createAlias()

Resolve an alias to another item


    private
                createAlias(mixed $itemName) : mixed

Parameters

$itemName : mixed

Return values

mixed —

createNewInstance()

Create a fresh instance of $itemName


    private
                createNewInstance(mixed $itemName) : mixed

Parameters

$itemName : mixed

Return values

mixed —

createSharedInstance()

Create and register a shared instance of $itemName


    private
                createSharedInstance(mixed $itemName) : mixed

Parameters

$itemName : mixed

Return values

mixed —

getEndPoint()

Get the current endpoint in the store


    private
                getEndPoint() : mixed

Return values

mixed —

getValue()

Get the literal value with $itemName


    private
                getValue(mixed $itemName) : mixed

Parameters

$itemName : mixed

Return values

mixed —

lookupRecursive()

Resolve a single dependency with an collections


    private
                lookupRecursive(mixed $item) : mixed

Parameters

$item : mixed

Return values

mixed —

resolveArgs()

Get an argument list with dependencies resolved


    private
                resolveArgs(array<string|int, mixed> $args) : mixed

Parameters

$args : array<string|int, mixed>

Return values

mixed —