1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 <?php
/*-----8<--------------------------------------------------------------------
*
* BEdita - a semantic content management framework
*
* Copyright 2016 ChannelWeb Srl, Chialab Srl
*
* This file is part of BEdita: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* BEdita is distributed WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with BEdita (see LICENSE.LGPL).
* If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
*
*------------------------------------------------------------------->8-----
*/
/**
* Default Error Code object.
*
* It is responsible for:
*
* - check if the error code passed is valid (fallback on GENERIC_ERROR)
* - handle error code returning the code and info about error
*
* You can create custom error code objects but custom class should always extend this one.
* The name of the custom class MUST be the camelized version of the error code lower cased.
* For example to handle `UPLOAD_QUOTA_EXCEEDED` error code you need to create the class
*
* ```
* class UploadQuotaExceeded extends BeErrorCode {}
* ```
*/
class BeErrorCode {
/**
* The valid codes
*
* @var array
*/
protected $validCodes = array();
/**
* The error code
*
* @var string
*/
protected $code = 'GENERIC_ERROR';
/**
* An array of info about the error
*
* @var array
*/
protected $info = array();
/**
* Constructor. Set error code and info if it is valid.
*
* @param string $errorCode The error code name
* @param array $info Additional error information
* @return void
*/
public function __construct($errorCode = '', array $info = array()) {
$validCodes = $this->validCodes();
if (!array_key_exists($errorCode, $validCodes)) {
return;
}
$this->code = $errorCode;
$this->info = $info + $validCodes[$errorCode] + $this->info;
}
/**
* Initialize the array of valid codes `self::validCodes` and return it.
* Valid codes are taken from `bedita-app/config/error.codes.php`
* combined with `app/config/error.codes.php` if the app is a frontend
*
* @return array
*/
public function validCodes() {
if (!empty($this->validCodes)) {
return $this->validCodes;
}
$this->loadErrorCodes(BEDITA_CORE_PATH . DS . 'config' . DS . 'error.codes.php');
if (BACKEND_APP) {
return $this->validCodes;
}
$this->loadErrorCodes(APP . DS . 'config' . DS . 'error.codes.php');
return $this->validCodes;
}
/**
* Load a file containing error codes adding them to those already presents
*
* @param string $filePath The file path to load
* @return array
*/
protected function loadErrorCodes($filePath) {
if (!file_exists($filePath )) {
return;
}
$errorCodes = include $filePath;
if (empty($errorCodes) || !is_array($errorCodes)) {
return;
}
$this->validCodes = $this->validCodes + $errorCodes;
}
/**
* Return the error code
*
* @return string
*/
public function code() {
return $this->code;
}
/**
* Return the error info
*
* @return array
*/
public function info() {
return $this->info;
}
}