yiisoft/yii-runner-console

The package contains a bootstrap for running Yii3 console application.

Requirements

• PHP 8.0 or higher.

Installation

The package could be installed with Composer:

composer require yiisoft/yii-runner-console

General usage

In your console entry script do the following:

#!/usr/bin/env php
<?php

declare(strict_types=1);

use Yiisoft\Yii\Runner\Console\ConsoleApplicationRunner;

require_once __DIR__ . '/autoload.php';

(new ConsoleApplicationRunner(
    rootPath: __DIR__,
    debug: $_ENV['YII_DEBUG'], 
    checkEvents: $_ENV['YII_DEBUG'], 
    environment: $_ENV['YII_ENV']
))->run();

Additional configuration

By default, the ConsoleApplicationRunner is configured to work with Yii application templates and follows the config groups convention.

You can override the default configuration using constructor parameters and immutable setters.

Constructor parameters

$rootPath — the absolute path to the project root.

$debug — whether the debug mode is enabled.

$checkEvents — whether check events' configuration.

$environment — the environment name.

$bootstrapGroup — the bootstrap configuration group name.

$eventsGroup — the events' configuration group name.

$diGroup — the container definitions' configuration group name.

$diProvidersGroup — the container providers' configuration group name.

$diDelegatesGroup — the container delegates' configuration group name.

$diTagsGroup — the container tags' configuration group name.

$paramsGroup — the config parameters group name.

$nestedParamsGroups — configuration group names that are included into config parameters group. This is needed for recursive merge parameters.

$nestedEventsGroups — configuration group names that are included into events' configuration group. This is needed for reverse and recursive merge events' configurations.

Immutable setters

If the configuration instance settings differ from the default you can specify a customized configuration instance:

/**
 * @var Yiisoft\Config\ConfigInterface $config
 * @var Yiisoft\Yii\Runner\Console\ConsoleApplicationRunner $runner
 */

$runner = $runner->withConfig($config);

The default container is Yiisoft\Di\Container. But you can specify any implementation of the Psr\Container\ContainerInterface:

/**
 * @var Psr\Container\ContainerInterface $container
 * @var Yiisoft\Yii\Runner\Console\ConsoleApplicationRunner $runner
 */

$runner = $runner->withContainer($container);

Documentation

• Internals

If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.

License

The Yii Console Runner is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Follow updates