Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Handle exceptions that bubble up based on missing controllers, actions, or application errors, and forward to an error handler.
EXCEPTION_NO_CONTROLLER
= 'EXCEPTION_NO_CONTROLLER'
Const - No controller exception; controller does not exist
EXCEPTION_NO_ACTION
= 'EXCEPTION_NO_ACTION'
Const - No action exception; controller exists, but action does not

string
$_errorAction= 'error'
Action to use for errors; defaults to 'error'
error
Details
string
$_errorController= 'error'
Controller to use for errors; defaults to 'error'
error
Details
string
$_errorModule= ''
Module to use for errors; defaults to default module in dispatcher

int
$_exceptionCountAtFirstEncounter= '0'
Exception count logged at first invocation of plugin
0
Details
__construct(
Array $options
=
array
)
:
void
Constructor
Options may include: - module - controller - action
Name | Type | Description |
---|---|---|
$options | Array |

_handleError(
\Zend_Controller_Request_Abstract $request
)
:
void
Handle errors and exceptions
If the 'noErrorHandler' front controller flag has been set, returns early.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |

dispatchLoopShutdown(
)
:
void
Called before Zend_Controller_Front exits its dispatch loop.
Inherited from: \Zend_Controller_Plugin_Abstract::dispatchLoopShutdown()
dispatchLoopStartup(
\Zend_Controller_Request_Abstract $request
)
:
void
Called before Zend_Controller_Front enters its dispatch loop.
Inherited from: \Zend_Controller_Plugin_Abstract::dispatchLoopStartup()Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |

getErrorHandlerAction(
)
:
string
Retrieve the current error handler action
Type | Description |
---|---|
string |

getErrorHandlerController(
)
:
string
Retrieve the current error handler controller
Type | Description |
---|---|
string |

getErrorHandlerModule(
)
:
string
Retrieve the current error handler module
Type | Description |
---|---|
string |

getRequest(
)
:
\Zend_Controller_Request_Abstract
Get request object
Inherited from: \Zend_Controller_Plugin_Abstract::getRequest()Type | Description |
---|---|
\Zend_Controller_Request_Abstract | $request |

getResponse(
)
:
\Zend_Controller_Response_Abstract
Get response object
Inherited from: \Zend_Controller_Plugin_Abstract::getResponse()Type | Description |
---|---|
\Zend_Controller_Response_Abstract | $response |

postDispatch(
\Zend_Controller_Request_Abstract $request
)
:
void
Post dispatch hook -- check for exceptions and dispatch error handler if necessary
This callback allows for proxy or filter behavior. By altering the request and resetting its dispatched flag (via {@link Zend_Controller_Request_Abstract::setDispatched() setDispatched(false)}), a new action may be specified for dispatching.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |

preDispatch(
\Zend_Controller_Request_Abstract $request
)
:
void
Pre dispatch hook -- check for exceptions and dispatch error handler if necessary
This callback allows for proxy or filter behavior. By altering the request and resetting its dispatched flag (via {@link Zend_Controller_Request_Abstract::setDispatched() setDispatched(false)}), the current action may be skipped.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |

routeShutdown(
\Zend_Controller_Request_Abstract $request
)
:
void
Route shutdown hook -- Ccheck for router exceptions
Called after Zend_Controller_Front exits from the router.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |

routeStartup(
\Zend_Controller_Request_Abstract $request
)
:
void
Called before Zend_Controller_Front begins evaluating the request against its routes.
Inherited from: \Zend_Controller_Plugin_Abstract::routeStartup()Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |

setErrorHandler(
array $options
=
array
)
:
\Zend_Controller_Plugin_ErrorHandler
setErrorHandler() - setup the error handling options
Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Controller_Plugin_ErrorHandler |

setErrorHandlerAction(
string $action
)
:
\Zend_Controller_Plugin_ErrorHandler
Set the action name for the error handler
Name | Type | Description |
---|---|---|
$action | string |
Type | Description |
---|---|
\Zend_Controller_Plugin_ErrorHandler |

setErrorHandlerController(
string $controller
)
:
\Zend_Controller_Plugin_ErrorHandler
Set the controller name for the error handler
Name | Type | Description |
---|---|---|
$controller | string |
Type | Description |
---|---|
\Zend_Controller_Plugin_ErrorHandler |

setErrorHandlerModule(
string $module
)
:
\Zend_Controller_Plugin_ErrorHandler
Set the module name for the error handler
Name | Type | Description |
---|---|---|
$module | string |
Type | Description |
---|---|
\Zend_Controller_Plugin_ErrorHandler |

setRequest(
\Zend_Controller_Request_Abstract $request
)
:
\Zend_Controller_Plugin_Abstract
Set request object
Inherited from: \Zend_Controller_Plugin_Abstract::setRequest()Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Abstract |
Type | Description |
---|---|
\Zend_Controller_Plugin_Abstract |

setResponse(
\Zend_Controller_Response_Abstract $response
)
:
\Zend_Controller_Plugin_Abstract
Set response object
Inherited from: \Zend_Controller_Plugin_Abstract::setResponse()Name | Type | Description |
---|---|---|
$response | \Zend_Controller_Response_Abstract |
Type | Description |
---|---|
\Zend_Controller_Plugin_Abstract |