没有命名空间的类 yii yii\base yii\behaviors yii\caching yii\captcha yii\console yii\console\controllers yii\console\widgets yii\data yii\db yii\db\conditions yii\db\cubrid yii\db\cubrid\conditions yii\db\mssql yii\db\mssql\conditions yii\db\mysql yii\db\oci yii\db\oci\conditions yii\db\pgsql yii\db\sqlite yii\db\sqlite\conditions yii\di yii\filters yii\filters\auth yii\grid yii\helpers yii\i18n yii\log yii\mail yii\mutex yii\rbac yii\rest yii\test yii\validators yii\web yii\widgets

Class yii\console\ExitCode

继承yii\console\ExitCode
可用版本自2.0.13
源码 https://github.com/yiichina/yii2/blob/api/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;
}

参见 http://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 输入文件(不是系统文件)不存在或不可读。 这也可能包括邮件中的 ``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 某些系统文件(例如,/etc/passwd,/var/run/utx.active,等等。) 不存在,不能被打开,或者有某种错误(例如,syntax error)。 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 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 requied 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() 公共 静态 方法

返回给定退出代码的简短原因文本。

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

public static string getReason($exitCode)
$exitCode integer

此类中定义的常量之一。

return string

原因文本,或 "Unknown exit code" 如果代码未在 $reasons 中列出。