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 ファイルの入出力中にエラーが発生しました。 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

プロパティの詳細

継承されたプロパティを非表示

終了コードの理由の説明のマップです。

public static array $reasons = [
    self::OK => '成功',
    self::UNSPECIFIED_ERROR => '不明なエラー',
    self::USAGE => '不正な使用方法、引数、またはオプションエラー',
    self::DATAERR => '入力データのエラー',
    self::NOINPUT => '入力ファイルが見つからないか、読み取れません',
    self::NOUSER => 'ユーザーが見つかりません',
    self::NOHOST => 'ホストが見つかりません',
    self::UNAVAILABLE => '必要なサービスを利用できません',
    self::SOFTWARE => '内部エラー',
    self::OSERR => 'システムコールの実行時またはOSサービスの使用時のエラー',
    self::OSFILE => 'システムファイルへのアクセスエラー',
    self::CANTCREAT => '出力ファイルを作成できません',
    self::IOERR => 'I/Oエラー',
    self::TEMPFAIL => '一時的なエラー',
    self::PROTOCOL => '予期せぬリモートサービスの動作',
    self::NOPERM => '権限が不足しています',
    self::CONFIG => '設定エラー',
]

メソッドの詳細

継承されたメソッドを非表示

getReason() public static メソッド

指定された終了コードの短い理由テキストを返します。

このメソッドは、$reasons を使用して、終了コードの原因を特定します。

public static string getReason ( $exitCode )
$exitCode 整数

このクラスで定義されている定数の1つ。
戻り値 文字列

理由のテキスト、またはコードが$reasonsにリストされていない場合は"不明な終了コード"。

 

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