Skip to content

ServiceProvider

Registers the CLI console service.

The console service is the Phalcon CLI entrypoint used by task bootstraps. It is registered separately from the MVC application so command execution can use CLI router/dispatcher defaults while still sharing the same PhalconKit DI contracts as the rest of the framework.


Properties

serviceName

Stable DI service name managed by this provider.

protected string $serviceName

This value is part of the provider contract because controllers, tasks, other injectables, and replacement providers resolve services by name. Concrete providers must set it to a non-empty value.


Methods

register

Register the shared console service.

public register(\PhalconKit\Di\DiInterface $di): void

The console receives the DI container at construction time, matching Phalcon's native console lifecycle and allowing task modules to resolve framework services from the configured container.

Parameters:

Parameter Type Description
$di \PhalconKit\Di\DiInterface

Inherited methods

__construct

Stores the DI container and prepares the provider for registration.

public __construct(\PhalconKit\Di\DiInterface $di): mixed

The constructor intentionally requires PhalconKit\Di\DiInterface so providers can rely on typed service helpers during configuration and registration.

Parameters:

Parameter Type Description
$di \PhalconKit\Di\DiInterface

Throws:

When a concrete provider does not define a non-empty service name. - LogicException


getName

Returns the DI service name managed by this provider.

public getName(): string

boot

Optional post-registration hook.

public boot(): void

The base implementation is intentionally empty. Custom bootstraps or application code may call this method for provider-specific startup work after all services have been registered.


configure

Optional provider-local configuration hook.

public configure(): void

This runs during construction after DI has been stored and before register() is called. Use it to normalize provider options or prepare lightweight state; service creation belongs in register().