This class provides constants for defining console command exit codes.
The exit codes follow the codes defined in the FreeBSD sysexits(3) manual page.
These constants can be used in console controllers for example like this:
public function actionIndex()
{
if (!$this->isAllowedToPerformAction()) {
$this->stderr('Error: ' . ExitCode::getReason(ExitCode::NOPERM));
return ExitCode::NOPERM;
}
// do something
return ExitCode::OK;
}
See also https://man.openbsd.org/sysexits.
Constants Constant Value Description Defined By CANTCREAT 73 A (user specified) output file cannot be created. yii\console\ExitCode CONFIG 78 Something was found in an unconfigured or misconfigured state. yii\console\ExitCode DATAERR 65 The input data was incorrect in some way. This should only be used for user's data and not system files. yii\console\ExitCode IOERR 74 An error occurred while doing I/O on some file. yii\console\ExitCode NOHOST 68 The host specified did not exist. This is used in mail addresses or network requests. yii\console\ExitCode NOINPUT 66 An input file (not a system file) did not exist or was not readable. This could also include errors like ``No message'' to a mailer (if it cared to catch it). yii\console\ExitCode NOPERM 77 You did not have sufficient permission to perform the operation. This is not intended for file system problems, which should use NOINPUT or CANTCREAT, but rather for higher level permissions. yii\console\ExitCode NOUSER 67 The user specified did not exist. This might be used for mail addresses or remote logins. yii\console\ExitCode OK 0 The command completed successfully. yii\console\ExitCode OSERR 71 An operating system error has been detected. This is intended to be used for such things as`cannot fork'', `cannot create pipe'', or the like. It includes things like getuid returning a user that does not exist in the passwd file. yii\console\ExitCode OSFILE 72 Some system file (e.g., /etc/passwd, /var/run/utx.active, etc.) does not exist, cannot be opened, or has some sort of error (e.g., syntax error). yii\console\ExitCode PROTOCOL 76 The remote system returned something that was ``not possible'' during a protocol exchange. yii\console\ExitCode SOFTWARE 70 An internal software error has been detected. This should be limited to non-operating system related errors as possible. yii\console\ExitCode TEMPFAIL 75 Temporary failure, indicating something that is not really an error. In sendmail, this means that a mailer (e.g.) could not create a connection, and the request should be reattempted later. yii\console\ExitCode UNAVAILABLE 69 A service is unavailable. This can occur if a support program or file does not exist. This can also be used as a catchall message when something you wanted to do does not work, but you do not know why. yii\console\ExitCode UNSPECIFIED_ERROR 1 The command exited with an error code that says nothing about the error. yii\console\ExitCode USAGE 64 The command was used incorrectly, e.g., with the wrong number of arguments, a bad flag, a bad syntax in a parameter, or whatever. yii\console\ExitCode Property Details
$reasons
public static propertyA map of reason descriptions for exit codes.
public static array $reasons = [getReason()
public static methodReturns a short reason text for the given exit code.
This method uses $reasons to determine the reason for an exit code.
public static string getReason ( $exitCode ) $exitCode integerOne of the constants defined in this class.
return stringThe reason text, or "Unknown exit code" if the code is not listed in $reasons.
public static function getReason($exitCode)
{
return isset(static::$reasons[$exitCode]) ? static::$reasons[$exitCode] : 'Unknown exit code';
}
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4