API Documentation
Back to top  

The injector class deals with dependency management as well as object creation and function context invocation.

api
package Default

 Methods

Create an instance of an injector with an optional parent.

__construct(\DI\Injector $parent = null) 

Provide a parent injector when you wish to optionally override some dependencies but not others

Parameters

$parent

\DI\Injector

The parent injector to optionally retrieve dependencies from

Annotate a function so that it is dependency injected.

annotate(callable $callable) : \DI\A

Parameters

$callable

callable

The function to annotate.

Returns

\DI\Ano-argument function that invokes the specified function with all of its' parameters dependency injected.

Bind a specified class identifier to a specified instance in the injector.

bind(string $id, object $instance) : object

Parameters

$id

string

Class identifier. This must be the fully qualified class name.

$instance

object

The instance to bind to the specified class identifier.

Returns

objectThe requested instance.

Retrieve an instance from the injector.

get(string $id) : object

Parameters

$id

string

Class identifier. This must be the fully qualified class name.

Exceptions

\DI\Interop\Container\Exception\NotFoundException if the class identifier was not found.

Returns

objectThe requested instance.

Check for the existence of an instance from the injector.

has(string $id) : boolean

Parameters

$id

string

Class identifier. This must be the fully qualified class name.

Returns

booleanTrue if the instance exists, otherwise false.

Create an instance of a class with its' constructor dependency injected. Always creates a new instance.

instantiate(string $id) : object

Use Injector->get() if you want to retrieve the same instance each time.

Parameters

$id

string

Class identifier. This must be the fully qualified class name.

Returns

objectThe instance of your class, dependency injected via its' constructor.