Kickass Crypto

Find us on GitHub: https://github.com/jj5/kickass-crypto.

exit.php

2023-04-03 jj5 - the kickass_crypto_exit() function just exits with some standard error levels.

2023-03-31 jj5 - SEE: https://www.jj5.net/sixsigma/Error_levels

Tags
link
https://github.com/jj5/kickass-crypto

Table of Contents

KICKASS_CRYPTO_EXIT_ASSERT  = 83
2023-04-05 jj5 - the error level to return when the program exits due to an assertion violation.
KICKASS_CRYPTO_EXIT_BAD_ENVIRONMENT  = 60
2023-04-05 jj5 - the error level to return when the program can't run due to an invalid run-time environment.
KICKASS_CRYPTO_EXIT_CANNOT_CONTINUE  = 10
2023-04-05 jj5 - the error level to return when nothing is broken or wrong but the program cannot continue.
KICKASS_CRYPTO_EXIT_ERROR  = 81
2023-04-05 jj5 - the error level to return when the program exits due to an error.
KICKASS_CRYPTO_EXIT_EXCEPTION  = 82
2023-04-05 jj5 - the error level to return when the program exits due to an exception.
KICKASS_CRYPTO_EXIT_FILE_MISSING  = 61
2023-04-05 jj5 - the error level to return when a file is missing.
KICKASS_CRYPTO_EXIT_HELP  = 99
2023-04-05 jj5 - the error level to return when help (or version) has been requested; this is not an error but it does return a non-zero error level for safety.
KICKASS_CRYPTO_EXIT_INVALID  = 89
2023-04-05 jj5 - the error level to return when the program tries to exit with an invalid error level.
KICKASS_CRYPTO_EXIT_OPTIONS_LISTED  = 98
2023-04-05 jj5 - the error level to return when program options have been requested; this is not an error but it does return a non-zero error level for safety.
KICKASS_CRYPTO_EXIT_PROBLEM  = 80
2023-04-05 jj5 - the error level to return when there's a problem with the program.
KICKASS_CRYPTO_EXIT_SUCCESS  = 0
2023-04-05 jj5 - the error level to return upon success.
KICKASS_CRYPTO_EXIT_TEST_FAILED  = 84
2023-04-05 jj5 - the error level to return when a unit-test failed.
kickass_crypto_exit()  : void
2023-04-05 jj5 - this function will exit the process with a suitable error level.

Constants

KICKASS_CRYPTO_EXIT_HELP

2023-04-05 jj5 - the error level to return when help (or version) has been requested; this is not an error but it does return a non-zero error level for safety.

public int KICKASS_CRYPTO_EXIT_HELP = 99
Tags
link
https://www.jj5.net/sixsigma/Error_levels#99

KICKASS_CRYPTO_EXIT_OPTIONS_LISTED

2023-04-05 jj5 - the error level to return when program options have been requested; this is not an error but it does return a non-zero error level for safety.

public int KICKASS_CRYPTO_EXIT_OPTIONS_LISTED = 98
Tags
link
https://www.jj5.net/sixsigma/Error_levels#98

KICKASS_CRYPTO_EXIT_SUCCESS

2023-04-05 jj5 - the error level to return upon success.

public int KICKASS_CRYPTO_EXIT_SUCCESS = 0

Functions

kickass_crypto_exit()

2023-04-05 jj5 - this function will exit the process with a suitable error level.

kickass_crypto_exit([int|Exception $error = KICKASS_CRYPTO_EXIT_SUCCESS ][, int $default = KICKASS_CRYPTO_EXIT_PROBLEM ]) : void
Parameters
$error : int|Exception = KICKASS_CRYPTO_EXIT_SUCCESS

either the integer error level or an exception.

$default : int = KICKASS_CRYPTO_EXIT_PROBLEM

the error level to use if $error is not valid.

Return values
void

Search results