README

Yii 控制台运行器

该包包含运行 Yii3 控制台应用程序的引导程序。

需求

PHP 8.0 或更高版本。

安装

可以使用 Composer 安装此包

composer require yiisoft/yii-runner-console

通用用法

在您的控制台入口脚本中执行以下操作

#!/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();

附加配置

默认情况下，ConsoleApplicationRunner 配置为与 Yii 应用程序模板一起工作，并遵循配置组约定。

您可以使用构造函数参数和不可变设置器覆盖默认配置。

构造函数参数

$rootPath — 项目根的绝对路径。

$debug — 是否启用调试模式。

$checkEvents — 是否检查事件配置。

$environment — 环境名称。

$bootstrapGroup — 引导配置组名称。

$eventsGroup — 事件配置组名称。

$diGroup — 容器定义的配置组名称。

$diProvidersGroup — 容器提供者的配置组名称。

$diDelegatesGroup — 容器代理的配置组名称。

$diTagsGroup — 容器标签的配置组名称。

$paramsGroup — 配置参数组名称。

$nestedParamsGroups — 包含在配置参数组中的配置组名称。这对于递归合并参数是必需的。

$nestedEventsGroups — 包含在事件配置组中的配置组名称。这对于反向和递归合并事件配置是必需的。

不可变设置器

如果配置实例设置与默认设置不同，您可以指定自定义配置实例

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

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

默认容器是 Yiisoft\Di\Container。但您可以指定任何实现 Psr\Container\ContainerInterface 的实现。

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

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

文档

内部

如果您需要帮助或有问题，Yii 论坛是一个好地方。您还可以查看其他 Yii 社区资源。

许可

Yii 控制台运行器是免费软件。它根据 BSD 许可证发布。有关更多信息，请参阅 LICENSE。

由 Yii 软件维护。

yiisoft / yii-runner-console

维护者

详细信息