0 关注者

类 yii\console\ExitCode

所有类 | 属性 | 方法 | 常量
继承关系yii\console\ExitCode
可用版本2.0.13
源代码 https://github.com/yiisoft/yii2/blob/master/framework/console/ExitCode.php

此类提供定义控制台命令退出代码的常量。

退出代码遵循 FreeBSD sysexits(3) 手册页中定义的代码。

例如，这些常量可以在控制台控制器中这样使用：

public function actionIndex()
{
    if (!$this->isAllowedToPerformAction()) {
         $this->stderr('Error: ' . ExitCode::getReason(ExitCode::NOPERM));
         return ExitCode::NOPERM;
    }

    // do something

    return ExitCode::OK;
}

另请参阅 https://man.openbsd.org/sysexits。

公共属性

隐藏继承属性

属性 类型 描述 定义于
$reasons array 退出代码的理由描述映射。 yii\console\ExitCode

公共方法

隐藏继承方法

方法 描述 定义于
getReason() 返回给定退出代码的简短理由文本。 yii\console\ExitCode

常量

隐藏继承常量

常量 值 描述 定义于
CANTCREAT 73 无法创建（用户指定的）输出文件。 yii\console\ExitCode
CONFIG 78 发现某些内容处于未配置或配置错误的状态。 yii\console\ExitCode
DATAERR 65 输入数据在某种程度上不正确。这仅应用于用户数据，而不应用于系统文件。 yii\console\ExitCode
IOERR 74 在对某些文件执行 I/O 时发生错误。 yii\console\ExitCode
NOHOST 68 指定的主机不存在。这用于邮件地址或网络请求。 yii\console\ExitCode
NOINPUT 66 输入文件（不是系统文件）不存在或不可读。这还可能包括诸如“无消息”发送到邮件服务器之类的错误（如果它关心捕获它）。 yii\console\ExitCode
NOPERM 77 您没有足够的权限执行此操作。这并非旨在用于文件系统问题，文件系统问题应使用 NOINPUT 或 CANTCREAT，而是用于更高级别的权限。 yii\console\ExitCode
NOUSER 67 指定的用户名不存在。这可能用于邮件地址或远程登录。 yii\console\ExitCode
OK 0 命令已成功完成。 yii\console\ExitCode
OSERR 71 已检测到操作系统错误。这旨在用于诸如“无法分叉”、“无法创建管道”或类似内容之类的事情。它包括诸如 getuid 返回 passwd 文件中不存在的用户之类的事情。 yii\console\ExitCode
OSFILE 72 某些系统文件（例如，/etc/passwd、/var/run/utx.active 等）不存在、无法打开或存在某种错误（例如，语法错误）。 yii\console\ExitCode
PROTOCOL 76 远程系统在协议交换期间返回了“不可能”的内容。 yii\console\ExitCode
SOFTWARE 70 已检测到内部软件错误。这应尽可能地限制在与操作系统无关的错误。 yii\console\ExitCode
TEMPFAIL 75 临时故障，表示并非真正的错误。在 sendmail 中，这意味着邮件服务器（例如）无法建立连接，并且应稍后重新尝试请求。 yii\console\ExitCode
UNAVAILABLE 69 服务不可用。如果支持程序或文件不存在，则可能发生这种情况。当您想要执行的操作不起作用但不知道原因时，也可以将其用作通用消息。 yii\console\ExitCode
UNSPECIFIED_ERROR 1 命令以错误代码退出，该代码未说明错误。 yii\console\ExitCode
USAGE 64 命令使用不正确，例如，参数数量错误、标志错误、参数中的语法错误或其他任何错误。 yii\console\ExitCode

属性详细信息

隐藏继承属性

$reasons public static 属性

退出代码的理由描述映射。

公共静态 数组 $reasons = [
    self::OK => '成功',
    self::UNSPECIFIED_ERROR => '未指定的错误',
    self::USAGE => '使用不正确，参数或选项错误',
    self::DATAERR => '输入数据错误',
    self::NOINPUT => '输入文件未找到或无法读取',
    self::NOUSER => '用户未找到',
    self::NOHOST => '主机未找到',
    self::UNAVAILABLE => '所需服务不可用',
    self::SOFTWARE => '内部错误',
    self::OSERR => '进行系统调用或使用操作系统服务时出错',
    self::OSFILE => '访问系统文件出错',
    self::CANTCREAT => '无法创建输出文件',
    self::IOERR => 'I/O 错误',
    self::TEMPFAIL => '临时故障',
    self::PROTOCOL => '远程服务行为异常',
    self::NOPERM => '权限不足',
    self::CONFIG => '配置错误',
]

方法详情

隐藏继承方法

getReason() 公共静态方法

返回给定退出代码的简短理由文本。

此方法使用 $reasons 来确定退出代码的原因。

公共静态 字符串 getReason ( $exitCode )
$exitCode 整数

此类中定义的常量之一。
返回值 字符串

原因文本，如果代码未在 $reasons 中列出，则为 "未知退出代码"。

 

                public static function getReason($exitCode)
{
    return isset(static::$reasons[$exitCode]) ? static::$reasons[$exitCode] : 'Unknown exit code';
}