class-evf-logger-interface.php
138 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Logger Interface |
| 4 | * |
| 5 | * @version 1.0.0 |
| 6 | * @package EverestForms/Interface |
| 7 | */ |
| 8 | |
| 9 | defined( 'ABSPATH' ) || exit; |
| 10 | |
| 11 | /** |
| 12 | * EVF Logger Interface |
| 13 | * |
| 14 | * Functions that must be defined to correctly fulfill logger API. |
| 15 | * |
| 16 | * @version 1.0.0 |
| 17 | */ |
| 18 | interface EVF_Logger_Interface { |
| 19 | |
| 20 | /** |
| 21 | * Add a log entry. |
| 22 | * |
| 23 | * This is not the preferred method for adding log messages. Please use log() or any one of |
| 24 | * the level methods (debug(), info(), etc.). This method may be deprecated in the future. |
| 25 | * |
| 26 | * @param string $handle File handle. |
| 27 | * @param string $message Log message. |
| 28 | * @param string $level Log level. |
| 29 | * |
| 30 | * @return bool True if log was added, otherwise false. |
| 31 | */ |
| 32 | public function add( $handle, $message, $level = EVF_Log_Levels::NOTICE ); |
| 33 | |
| 34 | /** |
| 35 | * Add a log entry. |
| 36 | * |
| 37 | * @param string $level One of the following: |
| 38 | * 'emergency': System is unusable. |
| 39 | * 'alert': Action must be taken immediately. |
| 40 | * 'critical': Critical conditions. |
| 41 | * 'error': Error conditions. |
| 42 | * 'warning': Warning conditions. |
| 43 | * 'notice': Normal but significant condition. |
| 44 | * 'info': Informational messages. |
| 45 | * 'debug': Debug-level messages. |
| 46 | * @param string $message Log message. |
| 47 | * @param array $context Optional. Additional information for log handlers. |
| 48 | */ |
| 49 | public function log( $level, $message, $context = array() ); |
| 50 | |
| 51 | /** |
| 52 | * Adds an emergency level message. |
| 53 | * |
| 54 | * System is unusable. |
| 55 | * |
| 56 | * @param string $message Log message. |
| 57 | * @param array $context Optional. Additional information for log handlers. |
| 58 | */ |
| 59 | public function emergency( $message, $context = array() ); |
| 60 | |
| 61 | /** |
| 62 | * Adds an alert level message. |
| 63 | * |
| 64 | * Action must be taken immediately. |
| 65 | * Example: Entire website down, database unavailable, etc. |
| 66 | * |
| 67 | * @param string $message Log message. |
| 68 | * @param array $context Optional. Additional information for log handlers. |
| 69 | */ |
| 70 | public function alert( $message, $context = array() ); |
| 71 | |
| 72 | /** |
| 73 | * Adds a critical level message. |
| 74 | * |
| 75 | * Critical conditions. |
| 76 | * Example: Application component unavailable, unexpected exception. |
| 77 | * |
| 78 | * @param string $message Log message. |
| 79 | * @param array $context Optional. Additional information for log handlers. |
| 80 | */ |
| 81 | public function critical( $message, $context = array() ); |
| 82 | |
| 83 | /** |
| 84 | * Adds an error level message. |
| 85 | * |
| 86 | * Runtime errors that do not require immediate action but should typically be logged |
| 87 | * and monitored. |
| 88 | * |
| 89 | * @param string $message Log message. |
| 90 | * @param array $context Optional. Additional information for log handlers. |
| 91 | */ |
| 92 | public function error( $message, $context = array() ); |
| 93 | |
| 94 | /** |
| 95 | * Adds a warning level message. |
| 96 | * |
| 97 | * Exceptional occurrences that are not errors. |
| 98 | * |
| 99 | * Example: Use of deprecated APIs, poor use of an API, undesirable things that are not |
| 100 | * necessarily wrong. |
| 101 | * |
| 102 | * @param string $message Log message. |
| 103 | * @param array $context Optional. Additional information for log handlers. |
| 104 | */ |
| 105 | public function warning( $message, $context = array() ); |
| 106 | |
| 107 | /** |
| 108 | * Adds a notice level message. |
| 109 | * |
| 110 | * Normal but significant events. |
| 111 | * |
| 112 | * @param string $message Log message. |
| 113 | * @param array $context Optional. Additional information for log handlers. |
| 114 | */ |
| 115 | public function notice( $message, $context = array() ); |
| 116 | |
| 117 | /** |
| 118 | * Adds a info level message. |
| 119 | * |
| 120 | * Interesting events. |
| 121 | * Example: User logs in, SQL logs. |
| 122 | * |
| 123 | * @param string $message Log message. |
| 124 | * @param array $context Optional. Additional information for log handlers. |
| 125 | */ |
| 126 | public function info( $message, $context = array() ); |
| 127 | |
| 128 | /** |
| 129 | * Adds a debug level message. |
| 130 | * |
| 131 | * Detailed debug information. |
| 132 | * |
| 133 | * @param string $message Log message. |
| 134 | * @param array $context Optional. Additional information for log handlers. |
| 135 | */ |
| 136 | public function debug( $message, $context = array() ); |
| 137 | } |
| 138 |