yiisoft/yii-runner-console

Console application runner

1.0.0 2022-01-17 21:05 UTC

This package is auto-updated.

Last update: 2022-01-17 21:06:22 UTC


README

68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667

Yii Console Runner


Latest Stable Version Total Downloads Build status Scrutinizer Code Quality static analysis type-coverage

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 --prefer-dist

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(__DIR__, $_ENV['YII_DEBUG'], $_ENV['YII_ENV']))->run();

Additional configuration

By default, the ConsoleApplicationRunner is configured to work with Yii application templates. You can override the default configuration using immutable setters.

Override the name of the bootstrap configuration group as follows:

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

// Bootstrap configuration group name by default is "bootstrap-web".
$runner = $runner->withBootstrap('my-bootstrap-config-group-name');

// Disables the use of bootstrap configuration group.
$runner = $runner->withoutBootstrap();

In debug mode, event configurations are checked, to override, use the following setters:

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

// Configuration group name of events by default is "events-web".
$runner = $runner->withCheckingEvents('my-events-config-group-name');

// Disables checking of the event configuration group.
$runner = $runner->withoutCheckingEvents();

If the configuration instance settings differ from the default, such as configuration group names, 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);

Testing

The package is tested with Codeception. To run tests:

./vendor/bin/codecept run

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

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

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack