123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115 |
- <?php
- /**
- * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
- * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
- *
- * Licensed under The MIT License
- * Redistributions of files must retain the above copyright notice.
- *
- * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
- * @since 3.0.0
- * @license https://opensource.org/licenses/mit-license.php MIT License
- */
- namespace Cake\Core\Exception;
- use RuntimeException;
- /**
- * Base class that all CakePHP Exceptions extend.
- */
- class Exception extends RuntimeException
- {
- /**
- * Array of attributes that are passed in from the constructor, and
- * made available in the view when a development error is displayed.
- *
- * @var array
- */
- protected $_attributes = [];
- /**
- * Template string that has attributes sprintf()'ed into it.
- *
- * @var string
- */
- protected $_messageTemplate = '';
- /**
- * Array of headers to be passed to Cake\Http\Response::header()
- *
- * @var array|null
- */
- protected $_responseHeaders;
- /**
- * Default exception code
- *
- * @var int
- */
- protected $_defaultCode = 500;
- /**
- * Constructor.
- *
- * Allows you to create exceptions that are treated as framework errors and disabled
- * when debug = 0.
- *
- * @param string|array $message Either the string of the error message, or an array of attributes
- * that are made available in the view, and sprintf()'d into Exception::$_messageTemplate
- * @param int|null $code The code of the error, is also the HTTP status code for the error.
- * @param \Exception|null $previous the previous exception.
- */
- public function __construct($message = '', $code = null, $previous = null)
- {
- if ($code === null) {
- $code = $this->_defaultCode;
- }
- if (is_array($message)) {
- $this->_attributes = $message;
- $message = vsprintf($this->_messageTemplate, $message);
- }
- parent::__construct($message, $code, $previous);
- }
- /**
- * Get the passed in attributes
- *
- * @return array
- */
- public function getAttributes()
- {
- return $this->_attributes;
- }
- /**
- * Get/set the response header to be used
- *
- * See also Cake\Http\Response::withHeader()
- *
- * @param string|array|null $header An array of header strings or a single header string
- * - an associative array of "header name" => "header value"
- * - an array of string headers is also accepted (deprecated)
- * @param string|null $value The header value.
- * @return array
- */
- public function responseHeader($header = null, $value = null)
- {
- if ($header === null) {
- return $this->_responseHeaders;
- }
- if (is_array($header)) {
- if (isset($header[0])) {
- deprecationWarning(
- 'Passing a list string headers to Exception::responseHeader() is deprecated. ' .
- 'Use an associative array instead.'
- );
- }
- return $this->_responseHeaders = $header;
- }
- $this->_responseHeaders = [$header => $value];
- }
- }
|