Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Pulling exception page rendering out into a separate class, ErrorHand…
…ler felt very large and confusing, as it had a few too many jobs.
  • Loading branch information
markstory committed Nov 26, 2010
1 parent 8a35b76 commit e2c8e20
Show file tree
Hide file tree
Showing 4 changed files with 809 additions and 564 deletions.
185 changes: 3 additions & 182 deletions cake/libs/error_handler.php
Expand Up @@ -54,127 +54,25 @@
*/
class ErrorHandler {

/**
* Controller instance.
*
* @var Controller
* @access public
*/
public $controller = null;

/**
* template to render for CakeException
*
* @var string
*/
public $template = '';

/**
* The method corresponding to the Exception this object is for.
*
* @var string
*/
public $method = '';

/**
* The exception being handled.
*
* @var Exception
*/
public $error = null;

/**
* Creates the controller to perform rendering on the error response.
* If the error is a CakeException it will be converted to either a 400 or a 500
* code error depending on the code used to construct the error.
*
* @param string $method Method producing the error
* @param array $messages Error messages
*/
function __construct(Exception $exception) {
App::import('Core', 'Sanitize');

$this->controller = $this->_getController($exception);

if (method_exists($this->controller, 'apperror')) {
return $this->controller->appError($exception);
}
$method = $template = Inflector::variable(str_replace('Exception', '', get_class($exception)));
$code = $exception->getCode();

$methodExists = method_exists($this, $method);

if ($exception instanceof CakeException && !$methodExists) {
$method = '_cakeError';
if ($template == 'internalError') {
$template = 'error500';
}
} elseif (!$methodExists) {
$method = 'error500';
if ($code >= 400) {
$method = 'error400';
}
}

if (Configure::read('debug') == 0) {
$parentClass = get_parent_class($this);
if ($parentClass != 'ErrorHandler') {
$method = 'error400';
}
$parentMethods = (array)get_class_methods($parentClass);
if (in_array($method, $parentMethods)) {
$method = 'error400';
}
if ($code == 500) {
$method = 'error500';
}
}
$this->template = $template;
$this->method = $method;
$this->error = $exception;
}

/**
* Get the controller instance to handle the exception.
* Override this method in subclasses to customize the controller used.
* This method returns the built in `CakeErrorController` normally, or if an error is repeated
* a bare controller will be used.
*
* @param Exception $exception The exception to get a controller for.
* @return Controller
*/
protected function _getController($exception) {
static $__previousError = null;
App::import('Controller', 'CakeError');

if ($__previousError != $exception) {
$__previousError = $exception;
$controller = new CakeErrorController();
} else {
$controller = new Controller();
$controller->viewPath = 'errors';
}
return $controller;
}

/**
* Set as the default exception handler by the CakePHP bootstrap process.
*
* This will either use an AppError class if your application has one,
* or use the default ErrorHandler.
* or use the default ExceptionRenderer.
*
* @return void
* @see http://php.net/manual/en/function.set-exception-handler.php
*/
public static function handleException(Exception $exception) {
App::import('Core', 'ExceptionRenderer');
if (file_exists(APP . 'app_error.php') || class_exists('AppError')) {
if (!class_exists('AppError')) {
require(APP . 'app_error.php');
}
$AppError = new AppError($exception);
return $AppError->render();
}
$error = new ErrorHandler($exception);
$error = new ExceptionRenderer($exception);
$error->render();
}

Expand Down Expand Up @@ -271,81 +169,4 @@ protected static function _mapErrorCode($code) {
}
return array($error, $log);
}

/**
* Renders the response for the exception.
*
* @return void
*/
public function render() {
call_user_func_array(array($this, $this->method), array($this->error));
}

/**
* Generic handler for the internal framework errors CakePHP can generate.
*
* @param CakeExeption $error
* @return void
*/
protected function _cakeError(CakeException $error) {
$url = Router::normalize($this->controller->request->here);
$code = $error->getCode();
$this->controller->response->statusCode($code);
$this->controller->set(array(
'code' => $code,
'url' => h($url),
'name' => $error->getMessage(),
'error' => $error,
));
$this->controller->set($error->getAttributes());
$this->_outputMessage($this->template);
}

/**
* Convenience method to display a 400 series page.
*
* @param array $params Parameters for controller
*/
public function error400($error) {
$message = $error->getMessage();
if (Configure::read('debug') == 0 && $error instanceof CakeException) {
$message = __('Not Found');
}
$url = Router::normalize($this->controller->request->here);
$this->controller->response->statusCode($error->getCode());
$this->controller->set(array(
'name' => $message,
'url' => h($url),
'error' => $error,
));
$this->_outputMessage('error400');
}

/**
* Convenience method to display a 500 page.
*
* @param array $params Parameters for controller
*/
public function error500($error) {
$url = Router::normalize($this->controller->request->here);
$code = ($error->getCode() > 500) ? $error->getCode() : 500;
$this->controller->response->statusCode($code);
$this->controller->set(array(
'name' => __('An Internal Error Has Occurred'),
'message' => h($url),
'error' => $error,
));
$this->_outputMessage('error500');
}

/**
* Generate the response using the controller object.
*
* @param string $template The template to render.
*/
protected function _outputMessage($template) {
$this->controller->render($template);
$this->controller->afterFilter();
$this->controller->response->send();
}
}

0 comments on commit e2c8e20

Please sign in to comment.