Docs For Class Zend_Controller_Plugin

Description

Handle exceptions that bubble up based on missing controllers, actions, or application errors, and forward to an error handler.

version: $Id: ErrorHandler.php 20246 2010-01-12 21:36:08Z dasprid $
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
uses: Zend_Controller_Plugin_Abstract
license: New BSD License

Located in /Controller/Plugin/ErrorHandler.php (line 37)

Zend_Controller_Plugin_Abstract
   |
   --Zend_Controller_Plugin_ErrorHandler

Class Constant Summary

EXCEPTION_NO_ACTION = 'EXCEPTION_NO_ACTION'

EXCEPTION_NO_CONTROLLER = 'EXCEPTION_NO_CONTROLLER'

EXCEPTION_NO_ROUTE = 'EXCEPTION_NO_ROUTE'

EXCEPTION_OTHER = 'EXCEPTION_OTHER'

Variable Summary

string $_errorAction

string $_errorController

string $_errorModule

int $_exceptionCountAtFirstEncounter

bool $_isInsideErrorHandlerLoop

Method Summary

void __construct ([ $options = array()])

string getErrorHandlerAction ()

string getErrorHandlerController ()

string getErrorHandlerModule ()

void postDispatch (Zend_Controller_Request_Abstract $request)

void routeShutdown (Zend_Controller_Request_Abstract $request)

Zend_Controller_Plugin_ErrorHandler setErrorHandler ([ $options = array()])

Zend_Controller_Plugin_ErrorHandler setErrorHandlerAction (string $action)

Zend_Controller_Plugin_ErrorHandler setErrorHandlerController (string $controller)

Zend_Controller_Plugin_ErrorHandler setErrorHandlerModule (string $module)

void _handleError (Zend_Controller_Request_Abstract $request)

Variables

string $_errorAction = 'error' (line 75)

Action to use for errors; defaults to 'error'

access: protected

string $_errorController = 'error' (line 69)

Controller to use for errors; defaults to 'error'

access: protected

string $_errorModule (line 63)

Module to use for errors; defaults to default module in dispatcher

access: protected

int $_exceptionCountAtFirstEncounter = 0 (line 87)

Exception count logged at first invocation of plugin

access: protected

bool $_isInsideErrorHandlerLoop = false (line 81)

Flag; are we already inside the error handler loop?

access: protected

Inherited Variables

Inherited from Zend_Controller_Plugin_Abstract

Zend_Controller_Plugin_Abstract::$_request
Zend_Controller_Plugin_Abstract::$_response

Methods

Constructor __construct (line 100)

Constructor

Options may include:

module
controller
action

access: public

void __construct ([ $options = array()])

Array $options

getErrorHandlerAction (line 189)

Retrieve the current error handler action

access: public

string getErrorHandlerAction ()

getErrorHandlerController (line 167)

Retrieve the current error handler controller

access: public

string getErrorHandlerController ()

getErrorHandlerModule (line 142)

Retrieve the current error handler module

access: public

string getErrorHandlerModule ()

postDispatch (line 210)

Post dispatch hook -- check for exceptions and dispatch error handler if necessary

access: public

void postDispatch (Zend_Controller_Request_Abstract $request)

Zend_Controller_Request_Abstract $request

Redefinition of:

Zend_Controller_Plugin_Abstract::postDispatch(): Called after an action is dispatched by Zend_Controller_Dispatcher.

routeShutdown (line 199)

Route shutdown hook -- Ccheck for router exceptions

access: public

void routeShutdown (Zend_Controller_Request_Abstract $request)

Zend_Controller_Request_Abstract $request

Redefinition of:

Zend_Controller_Plugin_Abstract::routeShutdown(): Called after Zend_Controller_Router exits.

setErrorHandler (line 111)

setErrorHandler() - setup the error handling options

access: public

Zend_Controller_Plugin_ErrorHandler setErrorHandler ([ $options = array()])

array $options

setErrorHandlerAction (line 178)

Set the action name for the error handler

access: public

Zend_Controller_Plugin_ErrorHandler setErrorHandlerAction (string $action)

string $action

setErrorHandlerController (line 156)

Set the controller name for the error handler

access: public

Zend_Controller_Plugin_ErrorHandler setErrorHandlerController (string $controller)

string $controller

setErrorHandlerModule (line 131)

Set the module name for the error handler

access: public

Zend_Controller_Plugin_ErrorHandler setErrorHandlerModule (string $module)

string $module

_handleError (line 224)

Handle errors and exceptions

If the 'noErrorHandler' front controller flag has been set, returns early.

access: protected

void _handleError (Zend_Controller_Request_Abstract $request)

Zend_Controller_Request_Abstract $request

Inherited Methods

Inherited From Zend_Controller_Plugin_Abstract

Zend_Controller_Plugin_Abstract::dispatchLoopShutdown()
Zend_Controller_Plugin_Abstract::dispatchLoopStartup()
Zend_Controller_Plugin_Abstract::getRequest()
Zend_Controller_Plugin_Abstract::getResponse()
Zend_Controller_Plugin_Abstract::postDispatch()
Zend_Controller_Plugin_Abstract::preDispatch()
Zend_Controller_Plugin_Abstract::routeShutdown()
Zend_Controller_Plugin_Abstract::routeStartup()
Zend_Controller_Plugin_Abstract::setRequest()
Zend_Controller_Plugin_Abstract::setResponse()

Class Constants

EXCEPTION_NO_ACTION = 'EXCEPTION_NO_ACTION' (line 47)

Const - No action exception; controller exists, but action does not

EXCEPTION_NO_CONTROLLER = 'EXCEPTION_NO_CONTROLLER' (line 42)

Const - No controller exception; controller does not exist

EXCEPTION_NO_ROUTE = 'EXCEPTION_NO_ROUTE' (line 52)

Const - No route exception; no routing was possible

EXCEPTION_OTHER = 'EXCEPTION_OTHER' (line 57)

Const - Other Exception; exceptions thrown by application controllers