0 follower

Final Class Yiisoft\Di\StateResetter

All Classes | Methods

Inheritance	Yiisoft\Di\StateResetter

State resetter allows resetting state of the services that are currently stored in the container and have "reset" callback defined. The reset should be triggered after each request-response cycle in case you build long-running applications with tools like Swoole or RoadRunner.

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()		Yiisoft\Di\StateResetter
reset()	Reset the container.	Yiisoft\Di\StateResetter
setResetters()		Yiisoft\Di\StateResetter

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( \Psr\Container\ContainerInterface $container )
$container	\Psr\Container\ContainerInterface	Container to reset.

Source code

                public function __construct(
    private readonly ContainerInterface $container
) {
}

reset() public method

Reset the container.

public void reset ( )

Source code

                public function reset(): void
{
    foreach ($this->resetters as $resetter) {
        if ($resetter instanceof self) {
            $resetter->reset();
            continue;
        }
        $resetter($this->container);
    }
}

setResetters() public method

public void setResetters ( Closure[]\|self[] $resetters )
$resetters	Closure[]\|self[]	Array of reset callbacks. Each callback has access to the private and protected properties of the service instance, so you can set the initial state of the service efficiently without creating a new instance.

Source code

                public function setResetters(array $resetters): void
{
    $this->resetters = [];
    foreach ($resetters as $serviceId => $callback) {
        if (is_int($serviceId)) {
            if (!$callback instanceof self) {
                throw new InvalidArgumentException(sprintf(
                    'State resetter object should be instance of "%s", "%s" given.',
                    self::class,
                    get_debug_type($callback)
                ));
            }
            $this->resetters[] = $callback;
            continue;
        }
        if (!$callback instanceof Closure) {
            throw new InvalidArgumentException(
                'Callback for state resetter should be closure in format ' .
                '`function (ContainerInterface $container): void`. ' .
                'Got "' . get_debug_type($callback) . '".'
            );
        }
        $instance = $this->container->get($serviceId);
        if (!is_object($instance)) {
            throw new InvalidArgumentException(
                'State resetter supports resetting objects only. Container returned '
                . get_debug_type($instance)
                . '.'
            );
        }
        /** @var Closure */
        $this->resetters[] = $callback->bindTo($instance, $instance::class);
    }
}