Controller/Plugin/ErrorHandler.php

Show:

inherited

Classes
- \Zend_Controller_Plugin_ErrorHandler

Table of Contents

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Controller
Subpackage: Plugins

\Zend_Controller_Plugin_ErrorHandler
jump to top

Package: Zend\Controller\Plugins

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

Parent(s): \Zend_Controller_Plugin_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Uses: \global\Zend_Controller_Plugin_Abstract
Version: $Id: ErrorHandler.php 24593 2012-01-05 20:35:02Z matthew $

Constants

 
                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

 
                EXCEPTION_NO_ROUTE
                = 'EXCEPTION_NO_ROUTE'

Const - No route exception; no routing was possible

 
                EXCEPTION_OTHER
                = 'EXCEPTION_OTHER'

Const - Other Exception; exceptions thrown by application controllers

Properties

string $_errorAction = 'error'

Action to use for errors; defaults to 'error'

Default value'error'Details

Type: string

string $_errorController = 'error'

Controller to use for errors; defaults to 'error'

Default value'error'Details

Type: string

string $_errorModule =

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

Details

Type: string

int $_exceptionCountAtFirstEncounter = 0

Exception count logged at first invocation of plugin

Default value0Details

Type: int

bool $_isInsideErrorHandlerLoop = false

Flag; are we already inside the error handler loop?

Default valuefalseDetails

Type: bool

\Zend_Controller_Request_Abstract $_request =

inherited

Inherited from: \Zend_Controller_Plugin_Abstract::$$_request

Details

Type: \Zend_Controller_Request_Abstract
Inherited_from: \Zend_Controller_Plugin_Abstract::$$_request

\Zend_Controller_Response_Abstract $_response =

inherited

Inherited from: \Zend_Controller_Plugin_Abstract::$$_response

Details

Type: \Zend_Controller_Response_Abstract
Inherited_from: \Zend_Controller_Plugin_Abstract::$$_response

Methods

__construct(Array $options = array()) : void

Constructor

Options may include: - module - controller - action

Parameters

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.

Parameters

Name	Type	Description
$request	\Zend_Controller_Request_Abstract

dispatchLoopShutdown() : void

inherited

Called before Zend_Controller_Front exits its dispatch loop.

Inherited from: \Zend_Controller_Plugin_Abstract::dispatchLoopShutdown()

dispatchLoopStartup(\Zend_Controller_Request_Abstract $request) : void

inherited

Called before Zend_Controller_Front enters its dispatch loop.

Inherited from: \Zend_Controller_Plugin_Abstract::dispatchLoopStartup()

Parameters

Name	Type	Description
$request	\Zend_Controller_Request_Abstract

getErrorHandlerAction() : string

Retrieve the current error handler action

Returns

Type	Description
string

getErrorHandlerController() : string

Retrieve the current error handler controller

Returns

Type	Description
string

getErrorHandlerModule() : string

Retrieve the current error handler module

Returns

Type	Description
string

getRequest() : \Zend_Controller_Request_Abstract

inherited

Get request object

Inherited from: \Zend_Controller_Plugin_Abstract::getRequest()

Returns

Type	Description
\Zend_Controller_Request_Abstract	$request

getResponse() : \Zend_Controller_Response_Abstract

inherited

Get response object

Inherited from: \Zend_Controller_Plugin_Abstract::getResponse()

Returns

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 setDispatched(false)), a new action may be specified for dispatching.

Parameters

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 setDispatched(false)), the current action may be skipped.

Parameters

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.

Parameters

Name	Type	Description
$request	\Zend_Controller_Request_Abstract

routeStartup(\Zend_Controller_Request_Abstract $request) : void

inherited

Called before Zend_Controller_Front begins evaluating the request against its routes.

Inherited from: \Zend_Controller_Plugin_Abstract::routeStartup()

Parameters

Name	Type	Description
$request	\Zend_Controller_Request_Abstract

setErrorHandler(array $options = array()) : \Zend_Controller_Plugin_ErrorHandler

setErrorHandler() - setup the error handling options

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Controller_Plugin_ErrorHandler

setErrorHandlerAction(string $action) : \Zend_Controller_Plugin_ErrorHandler

Set the action name for the error handler

Parameters

Name	Type	Description
$action	string

Returns

Type	Description
\Zend_Controller_Plugin_ErrorHandler

setErrorHandlerController(string $controller) : \Zend_Controller_Plugin_ErrorHandler

Set the controller name for the error handler

Parameters

Name	Type	Description
$controller	string

Returns

Type	Description
\Zend_Controller_Plugin_ErrorHandler

setErrorHandlerModule(string $module) : \Zend_Controller_Plugin_ErrorHandler

Set the module name for the error handler

Parameters

Name	Type	Description
$module	string

Returns

Type	Description
\Zend_Controller_Plugin_ErrorHandler

setRequest(\Zend_Controller_Request_Abstract $request) : \Zend_Controller_Plugin_Abstract

inherited

Set request object

Inherited from: \Zend_Controller_Plugin_Abstract::setRequest()

Parameters

Name	Type	Description
$request	\Zend_Controller_Request_Abstract

Returns

Type	Description
\Zend_Controller_Plugin_Abstract

setResponse(\Zend_Controller_Response_Abstract $response) : \Zend_Controller_Plugin_Abstract

inherited

Set response object

Inherited from: \Zend_Controller_Plugin_Abstract::setResponse()

Parameters

Name	Type	Description
$response	\Zend_Controller_Response_Abstract

Returns

Type	Description
\Zend_Controller_Plugin_Abstract

Controller/Plugin/ErrorHandler.php

\Zend_Controller_Plugin_ErrorHandlerjump to top

Constants

Properties

Methods

\Zend_Controller_Plugin_ErrorHandler
jump to top