Class yii\console\ExitCode

继承yii\console\ExitCode
可用自版本2.0.13
源代码 https://github.com/yiisoft/yii2/blob/master/framework/console/ExitCode.php

此类提供了用于定义控制台命令退出(exit)代码的常量.

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

这些常量可以在控制台控制台中使用, 例如:

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

    // do something

    return ExitCode::OK;
}

参见 http://man.openbsd.org/sysexits.

公共属性

隐藏继承的属性

属性类型描述定义在
$reasons array 退出代码(exit)的原因映射表. yii\console\ExitCode

公共方法

隐藏继承的方法

方法描述定义在
getReason() 返回给定退出(exit)代码的简短原因文本. 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 输入文件(不是系统文件)不存在或不可读. 这也可能包括诸如项邮件发送者No message之类的错误(如果它想捕获它). yii\console\ExitCode
NOPERM 77 你没有足够的权限执行该操作. 这不是针对文件系统问题(应使用 NOINPUT 或 CANTCREAT), 而是针对更改级别的权限. yii\console\ExitCode
NOUSER 67 指定的用户不存在. 这可能用于邮件地址或远程登录. yii\console\ExitCode
OK 0 该命令成功完成. yii\console\ExitCode
OSERR 71 已检测到操作系统错误. 这旨在用于诸如cannot fork, cannot create pipe之类的事情. 它包括诸如 getuid 返回 passwd 文件中不存在的用户之类的事情. yii\console\ExitCode
OSFILE 72 某些系统文件(eg., /etc/passwd, /var/run/utx.active, 等)不存在, 无法打开或存在某种错误(eg., 语法错误). yii\console\ExitCode
PROTOCOL 76 远程系统在协议交换期间返回了not possible的内容. yii\console\ExitCode
SOFTWARE 70 检测到内部软件错误. 应该将其限制为与操作系统无关的错误. yii\console\ExitCode
TEMPFAIL 75 暂时失败, 表明不是真正的错误. 在发送邮件中, 这意味着 邮件程序无法创建连接, 并且该请求应在以后重新尝试. yii\console\ExitCode
UNAVAILABLE 69 服务不可用. 如果不存在支持程序或文件, 则会发送这种情况. 当你想做的某事不起作用但不知道为什么时, 这也可以用作一则通俗易懂的消息. yii\console\ExitCode
UNSPECIFIED_ERROR 1 该命令以错误代码退出, 该错误代码未对错误进行任何说明. yii\console\ExitCode
USAGE 64 该命令使用不正确, 例如参数数量错误, 标志错误, 参数语法错误等. yii\console\ExitCode

属性详情

$reasons public static 属性

退出代码(exit)的原因映射表.

public static array $reasons = [self::OK => 'Success'self::UNSPECIFIED_ERROR => 'Unspecified error'self::USAGE => 'Incorrect usage, argument or option error'self::DATAERR => 'Error in input data'self::NOINPUT => 'Input file not found or unreadable'self::NOUSER => 'User not found'self::NOHOST => 'Host not found'self::UNAVAILABLE => 'A required service is unavailable'self::SOFTWARE => 'Internal error'self::OSERR => 'Error making system call or using OS service'self::OSFILE => 'Error accessing system file'self::CANTCREAT => 'Cannot create output file'self::IOERR => 'I/O error'self::TEMPFAIL => 'Temporary failure'self::PROTOCOL => 'Unexpected remote service behavior'self::NOPERM => 'Insufficient permissions'self::CONFIG => 'Configuration error']

方法详情

getReason() public static 方法

返回给定退出(exit)代码的简短原因文本.

此方法使用 $reasons 确定退出(exit)代码的原因.

public static string getReason ( $exitCode )
$exitCode integer

此类中定义的常量之一.

return string

原因文本, 如果未在 $reasons 中列出该代码, 则返回"Unknown exit code".