ExitCode
in package
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;
}
Tags
Table of Contents
Constants
- CANTCREAT = 73
- A (user specified) output file cannot be created.
- CONFIG = 78
- Something was found in an unconfigured or misconfigured state.
- DATAERR = 65
- The input data was incorrect in some way. This should only be used for user's data and not system files.
- IOERR = 74
- An error occurred while doing I/O on some file.
- NOHOST = 68
- The host specified did not exist. This is used in mail addresses or network requests.
- NOINPUT = 66
- An input file (not a system file) did not exist or was not readable.
- 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.
- NOUSER = 67
- The user specified did not exist. This might be used for mail addresses or remote logins.
- OK = 0
- The command completed successfully.
- 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.
- 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).
- PROTOCOL = 76
- The remote system returned something that was ``not possible'' during a protocol exchange.
- SOFTWARE = 70
- An internal software error has been detected. This should be limited to non-operating system related errors as possible.
- 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.
- 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.
- UNSPECIFIED_ERROR = 1
- The command exited with an error code that says nothing about the error.
- 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.
Properties
- $reasons : array<string|int, mixed>
Methods
- getReason() : string
- Returns a short reason text for the given exit code.
Constants
CANTCREAT
A (user specified) output file cannot be created.
public
mixed
CANTCREAT
= 73
CONFIG
Something was found in an unconfigured or misconfigured state.
public
mixed
CONFIG
= 78
DATAERR
The input data was incorrect in some way. This should only be used for user's data and not system files.
public
mixed
DATAERR
= 65
IOERR
An error occurred while doing I/O on some file.
public
mixed
IOERR
= 74
NOHOST
The host specified did not exist. This is used in mail addresses or network requests.
public
mixed
NOHOST
= 68
NOINPUT
An input file (not a system file) did not exist or was not readable.
public
mixed
NOINPUT
= 66
This could also include errors like ``No message'' to a mailer (if it cared to catch it).
NOPERM
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.
public
mixed
NOPERM
= 77
NOUSER
The user specified did not exist. This might be used for mail addresses or remote logins.
public
mixed
NOUSER
= 67
OK
The command completed successfully.
public
mixed
OK
= 0
OSERR
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.
public
mixed
OSERR
= 71
OSFILE
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).
public
mixed
OSFILE
= 72
PROTOCOL
The remote system returned something that was ``not possible'' during a protocol exchange.
public
mixed
PROTOCOL
= 76
SOFTWARE
An internal software error has been detected. This should be limited to non-operating system related errors as possible.
public
mixed
SOFTWARE
= 70
TEMPFAIL
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.
public
mixed
TEMPFAIL
= 75
UNAVAILABLE
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.
public
mixed
UNAVAILABLE
= 69
UNSPECIFIED_ERROR
The command exited with an error code that says nothing about the error.
public
mixed
UNSPECIFIED_ERROR
= 1
USAGE
The command was used incorrectly, e.g., with the wrong number of arguments, a bad flag, a bad syntax in a parameter, or whatever.
public
mixed
USAGE
= 64
Properties
$reasons
public
static array<string|int, mixed>
$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']
a map of reason descriptions for exit codes.
Methods
getReason()
Returns a short reason text for the given exit code.
public
static getReason(int $exitCode) : string
This method uses [[$reasons]] to determine the reason for an exit code.
Parameters
- $exitCode : int
-
one of the constants defined in this class.
Return values
string —the reason text, or "Unknown exit code" if the code is not listed in [[$reasons]].