|
164 | 164 | * - `trace` - boolean - Whether or not backtraces should be included in |
165 | 165 | * logged errors/exceptions. |
166 | 166 | * - `log` - boolean - Whether or not you want exceptions logged. |
167 | | - * - `exceptionRenderer` - string - The class responsible for rendering |
168 | | - * uncaught exceptions. If you choose a custom class you should place |
169 | | - * the file for that class in src/Error. This class needs to implement a |
170 | | - * render method. |
| 167 | + * - `exceptionRenderer` - string - The class responsible for rendering uncaught exceptions. |
| 168 | + * The chosen class will be used for for both CLI and web environments. If you want different |
| 169 | + * classes used in CLI and web environments you'll need to write that conditional logic as well. |
| 170 | + * The conventional location for custom renderers is in `src/Error`. Your exception renderer needs to |
| 171 | + * implement the `render()` method and return either a string or Http\Response. |
| 172 | + * `errorRenderer` - string - The class responsible for rendering PHP errors. The selected |
| 173 | + * class will be used for both web and CLI contexts. If you want different classes for each environment |
| 174 | + * you'll need to write that conditional logic as well. Error renderers need to |
| 175 | + * to implement the `Cake\Error\ErrorRendererInterface`. |
171 | 176 | * - `skipLog` - array - List of exceptions to skip for logging. Exceptions that |
172 | 177 | * extend one of the listed exceptions will also be skipped for logging. |
173 | 178 | * E.g.: |
174 | 179 | * `'skipLog' => ['Cake\Http\Exception\NotFoundException', 'Cake\Http\Exception\UnauthorizedException']` |
175 | | - * - `extraFatalErrorMemory` - int - The number of megabytes to increase |
176 | | - * the memory limit by when a fatal error is encountered. This allows |
| 180 | + * - `extraFatalErrorMemory` - int - The number of megabytes to increase the memory limit by |
| 181 | + * when a fatal error is encountered. This allows |
177 | 182 | * breathing room to complete logging or error handling. |
178 | 183 | * - `ignoredDeprecationPaths` - array - A list of glob compatible file paths that deprecations |
179 | 184 | * should be ignored in. Use this to ignore deprecations for plugins or parts of |
180 | 185 | * your application that still emit deprecations. |
181 | 186 | */ |
182 | 187 | 'Error' => [ |
183 | 188 | 'errorLevel' => E_ALL, |
184 | | - 'exceptionRenderer' => ExceptionRenderer::class, |
185 | 189 | 'skipLog' => [], |
186 | 190 | 'log' => true, |
187 | 191 | 'trace' => true, |
|
0 commit comments