Class \Prado\Exceptions\TErrorHandler

TErrorHandler class

TErrorHandler handles all PHP user errors and exceptions generated during servicing user requests. It displays these errors using different templates and if possible, using languages preferred by the client user. Note, PHP parsing errors cannot be caught and handled by TErrorHandler.

The templates used to format the error output are stored under Prado\Exceptions. You may choose to use your own templates, should you not like the templates provided by Prado. Simply set \Prado\Exceptions\setErrorTemplatePath to the path (in namespace format) storing your own templates.

There are two sets of templates, one for errors to be displayed to client users (called external errors), one for errors to be displayed to system developers (called internal errors). The template file name for the former is error[StatusCode][-LanguageCode].html, and for the latter it is exception[-LanguageCode].html, where StatusCode refers to response status code (e.g. 404, 500) specified when THttpException is thrown, and LanguageCode is the client user preferred language code (e.g. en, zh, de). The templates error.html and exception.html are default ones that are used if no other appropriate templates are available. Note, these templates are not Prado control templates. They are simply html files with keywords (e.g. %%ErrorMessage%%, %%Version%%) to be replaced with the corresponding information.

By default, TErrorHandler is registered with TApplication as the error handler module. It can be accessed via TApplication::getErrorHandler(). You seldom need to deal with the error handler directly. It is mainly used by the application object to handle errors.

TErrorHandler may be configured in application configuration file as follows <module id="error" class="TErrorHandler" ErrorTemplatePath="Prado\Exceptions" />

Class hierarchy

\Prado\Exceptions\TErrorHandler

\Prado\TModule implements IModule

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`getErrorTemplatePath() : string`
`public`	`handleError(mixed $sender, mixed $param) : mixed` Handles PHP user errors and exceptions. This is the event handler responding to the Error event raised in TApplication. The method mainly uses appropriate template to display the error/exception. It terminates the application immediately after the error is displayed.
`public`	`init(TXmlElement $config) : mixed` Initializes the module. This method is required by IModule and is invoked by application.
`public`	`setErrorTemplatePath(string $value) : mixed` Sets the path storing all error and exception template files. The path must be in namespace format, such as Prado\Exceptions (which is the default).
`protected`	`displayException(Exception $exception) : mixed` Displays exception information. Exceptions are displayed with rich context information, including the call stack and the context source code. This method is only invoked when application is in Debug mode.
`protected`	`getErrorTemplate(int $statusCode, Exception $exception) : string` Retrieves the template used for displaying external exceptions. External exceptions are those displayed to end-users. They do not contain error source code. Therefore, you might want to override this method to provide your own error template for displaying certain external exceptions. The following tokens in the template will be replaced with corresponding content: %%StatusCode%% : the status code of the exception %%ErrorMessage%% : the error message (HTML encoded). %%ErrorCode%% : the exception error code. %%ServerAdmin%% : the server admin information (retrieved from Web server configuration) %%Version%% : the version information of the Web server. %%Time%% : the time the exception occurs at
`protected`	`getExceptionTemplate(Exception $exception) : string` Retrieves the template used for displaying internal exceptions. Internal exceptions will be displayed with source code causing the exception. This occurs when the application is in debug mode.
`protected`	`handleExternalError(int $statusCode, Exception $exception) : mixed` Displays error to the client user. THttpException and errors happened when the application is in Debug mode will be displayed to the client user.
`protected`	`handleRecursiveError(Exception $exception) : mixed` Handles error occurs during error handling (called recursive error). THttpException and errors happened when the application is in Debug mode will be displayed to the client user. Error is displayed without using existing template to prevent further errors.
`protected`	`hidePrivatePathParts(mixed $value) : mixed`
`protected static`	`hideSecurityRelated(string $value[, null\|Exception $exception = null ]) : string`
`private`	`addLink(mixed $message) : mixed`
`private`	`getErrorClassNameSpace(mixed $message) : mixed`
`private`	`getExactTrace(mixed $exception) : mixed`
`private`	`getExactTraceAsString(mixed $exception) : mixed`
`private`	`getPropertyAccessTrace(mixed $trace, mixed $pattern) : mixed`
`private`	`getSourceCode(mixed $lines, mixed $errorLine) : mixed`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getApplication, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getID, getListeningToGlobalEvents, getRequest, getResponse, getService, getSession, getSubProperty, getUser, hasEvent, hasEventHandler, hasMethod, hasProperty, init, isa, listen, publishAsset, publishFilePath, raiseEvent, setID, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Constants summary
`public mixed`	`ERROR_FILE_NAME` error template file basename	`'error'`
`public mixed`	`EXCEPTION_FILE_NAME` exception template file basename	`'exception'`
`public mixed`	`FATAL_ERROR_TRACE_DROP_LINES` number of prado internal function calls to be dropped from stack traces on fatal errors	`5`
`public mixed`	`SOURCE_LINES` number of lines before and after the error line to be displayed in case of an exception	`12`

Inherited constants
`\Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Exceptions\TErrorHandler

Class hierarchy