---
title: "Phalcon Di"
version: "5.20"
---
> Documentation Index
> Fetch the complete documentation index at: https://docs.phalcon.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Phalcon Di
:::info[NOTE]
All classes are prefixed with `Phalcon`
:::
## Di\AbstractInjectionAware
Abstract
This abstract class offers common access to the DI in a class
- `\stdClass`
- **`Phalcon\Di\AbstractInjectionAware`** - implements [`Phalcon\Di\InjectionAwareInterface`](#diinjectionawareinterface)
- [`Phalcon\Assets\Manager`](/5.20/api/phalcon_assets/#assetsmanager)
- [`Phalcon\Cli\Router`](/5.20/api/phalcon_cli/#clirouter)
- [`Phalcon\Dispatcher\AbstractDispatcher`](/5.20/api/phalcon_dispatcher/#dispatcherabstractdispatcher)
- [`Phalcon\Encryption\Security`](/5.20/api/phalcon_encryption/#encryptionsecurity)
- [`Phalcon\Flash\AbstractFlash`](/5.20/api/phalcon_flash/#flashabstractflash)
- [`Phalcon\Http\Cookie`](/5.20/api/phalcon_http/#httpcookie)
- [`Phalcon\Http\Request`](/5.20/api/phalcon_http/#httprequest)
- [`Phalcon\Http\Response\Cookies`](/5.20/api/phalcon_http/#httpresponsecookies)
- [`Phalcon\Mvc\Model`](/5.20/api/phalcon_mvc/#mvcmodel)
- [`Phalcon\Mvc\Router`](/5.20/api/phalcon_mvc/#mvcrouter)
- [`Phalcon\Mvc\Url`](/5.20/api/phalcon_mvc/#mvcurl)
- [`Phalcon\Session\Manager`](/5.20/api/phalcon_session/#sessionmanager)
`stdClass`
### Method Summary
Returns the internal dependency injector
Sets the dependency injector
### Properties
Dependency Injector
### Methods
getDI()
```php
public function getDI(): DiInterface;
```
Returns the internal dependency injector
setDI()
```php
public function setDI( DiInterface $container ): void;
```
Sets the dependency injector
## Di\Di
Class
Phalcon\Di\Di is a component that implements Dependency Injection/Service
Location of services and it's itself a container for them.
Since Phalcon is highly decoupled, Phalcon\Di\Di is essential to integrate the
different components of the framework. The developer can also use this
component to inject dependencies and manage global instances of the different
classes used in the application.
Basically, this component implements the `Inversion of Control` pattern.
Applying this, the objects do not receive their dependencies using setters or
constructors, but requesting a service dependency injector. This reduces the
overall complexity, since there is only one way to get the required
dependencies within a component.
Additionally, this pattern increases testability in the code, thus making it
less prone to errors.
```php
use Phalcon\Di\Di;
use Phalcon\Http\Request;
$di = new Di();
// Using a string definition
$di->set("request", Request::class, true);
// Using an anonymous function
$di->setShared(
"request",
function () {
return new Request();
}
);
$request = $di->getRequest();
```
- **`Phalcon\Di\Di`** - implements [`Phalcon\Di\DiInterface`](#didiinterface)
- [`Phalcon\Di\FactoryDefault`](#difactorydefault)
`Phalcon\Config\Adapter\Php` · `Phalcon\Config\Adapter\Yaml` · `Phalcon\Config\ConfigInterface` · `Phalcon\Di\DiInterface` · `Phalcon\Di\Exception` · `Phalcon\Di\Exception\ServiceResolutionException` · `Phalcon\Di\Exceptions\AliasAlreadyInUse` · `Phalcon\Di\Exceptions\AliasNameMustBeString` · `Phalcon\Di\Exceptions\CircularAliasReference` · `Phalcon\Di\Exceptions\ServiceCannotBeResolved` · `Phalcon\Di\InitializationAwareInterface` · `Phalcon\Di\InjectionAwareInterface` · `Phalcon\Di\Service` · `Phalcon\Di\ServiceInterface` · `Phalcon\Di\ServiceProviderInterface` · `Phalcon\Events\ManagerInterface`
### Method Summary
Magic method to get or set services using setters/getters
Phalcon\Di\Di constructor
Attempts to register a service in the services container
Resolves the service based on its configuration
Return the alias based on a passed key. Returns an empty string if
Return the latest DI created
Returns the internal event manager
Returns a service definition without resolving
Returns a Phalcon\Di\Service instance
Return the services registered in the DI
Resolves a service, the resolved service is stored in the DI, subsequent
Check whether the DI contains a service by a name
Check whether the DI has a cached shared instance for a service name.
Loads services from a php config file.
Loads services from a yaml file.
Check if a service is registered using the array syntax
Allows to obtain a shared service using the array syntax
Allows to register a shared service using the array syntax
Removes a service from the services container using the array syntax
Registers a service provider.
Removes a service in the services container
Removes the cached shared instance for a service, leaving the service
Resets the internal default DI
Registers a service in the services container
Sets one or more aliases to the given name.
Set a default dependency injection container to be obtained into static
Sets the internal event manager
Sets a service using a raw Phalcon\Di\Service definition
Registers an "always shared" service in the services container
Loads services from a Config object.
### Properties
List of service aliases
Latest DI build
Events Manager
List of registered services
List of shared instances
### Methods
__call()
```php
public function __call(
string $method,
array $arguments = []
): mixed|null;
```
Magic method to get or set services using setters/getters
__construct()
```php
public function __construct();
```
Phalcon\Di\Di constructor
attempt()
```php
public function attempt(
string $name,
mixed $definition,
bool $shared = false
): ServiceInterface|bool;
```
Attempts to register a service in the services container
Only is successful if a service hasn't been registered previously
with the same name
get()
```php
public function get(
string $name,
mixed $parameters = null
): mixed;
```
Resolves the service based on its configuration
getAlias()
```php
public function getAlias( string $name ): string;
```
Return the alias based on a passed key. Returns an empty string if
the alias does not exist
getDefault()
```php
public static function getDefault(): DiInterface|null;
```
Return the latest DI created
getInternalEventsManager()
```php
public function getInternalEventsManager(): ManagerInterface|null;
```
Returns the internal event manager
getRaw()
```php
public function getRaw( string $name ): mixed;
```
Returns a service definition without resolving
getService()
```php
public function getService( string $name ): ServiceInterface;
```
Returns a Phalcon\Di\Service instance
getServices()
```php
public function getServices(): ServiceInterface[];
```
Return the services registered in the DI
getShared()
```php
public function getShared(
string $name,
mixed $parameters = null
): mixed;
```
Resolves a service, the resolved service is stored in the DI, subsequent
requests for this service will return the same instance
has()
```php
public function has( string $name ): bool;
```
Check whether the DI contains a service by a name
hasShared()
```php
public function hasShared( string $name ): bool;
```
Check whether the DI has a cached shared instance for a service name.
Unlike `has()`, which reports on the service *definition* registry,
this method reports only on the resolved-instance cache populated by
`getShared()`.
loadFromPhp()
```php
public function loadFromPhp( string $filePath ): void;
```
Loads services from a php config file.
```php
$di->loadFromPhp("path/services.php");
```
And the services can be specified in the file as:
```php
return [
'myComponent' => [
'className' => '\Acme\Components\MyComponent',
'shared' => true,
],
'group' => [
'className' => '\Acme\Group',
'arguments' => [
[
'type' => 'service',
'service' => 'myComponent',
],
],
],
'user' => [
'className' => '\Acme\User',
],
];
```
@link https://docs.phalcon.io/latest/di/
loadFromYaml()
```php
public function loadFromYaml(
string $filePath,
array|null $callbacks = null
): void;
```
Loads services from a yaml file.
```php
$di->loadFromYaml(
"path/services.yaml",
[
"!approot" => function ($value) {
return dirname(__DIR__) . $value;
}
]
);
```
And the services can be specified in the file as:
```php
myComponent:
className: \Acme\Components\MyComponent
shared: true
group:
className: \Acme\Group
arguments:
- type: service
name: myComponent
user:
className: \Acme\User
```
@link https://docs.phalcon.io/latest/di/
offsetExists()
```php
public function offsetExists( mixed $name ): bool;
```
Check if a service is registered using the array syntax
offsetGet()
```php
public function offsetGet( mixed $name ): mixed;
```
Allows to obtain a shared service using the array syntax
```php
var_dump($di["request"]);
```
offsetSet()
```php
public function offsetSet(
mixed $offset,
mixed $value
): void;
```
Allows to register a shared service using the array syntax
```php
$di["request"] = new \Phalcon\Http\Request();
```
offsetUnset()
```php
public function offsetUnset( mixed $name ): void;
```
Removes a service from the services container using the array syntax
register()
```php
public function register( ServiceProviderInterface $provider ): void;
```
Registers a service provider.
```php
use Phalcon\Di\DiInterface;
use Phalcon\Di\ServiceProviderInterface;
class SomeServiceProvider implements ServiceProviderInterface
{
public function register(DiInterface $di)
{
$di->setShared(
'service',
function () {
// ...
}
);
}
}
```
remove()
```php
public function remove( string $name ): void;
```
Removes a service in the services container
It also removes any shared instance created for the service
removeShared()
```php
public function removeShared( string $name ): void;
```
Removes the cached shared instance for a service, leaving the service
definition intact so the next `getShared()` call rebuilds it.
reset()
```php
public static function reset(): void;
```
Resets the internal default DI
set()
```php
public function set(
string $name,
mixed $definition,
bool $shared = false
): ServiceInterface;
```
Registers a service in the services container
setAlias()
```php
public function setAlias(
string $name,
mixed $aliases
): self;
```
Sets one or more aliases to the given name.
setDefault()
```php
public static function setDefault( DiInterface $container ): void;
```
Set a default dependency injection container to be obtained into static
methods
setInternalEventsManager()
```php
public function setInternalEventsManager( ManagerInterface $eventsManager );
```
Sets the internal event manager
setService()
```php
public function setService(
string $name,
ServiceInterface $rawDefinition
): ServiceInterface;
```
Sets a service using a raw Phalcon\Di\Service definition
setShared()
```php
public function setShared(
string $name,
mixed $definition
): ServiceInterface;
```
Registers an "always shared" service in the services container
loadFromConfig()
```php
protected function loadFromConfig( ConfigInterface $config ): void;
```
Loads services from a Config object.
## Di\DiInterface
Interface
Interface for Phalcon\Di\Di
- `\ArrayAccess`
- **`Phalcon\Di\DiInterface`**
`ArrayAccess`
### Method Summary
Attempts to register a service in the services container
Resolves the service based on its configuration
Return the last DI created
Returns a service definition without resolving
Returns the corresponding Phalcon\Di\Service instance for a service
Return the services registered in the DI
Returns a shared service based on their configuration
Check whether the DI contains a service by a name
Check whether the DI has a cached shared instance for a service name.
Removes a service in the services container
Removes the cached shared instance for a service, leaving the service
Resets the internal default DI
Registers a service in the services container
Set a default dependency injection container to be obtained into static
Sets a service using a raw Phalcon\Di\Service definition
Registers an "always shared" service in the services container
### Methods
attempt()
```php
public function attempt(
string $name,
mixed $definition,
bool $shared = false
): ServiceInterface|bool;
```
Attempts to register a service in the services container
Only is successful if a service hasn't been registered previously
with the same name
get()
```php
public function get(
string $name,
mixed $parameters = null
): mixed;
```
Resolves the service based on its configuration
getDefault()
```php
public static function getDefault(): DiInterface|null;
```
Return the last DI created
getRaw()
```php
public function getRaw( string $name ): mixed;
```
Returns a service definition without resolving
getService()
```php
public function getService( string $name ): ServiceInterface;
```
Returns the corresponding Phalcon\Di\Service instance for a service
getServices()
```php
public function getServices(): ServiceInterface[];
```
Return the services registered in the DI
getShared()
```php
public function getShared(
string $name,
mixed $parameters = null
): mixed;
```
Returns a shared service based on their configuration
has()
```php
public function has( string $name ): bool;
```
Check whether the DI contains a service by a name
hasShared()
```php
public function hasShared( string $name ): bool;
```
Check whether the DI has a cached shared instance for a service name.
Unlike `has()`, which reports on the service *definition* registry,
this method reports only on the resolved-instance cache populated by
`getShared()`. A service can be registered (`has()` returns true)
without yet having a shared instance (`hasShared()` returns false).
remove()
```php
public function remove( string $name ): void;
```
Removes a service in the services container
removeShared()
```php
public function removeShared( string $name ): void;
```
Removes the cached shared instance for a service, leaving the service
definition intact so the next `getShared()` call rebuilds it.
Useful in fork-based multi-process setups where a child inherits the
parent's resource handle (e.g. a database connection) and needs to
discard the cached instance without re-registering the service.
reset()
```php
public static function reset(): void;
```
Resets the internal default DI
set()
```php
public function set(
string $name,
mixed $definition,
bool $shared = false
): ServiceInterface;
```
Registers a service in the services container
setDefault()
```php
public static function setDefault( DiInterface $container ): void;
```
Set a default dependency injection container to be obtained into static
methods
setService()
```php
public function setService(
string $name,
ServiceInterface $rawDefinition
): ServiceInterface;
```
Sets a service using a raw Phalcon\Di\Service definition
setShared()
```php
public function setShared(
string $name,
mixed $definition
): ServiceInterface;
```
Registers an "always shared" service in the services container
## Di\Exception
Class
Exceptions thrown in Phalcon\Di will use this class
- `\Exception`
- **`Phalcon\Di\Exception`**
- [`Phalcon\Di\Exception\ServiceResolutionException`](#diexceptionserviceresolutionexception)
- [`Phalcon\Di\Exceptions\AliasAlreadyInUse`](#diexceptionsaliasalreadyinuse)
- [`Phalcon\Di\Exceptions\AliasNameMustBeString`](#diexceptionsaliasnamemustbestring)
- [`Phalcon\Di\Exceptions\ArgumentTypeRequired`](#diexceptionsargumenttyperequired)
- [`Phalcon\Di\Exceptions\CallArgumentsMustBeArray`](#diexceptionscallargumentsmustbearray)
- [`Phalcon\Di\Exceptions\CircularAliasReference`](#diexceptionscircularaliasreference)
- [`Phalcon\Di\Exceptions\ContainerRequired`](#diexceptionscontainerrequired)
- [`Phalcon\Di\Exceptions\DefinitionMustBeArrayForRead`](#diexceptionsdefinitionmustbearrayforread)
- [`Phalcon\Di\Exceptions\DefinitionMustBeArrayForUpdate`](#diexceptionsdefinitionmustbearrayforupdate)
- [`Phalcon\Di\Exceptions\MethodCallMustBeArray`](#diexceptionsmethodcallmustbearray)
- [`Phalcon\Di\Exceptions\MethodNameRequired`](#diexceptionsmethodnamerequired)
- [`Phalcon\Di\Exceptions\MissingClassNameParameter`](#diexceptionsmissingclassnameparameter)
- [`Phalcon\Di\Exceptions\MissingParameterKey`](#diexceptionsmissingparameterkey)
- [`Phalcon\Di\Exceptions\PropertyInjectionRequiresInstance`](#diexceptionspropertyinjectionrequiresinstance)
- [`Phalcon\Di\Exceptions\PropertyMustBeArray`](#diexceptionspropertymustbearray)
- [`Phalcon\Di\Exceptions\PropertyNameRequired`](#diexceptionspropertynamerequired)
- [`Phalcon\Di\Exceptions\PropertyValueRequired`](#diexceptionspropertyvaluerequired)
- [`Phalcon\Di\Exceptions\ServiceCannotBeResolved`](#diexceptionsservicecannotberesolved)
- [`Phalcon\Di\Exceptions\SetterInjectionRequiresInstance`](#diexceptionssetterinjectionrequiresinstance)
- [`Phalcon\Di\Exceptions\SetterParametersMustBeArray`](#diexceptionssetterparametersmustbearray)
- [`Phalcon\Di\Exceptions\UnknownServiceType`](#diexceptionsunknownservicetype)
### Method Summary
### Methods
serviceCannotBeResolved()
```php
public static function serviceCannotBeResolved( string $name ): Exception;
```
serviceNotFound()
```php
public static function serviceNotFound( string $name ): Exception;
```
undefinedMethod()
```php
public static function undefinedMethod( string $method ): Exception;
```
unknownServiceInParameter()
```php
public static function unknownServiceInParameter( int $position ): Exception;
```
## Di\Exception\ServiceResolutionException
Class
Phalcon\Di\Exception\ServiceResolutionException
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exception\ServiceResolutionException`**
## Di\Exceptions\AliasAlreadyInUse
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\AliasAlreadyInUse`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( string $alias );
```
## Di\Exceptions\AliasNameMustBeString
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\AliasNameMustBeString`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Di\Exceptions\ArgumentTypeRequired
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\ArgumentTypeRequired`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( int $position );
```
## Di\Exceptions\CallArgumentsMustBeArray
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\CallArgumentsMustBeArray`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( int $position );
```
## Di\Exceptions\CircularAliasReference
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\CircularAliasReference`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( string $name );
```
## Di\Exceptions\ContainerRequired
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\ContainerRequired`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Di\Exceptions\DefinitionMustBeArrayForRead
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\DefinitionMustBeArrayForRead`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Di\Exceptions\DefinitionMustBeArrayForUpdate
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\DefinitionMustBeArrayForUpdate`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Di\Exceptions\MethodCallMustBeArray
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\MethodCallMustBeArray`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( int $position );
```
## Di\Exceptions\MethodNameRequired
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\MethodNameRequired`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( int $position );
```
## Di\Exceptions\MissingClassNameParameter
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\MissingClassNameParameter`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Di\Exceptions\MissingParameterKey
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\MissingParameterKey`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct(
string $key,
int $position
);
```
## Di\Exceptions\PropertyInjectionRequiresInstance
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\PropertyInjectionRequiresInstance`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Di\Exceptions\PropertyMustBeArray
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\PropertyMustBeArray`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( int $position );
```
## Di\Exceptions\PropertyNameRequired
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\PropertyNameRequired`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( int $position );
```
## Di\Exceptions\PropertyValueRequired
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\PropertyValueRequired`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( int $position );
```
## Di\Exceptions\ServiceCannotBeResolved
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\ServiceCannotBeResolved`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( string $name );
```
## Di\Exceptions\SetterInjectionRequiresInstance
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\SetterInjectionRequiresInstance`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Di\Exceptions\SetterParametersMustBeArray
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\SetterParametersMustBeArray`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct();
```
## Di\Exceptions\UnknownServiceType
Class
- `\Exception`
- [`Phalcon\Di\Exception`](#diexception)
- **`Phalcon\Di\Exceptions\UnknownServiceType`**
`Phalcon\Di\Exception`
### Method Summary
### Methods
__construct()
```php
public function __construct( int $position );
```
## Di\FactoryDefault
Class
This is a variant of the standard Phalcon\Di\Di. By default it automatically
registers all the services provided by the framework. Thanks to this, the
developer does not need to register each service individually providing a
full stack framework
- [`Phalcon\Di\Di`](#didi)
- **`Phalcon\Di\FactoryDefault`**
- [`Phalcon\Di\FactoryDefault\Cli`](#difactorydefaultcli)
`Phalcon\Annotations\Adapter\Memory` · `Phalcon\Assets\Manager` · `Phalcon\Encryption\Crypt` · `Phalcon\Encryption\Security` · `Phalcon\Events\Manager` · `Phalcon\Filter\FilterFactory` · `Phalcon\Flash\Direct` · `Phalcon\Flash\Session` · `Phalcon\Html\Escaper` · `Phalcon\Html\TagFactory` · `Phalcon\Http\Request` · `Phalcon\Http\Response` · `Phalcon\Http\Response\Cookies` · `Phalcon\Mvc\Dispatcher` · `Phalcon\Mvc\Model\Manager` · `Phalcon\Mvc\Model\MetaData\Memory` · `Phalcon\Mvc\Model\Transaction\Manager` · `Phalcon\Mvc\Router` · `Phalcon\Mvc\Url` · `Phalcon\Queue\QueueFactory` · `Phalcon\Support\HelperFactory` · `Phalcon\Support\Settings`
### Method Summary
Phalcon\Di\FactoryDefault constructor
### Methods
__construct()
```php
public function __construct();
```
Phalcon\Di\FactoryDefault constructor
## Di\FactoryDefault\Cli
Class
Phalcon\Di\FactoryDefault\Cli
This is a variant of the standard Phalcon\Di. By default it automatically
registers all the services provided by the framework.
Thanks to this, the developer does not need to register each service individually.
This class is specially suitable for CLI applications
- [`Phalcon\Di\Di`](#didi)
- [`Phalcon\Di\FactoryDefault`](#difactorydefault)
- **`Phalcon\Di\FactoryDefault\Cli`**
`Phalcon\Annotations\Adapter\Memory` · `Phalcon\Cli\Dispatcher` · `Phalcon\Cli\Router` · `Phalcon\Di\FactoryDefault` · `Phalcon\Di\Service` · `Phalcon\Encryption\Security` · `Phalcon\Events\Manager` · `Phalcon\Filter\FilterFactory` · `Phalcon\Html\Escaper` · `Phalcon\Html\TagFactory` · `Phalcon\Mvc\Model\Manager` · `Phalcon\Mvc\Model\MetaData\Memory` · `Phalcon\Mvc\Model\Transaction\Manager` · `Phalcon\Queue\QueueFactory` · `Phalcon\Support\HelperFactory` · `Phalcon\Support\Settings`
### Method Summary
Phalcon\Di\FactoryDefault\Cli constructor
### Methods
__construct()
```php
public function __construct();
```
Phalcon\Di\FactoryDefault\Cli constructor
## Di\InitializationAwareInterface
Interface
Interface for components that have `initialize()`
- **`Phalcon\Di\InitializationAwareInterface`**
### Method Summary
### Methods
initialize()
```php
public function initialize(): void;
```
## Di\Injectable
Abstract
This class allows to access services in the services container by just only
accessing a public property with the same name of a registered service
@property \Phalcon\Mvc\Dispatcher|\Phalcon\Mvc\DispatcherInterface $dispatcher
@property \Phalcon\Mvc\Router|\Phalcon\Mvc\RouterInterface $router
@property \Phalcon\Mvc\Url|\Phalcon\Mvc\Url\UrlInterface $url
@property \Phalcon\Http\Request|\Phalcon\Http\RequestInterface $request
@property \Phalcon\Http\Response|\Phalcon\Http\ResponseInterface $response
@property \Phalcon\Http\Response\Cookies|\Phalcon\Http\Response\CookiesInterface $cookies
@property \Phalcon\Filter\Filter $filter
@property \Phalcon\Flash\Direct $flash
@property \Phalcon\Flash\Session $flashSession
@property \Phalcon\Session\ManagerInterface $session
@property \Phalcon\Events\Manager|\Phalcon\Events\ManagerInterface $eventsManager
@property \Phalcon\Db\Adapter\AdapterInterface $db
@property \Phalcon\Encryption\Security $security
@property \Phalcon\Encryption\Crypt|\Phalcon\Encryption\Crypt\CryptInterface $crypt
@property \Phalcon\Html\TagFactory $tag
@property \Phalcon\Html\Escaper|\Phalcon\Html\Escaper\EscaperInterface $escaper
@property \Phalcon\Annotations\Adapter\Memory|\Phalcon\Annotations\Adapter $annotations
@property \Phalcon\Mvc\Model\Manager|\Phalcon\Mvc\Model\ManagerInterface $modelsManager
@property \Phalcon\Mvc\Model\MetaData\Memory|\Phalcon\Mvc\Model\MetadataInterface $modelsMetadata
@property \Phalcon\Mvc\Model\Transaction\Manager|\Phalcon\Mvc\Model\Transaction\ManagerInterface $transactionManager
@property \Phalcon\Support\Settings $settings
@property \Phalcon\Assets\Manager $assets
@property \Phalcon\Di\Di|\Phalcon\Di\DiInterface $di
@property \Phalcon\Session\Bag|\Phalcon\Session\BagInterface $persistent
@property \Phalcon\Mvc\View|\Phalcon\Mvc\ViewInterface $view
- `\stdClass`
- **`Phalcon\Di\Injectable`** - implements [`Phalcon\Di\InjectionAwareInterface`](#diinjectionawareinterface)
- [`Phalcon\Application\AbstractApplication`](/5.20/api/phalcon_application/#applicationabstractapplication)
- [`Phalcon\Cli\Task`](/5.20/api/phalcon_cli/#clitask)
- [`Phalcon\Filter\Validation`](/5.20/api/phalcon_filter/#filtervalidation)
- [`Phalcon\Forms\Form`](/5.20/api/phalcon_forms/#formsform)
- [`Phalcon\Mvc\Controller`](/5.20/api/phalcon_mvc/#mvccontroller)
- [`Phalcon\Mvc\Micro`](/5.20/api/phalcon_mvc/#mvcmicro)
- [`Phalcon\Mvc\View`](/5.20/api/phalcon_mvc/#mvcview)
- [`Phalcon\Mvc\View\Engine\AbstractEngine`](/5.20/api/phalcon_mvc/#mvcviewengineabstractengine)
- [`Phalcon\Mvc\View\Simple`](/5.20/api/phalcon_mvc/#mvcviewsimple)
`Phalcon\Di\Di` · `Phalcon\Di\Exceptions\ContainerRequired` · `Phalcon\Session\BagInterface` · `stdClass`
### Method Summary
Magic method __get
Magic method __isset
Returns the internal dependency injector
Sets the dependency injector
### Properties
Dependency Injector
### Methods
__get()
```php
public function __get( string $propertyName ): mixed|null;
```
Magic method __get
__isset()
```php
public function __isset( string $name ): bool;
```
Magic method __isset
getDI()
```php
public function getDI(): DiInterface;
```
Returns the internal dependency injector
setDI()
```php
public function setDI( DiInterface $container ): void;
```
Sets the dependency injector
## Di\InjectionAwareInterface
Interface
This interface must be implemented in those classes that uses internally the
Phalcon\Di\Di that creates them
- **`Phalcon\Di\InjectionAwareInterface`**
### Method Summary
Returns the internal dependency injector
Sets the dependency injector
### Methods
getDI()
```php
public function getDI(): DiInterface;
```
Returns the internal dependency injector
setDI()
```php
public function setDI( DiInterface $container ): void;
```
Sets the dependency injector
## Di\Service
Class
Represents individually a service in the services container
```php
$service = new \Phalcon\Di\Service(
"request",
\Phalcon\Http\Request::class
);
$request = service->resolve();
```
- **`Phalcon\Di\Service`** - implements [`Phalcon\Di\ServiceInterface`](#diserviceinterface)
`Closure` · `Phalcon\Di\Exception\ServiceResolutionException` · `Phalcon\Di\Exceptions\DefinitionMustBeArrayForRead` · `Phalcon\Di\Exceptions\DefinitionMustBeArrayForUpdate` · `Phalcon\Di\Service\Builder`
### Method Summary
Phalcon\Di\Service
Returns the service definition
Returns a parameter in a specific position
Returns true if the service was resolved
Check whether the service is shared or not
Resolves the service
Set the service definition
Changes a parameter in the definition without resolve the service
Sets if the service is shared or not
Sets/Resets the shared instance related to the service
### Properties
### Methods
__construct()
```php
final public function __construct(
mixed $definition,
bool $shared = false
);
```
Phalcon\Di\Service
getDefinition()
```php
public function getDefinition(): mixed;
```
Returns the service definition
getParameter()
```php
public function getParameter( int $position );
```
Returns a parameter in a specific position
isResolved()
```php
public function isResolved(): bool;
```
Returns true if the service was resolved
isShared()
```php
public function isShared(): bool;
```
Check whether the service is shared or not
resolve()
```php
public function resolve(
mixed $parameters = null,
DiInterface|null $container = null
): mixed;
```
Resolves the service
setDefinition()
```php
public function setDefinition( mixed $definition ): void;
```
Set the service definition
setParameter()
```php
public function setParameter(
int $position,
array $parameter
): ServiceInterface;
```
Changes a parameter in the definition without resolve the service
setShared()
```php
public function setShared( bool $shared ): void;
```
Sets if the service is shared or not
setSharedInstance()
```php
public function setSharedInstance( mixed $sharedInstance ): void;
```
Sets/Resets the shared instance related to the service
## Di\ServiceInterface
Interface
Represents a service in the services container
- **`Phalcon\Di\ServiceInterface`**
### Method Summary
Returns the service definition
Returns a parameter in a specific position
Returns true if the service was resolved
Check whether the service is shared or not
Resolves the service
Set the service definition
Changes a parameter in the definition without resolve the service
Sets if the service is shared or not
### Methods
getDefinition()
```php
public function getDefinition(): mixed;
```
Returns the service definition
getParameter()
```php
public function getParameter( int $position );
```
Returns a parameter in a specific position
isResolved()
```php
public function isResolved(): bool;
```
Returns true if the service was resolved
isShared()
```php
public function isShared(): bool;
```
Check whether the service is shared or not
resolve()
```php
public function resolve(
mixed $parameters = null,
DiInterface|null $container = null
): mixed;
```
Resolves the service
setDefinition()
```php
public function setDefinition( mixed $definition );
```
Set the service definition
setParameter()
```php
public function setParameter(
int $position,
array $parameter
): ServiceInterface;
```
Changes a parameter in the definition without resolve the service
setShared()
```php
public function setShared( bool $shared );
```
Sets if the service is shared or not
## Di\ServiceProviderInterface
Interface
Should be implemented by service providers, or such components, which
register a service in the service container.
```php
namespace Acme;
use Phalcon\Di\DiInterface;
use Phalcon\Di\ServiceProviderInterface;
class SomeServiceProvider implements ServiceProviderInterface
{
public function register(DiInterface $di)
{
$di->setShared(
'service',
function () {
// ...
}
);
}
}
```
- **`Phalcon\Di\ServiceProviderInterface`**
### Method Summary
Registers a service provider.
### Methods
register()
```php
public function register( DiInterface $di ): void;
```
Registers a service provider.
## Di\Service\Builder
Class
Phalcon\Di\Service\Builder
This class builds instances based on complex definitions
- **`Phalcon\Di\Service\Builder`**
`Phalcon\Di\DiInterface` · `Phalcon\Di\Exception` · `Phalcon\Di\Exceptions\ArgumentTypeRequired` · `Phalcon\Di\Exceptions\CallArgumentsMustBeArray` · `Phalcon\Di\Exceptions\MethodCallMustBeArray` · `Phalcon\Di\Exceptions\MethodNameRequired` · `Phalcon\Di\Exceptions\MissingClassNameParameter` · `Phalcon\Di\Exceptions\MissingParameterKey` · `Phalcon\Di\Exceptions\PropertyInjectionRequiresInstance` · `Phalcon\Di\Exceptions\PropertyMustBeArray` · `Phalcon\Di\Exceptions\PropertyNameRequired` · `Phalcon\Di\Exceptions\PropertyValueRequired` · `Phalcon\Di\Exceptions\SetterInjectionRequiresInstance` · `Phalcon\Di\Exceptions\SetterParametersMustBeArray` · `Phalcon\Di\Exceptions\UnknownServiceType`
### Method Summary
Builds a service using a complex service definition
### Methods
build()
```php
public function build(
DiInterface $container,
array $definition,
mixed $parameters = null
);
```
Builds a service using a complex service definition
Source: https://docs.phalcon.io/5.20/api/phalcon_di/index.mdx