Interface Salient\Contract\Container\ContainerInterface

`extends`	`ContainerInterface, Chainable, Instantiable, Unloadable`

A service container with contextual bindings

If a service resolves to a new instance of a class that implements ContainerAwareInterface, the container is passed to its {@see ContainerAwareInterface::setContainer()} method.

Then, if the resolved instance implements {@see ServiceAwareInterface}, its {@see ServiceAwareInterface::setService()} method is called.

A service provider registered via {@see provider()} or {@see providers()} may also implement any combination of the following interfaces:

{@see SingletonInterface} to be instantiated once per container
{@see HasServices} to specify which of its interfaces are services to register with the container
{@see HasBindings} to bind additional services to the container
{@see HasContextualBindings} to bind services to the container that only apply in the context of the provider

{@see SingletonInterface} is ignored if a lifetime other than {@see ServiceLifetime::INHERIT} is given when the service provider is registered.

Salient\Contract\Container\ContainerInterface extends ContainerInterface, Chainable, Instantiable, Unloadable
- Salient\Container\Container implements ContainerInterface, FacadeAwareInterface<FacadeInterface<self>> uses UnloadsFacades, HasChainableMethods
  - Salient\Container\Application implements ApplicationInterface
    - Salient\Cli\CliApplication implements CliApplicationInterface
- Salient\Contract\Container\ApplicationInterface extends ContainerInterface
  - Salient\Container\Application implements ApplicationInterface
    - Salient\Cli\CliApplication implements CliApplicationInterface
  - Salient\Contract\Cli\CliApplicationInterface extends ApplicationInterface
    - Salient\Cli\CliApplication implements CliApplicationInterface

Located at Toolkit/Contract/Container/ContainerInterface.php

Methods


					
	public

__construct()

Creates a new service container


					
	public
					static

hasGlobalContainer(): bool

Check if the global container is set

Implemented by

Salient\Container\Container::hasGlobalContainer()


					
	public
					static

getGlobalContainer(): ContainerInterface

Get the global container, creating it if necessary

Implemented by

Salient\Container\Container::getGlobalContainer()


					
	public
					static

setGlobalContainer(?ContainerInterface $container): void

Set or unset the global container

Implemented by

Salient\Container\Container::setGlobalContainer()


					
	public

inContextOf(class-string $id): static

Apply the contextual bindings of a service to a copy of the container

Implemented by

Salient\Container\Container::inContextOf()


					
	public

get<T>(class-string<T> $id, mixed[] $args = []): T&object

Resolve a service from the container

Values in $args are matched with service dependencies using one or more of the following strategies:

match objects to parameters by hinted type
match other values to parameters by name
match remaining values by type, then position

Throws

Salient\Contract\Container\ArgumentsNotUsedExceptionInterface

if $args are given and $id resolves to a shared instance.


					
	public

getAs<T, TService>(class-string<T> $id, class-string<TService> $service, mixed[] $args = []): T&TService&object

Resolve a partially-resolved service from the container

This method resolves $id normally but passes $service to {@see ServiceAwareInterface::setService()} instead of $id.

Throws

Salient\Contract\Container\ArgumentsNotUsedExceptionInterface

if $args are given and $id resolves to a shared instance.

Implemented by

Salient\Container\Container::getAs()


					
	public

getName<T>(class-string<T> $id): class-string<T>

Resolve a service to a concrete class name

Implemented by

Salient\Container\Container::getName()


					
	public

has(class-string $id): bool

Check if a service is bound to the container


					
	public

hasSingleton(class-string $id): bool

Check if a shared service is bound to the container

Implemented by

Salient\Container\Container::hasSingleton()


					
	public

hasInstance(class-string $id): bool

Check if a service resolves to a shared instance

Implemented by

Salient\Container\Container::hasInstance()


					
	public

hasProvider(class-string $id): bool

Check if a service provider is registered with the container

Implemented by

Salient\Container\Container::hasProvider()


					
	public

bind<TService, T is TService>(class-string<TService> $id, class-string<T>|null $class = null, mixed[] $args = []): $this

Bind a service to the container

Subsequent requests for $id resolve to $class.

If $class is null, $id resolves to itself.

$args are merged with $args passed to {@see get()} or {@see getAs()} when $id resolves to a new instance of $class.

Implemented by

Salient\Container\Container::bind()


					
	public

bindIf<TService, T is TService>(
	class-string<TService> $id,
	class-string<T>|null $class = null,
	mixed[] $args = [],
): $this

Bind a service to the container if it isn't already bound

Implemented by

Salient\Container\Container::bindIf()


					
	public

singleton<TService, T is TService>(
	class-string<TService> $id,
	class-string<T>|null $class = null,
	mixed[] $args = [],
): $this

Bind a shared service to the container

Subsequent requests for $id resolve to the instance of $class created when $id is first requested.

Implemented by

Salient\Container\Container::singleton()


					
	public

singletonIf<TService, T is TService>(
	class-string<TService> $id,
	class-string<T>|null $class = null,
	mixed[] $args = [],
): $this

Bind a shared service to the container if it isn't already bound

Implemented by

Salient\Container\Container::singletonIf()


					
	public

instance<TService, T is TService>(class-string<TService> $id, T&object $instance): $this

Bind a shared instance to the container

Implemented by

Salient\Container\Container::instance()


					
	public

addContextualBinding<TValue>(
	class-string[]|class-string $context,
	class-string<TValue>|string $dependency,
	(callable(ContainerInterface): TValue)|class-string<TValue>|TValue $value,
): $this

Subsequent requests from $context for $dependency resolve to $value.

If $dependency starts with '$', it is matched with dependencies of $context by constructor parameter name, otherwise it is matched by type.

If $value is a callback, its return value is used.

Implemented by

Salient\Container\Container::addContextualBinding()


					
	public

provider(
	class-string $id,
	class-string[]|null $services = null,
	class-string[] $exceptServices = [],
	ServiceLifetime::* $lifetime = ServiceLifetime::INHERIT,
): $this

For performance reasons, classes bound to the container with {@see bind()} or {@see singleton()} are not loaded until they are resolved. Classes registered with {@see provider()} are loaded immediately, but are not instantiated until they are resolved.

Parameters

`$services`	Services to bind, or `null` to include all services.
`$exceptServices`	Services to ignore.

Implemented by

Salient\Container\Container::provider()


					
	public

providers(array<class-string, class-string> $serviceMap, ServiceLifetime::* $lifetime = ServiceLifetime::INHERIT): $this

A service map is an array with entries that map a service (usually an interface) to a service provider (a class that extends or implements the service).

Multiple services may be mapped to the same service provider, and service providers may be mapped to themselves. For example, to make BarClass discoverable via {@see ContainerInterface::getProviders()} whether it's bound to a service or not:

<?php
$container->providers([
    FooInterface::class => Env::get('foo_provider'),
    BarClass::class => BarClass::class,
]);

Implemented by

Salient\Container\Container::providers()


					
	public

getProviders(): array<class-string>

Get a list of service providers registered with the container

Implemented by

Salient\Container\Container::getProviders()


					
	public

unbind(class-string $id): $this

Remove a binding from the container

Implemented by

Salient\Container\Container::unbind()


					
	public

removeInstance(class-string $id): $this

Remove a shared instance from the container

Implemented by

Salient\Container\Container::removeInstance()

Methods inherited from Salient\Contract\Core\Chainable
`apply(), if(), withEach()`

Methods inherited from Salient\Contract\Core\Unloadable
`unload()`

Namespaces

Interfaces

Interface Salient\Contract\Container\ContainerInterface

Implemented by

Implemented by

Implemented by

Implemented by

Throws

Throws

Implemented by

Implemented by

Implemented by

Implemented by

Implemented by

Implemented by

Implemented by

Implemented by

Implemented by

Implemented by

Implemented by

Parameters

Implemented by

Implemented by

Implemented by

Implemented by

Implemented by