You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
159 lines
5.3 KiB
159 lines
5.3 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\console; |
|
|
|
/** |
|
* This class provides constants for defining console command exit codes. |
|
* |
|
* The exit codes follow the codes defined in the [FreeBSD sysexits(3)](http://man.openbsd.org/sysexits) manual page. |
|
* |
|
* These constants can be used in console controllers for example like this: |
|
* |
|
* ```php |
|
* public function actionIndex() |
|
* { |
|
* if (!$this->isAllowedToPerformAction()) { |
|
* $this->stderr('Error: ' . ExitCode::getReason(ExitCode::NOPERM)); |
|
* return ExitCode::NOPERM; |
|
* } |
|
* |
|
* // do something |
|
* |
|
* return ExitCode::OK; |
|
* } |
|
* ``` |
|
* |
|
* @author Tom Worster <fsb@thefsb.org> |
|
* @author Alexander Makarov <sam@rmcreative.ru> |
|
* @see http://man.openbsd.org/sysexits |
|
* @since 2.0.13 |
|
*/ |
|
class ExitCode |
|
{ |
|
/** |
|
* The command completed successfully. |
|
*/ |
|
const OK = 0; |
|
/** |
|
* The command exited with an error code that says nothing about the error. |
|
*/ |
|
const UNSPECIFIED_ERROR = 1; |
|
/** |
|
* The command was used incorrectly, e.g., with the wrong number of |
|
* arguments, a bad flag, a bad syntax in a parameter, or whatever. |
|
*/ |
|
const USAGE = 64; |
|
/** |
|
* The input data was incorrect in some way. This should only be used for |
|
* user's data and not system files. |
|
*/ |
|
const DATAERR = 65; |
|
/** |
|
* 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). |
|
*/ |
|
const NOINPUT = 66; |
|
/** |
|
* The user specified did not exist. This might be used for mail addresses |
|
* or remote logins. |
|
*/ |
|
const NOUSER = 67; |
|
/** |
|
* The host specified did not exist. This is used in mail addresses or |
|
* network requests. |
|
*/ |
|
const NOHOST = 68; |
|
/** |
|
* 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. |
|
*/ |
|
const UNAVAILABLE = 69; |
|
/** |
|
* An internal software error has been detected. This should be limited to |
|
* non-operating system related errors as possible. |
|
*/ |
|
const SOFTWARE = 70; |
|
/** |
|
* 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. |
|
*/ |
|
const OSERR = 71; |
|
/** |
|
* 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). |
|
*/ |
|
const OSFILE = 72; |
|
/** |
|
* A (user specified) output file cannot be created. |
|
*/ |
|
const CANTCREAT = 73; |
|
/** |
|
* An error occurred while doing I/O on some file. |
|
*/ |
|
const IOERR = 74; |
|
/** |
|
* 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. |
|
*/ |
|
const TEMPFAIL = 75; |
|
/** |
|
* The remote system returned something that was ``not possible'' during a |
|
* protocol exchange. |
|
*/ |
|
const PROTOCOL = 76; |
|
/** |
|
* 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. |
|
*/ |
|
const NOPERM = 77; |
|
/** |
|
* Something was found in an unconfigured or misconfigured state. |
|
*/ |
|
const CONFIG = 78; |
|
|
|
/** |
|
* @var array a map of reason descriptions for exit codes. |
|
*/ |
|
public static $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', |
|
]; |
|
|
|
/** |
|
* Returns a short reason text for the given exit code. |
|
* |
|
* This method uses [[$reasons]] to determine the reason for an exit code. |
|
* @param int $exitCode one of the constants defined in this class. |
|
* @return string the 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'; |
|
} |
|
}
|
|
|