@@ -50,20 +50,20 @@ discard block |
||
| 50 | 50 | |
| 51 | 51 | } |
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Creates and returns a new instance of the CSV builder which |
|
| 55 | - * can be used to build CSV from scratch. |
|
| 56 | - * |
|
| 57 | - * @return CSVHelper_Builder |
|
| 58 | - */ |
|
| 53 | + /** |
|
| 54 | + * Creates and returns a new instance of the CSV builder which |
|
| 55 | + * can be used to build CSV from scratch. |
|
| 56 | + * |
|
| 57 | + * @return CSVHelper_Builder |
|
| 58 | + */ |
|
| 59 | 59 | public static function createBuilder() |
| 60 | 60 | { |
| 61 | 61 | return new CSVHelper_Builder(); |
| 62 | 62 | } |
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * @var string |
|
| 66 | - */ |
|
| 64 | + /** |
|
| 65 | + * @var string |
|
| 66 | + */ |
|
| 67 | 67 | protected $csv = ''; |
| 68 | 68 | |
| 69 | 69 | protected $data = array(); |
@@ -72,16 +72,16 @@ discard block |
||
| 72 | 72 | |
| 73 | 73 | protected $headersPosition = self::HEADERS_NONE; |
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * Loads CSV data from a string. |
|
| 77 | - * |
|
| 78 | - * Note: Use the {@link hasErrors()} method to |
|
| 79 | - * check if the string could be parsed correctly |
|
| 80 | - * afterwards. |
|
| 81 | - * |
|
| 82 | - * @param string $string |
|
| 83 | - * @return CSVHelper |
|
| 84 | - */ |
|
| 75 | + /** |
|
| 76 | + * Loads CSV data from a string. |
|
| 77 | + * |
|
| 78 | + * Note: Use the {@link hasErrors()} method to |
|
| 79 | + * check if the string could be parsed correctly |
|
| 80 | + * afterwards. |
|
| 81 | + * |
|
| 82 | + * @param string $string |
|
| 83 | + * @return CSVHelper |
|
| 84 | + */ |
|
| 85 | 85 | public function loadString($string) |
| 86 | 86 | { |
| 87 | 87 | // remove any UTF byte order marks that may still be present in the string |
@@ -95,20 +95,20 @@ discard block |
||
| 95 | 95 | return $this; |
| 96 | 96 | } |
| 97 | 97 | |
| 98 | - /** |
|
| 99 | - * Loads CSV data from a file. |
|
| 100 | - * |
|
| 101 | - * Note: Use the {@link hasErrors()} method to |
|
| 102 | - * check if the string could be parsed correctly |
|
| 103 | - * afterwards. |
|
| 104 | - * |
|
| 105 | - * @param string $file |
|
| 106 | - * @throws FileHelper_Exception |
|
| 107 | - * @return CSVHelper |
|
| 108 | - * |
|
| 109 | - * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 110 | - * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
| 111 | - */ |
|
| 98 | + /** |
|
| 99 | + * Loads CSV data from a file. |
|
| 100 | + * |
|
| 101 | + * Note: Use the {@link hasErrors()} method to |
|
| 102 | + * check if the string could be parsed correctly |
|
| 103 | + * afterwards. |
|
| 104 | + * |
|
| 105 | + * @param string $file |
|
| 106 | + * @throws FileHelper_Exception |
|
| 107 | + * @return CSVHelper |
|
| 108 | + * |
|
| 109 | + * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST |
|
| 110 | + * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS |
|
| 111 | + */ |
|
| 112 | 112 | public function loadFile(string $file) : CSVHelper |
| 113 | 113 | { |
| 114 | 114 | $csv = FileHelper::readContents($file); |
@@ -122,28 +122,28 @@ discard block |
||
| 122 | 122 | |
| 123 | 123 | protected $rowCount = 0; |
| 124 | 124 | |
| 125 | - /** |
|
| 126 | - * Specifies that headers are positioned on top, horizontally. |
|
| 127 | - * @return CSVHelper |
|
| 128 | - */ |
|
| 125 | + /** |
|
| 126 | + * Specifies that headers are positioned on top, horizontally. |
|
| 127 | + * @return CSVHelper |
|
| 128 | + */ |
|
| 129 | 129 | public function setHeadersTop() |
| 130 | 130 | { |
| 131 | 131 | return $this->setHeadersPosition(self::HEADERS_TOP); |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - /** |
|
| 135 | - * Specifies that headers are positioned on the left, vertically. |
|
| 136 | - * @return CSVHelper |
|
| 137 | - */ |
|
| 134 | + /** |
|
| 135 | + * Specifies that headers are positioned on the left, vertically. |
|
| 136 | + * @return CSVHelper |
|
| 137 | + */ |
|
| 138 | 138 | public function setHeadersLeft() |
| 139 | 139 | { |
| 140 | 140 | return $this->setHeadersPosition(self::HEADERS_LEFT); |
| 141 | 141 | } |
| 142 | 142 | |
| 143 | - /** |
|
| 144 | - * Specifies that there are no headers in the file (default). |
|
| 145 | - * @return CSVHelper |
|
| 146 | - */ |
|
| 143 | + /** |
|
| 144 | + * Specifies that there are no headers in the file (default). |
|
| 145 | + * @return CSVHelper |
|
| 146 | + */ |
|
| 147 | 147 | public function setHeadersNone() |
| 148 | 148 | { |
| 149 | 149 | return $this->setHeadersPosition(self::HEADERS_NONE); |
@@ -173,18 +173,18 @@ discard block |
||
| 173 | 173 | return false; |
| 174 | 174 | } |
| 175 | 175 | |
| 176 | - /** |
|
| 177 | - * Specifies where the headers are positioned in the |
|
| 178 | - * CSV, or turns them off entirely. Use the class constants |
|
| 179 | - * to ensure the value is correct. |
|
| 180 | - * |
|
| 181 | - * @param string $position |
|
| 182 | - * @throws CSVHelper_Exception |
|
| 183 | - * @return CSVHelper |
|
| 184 | - * @see CSVHelper::HEADERS_LEFT |
|
| 185 | - * @see CSVHelper::HEADERS_TOP |
|
| 186 | - * @see CSVHelper::HEADERS_NONE |
|
| 187 | - */ |
|
| 176 | + /** |
|
| 177 | + * Specifies where the headers are positioned in the |
|
| 178 | + * CSV, or turns them off entirely. Use the class constants |
|
| 179 | + * to ensure the value is correct. |
|
| 180 | + * |
|
| 181 | + * @param string $position |
|
| 182 | + * @throws CSVHelper_Exception |
|
| 183 | + * @return CSVHelper |
|
| 184 | + * @see CSVHelper::HEADERS_LEFT |
|
| 185 | + * @see CSVHelper::HEADERS_TOP |
|
| 186 | + * @see CSVHelper::HEADERS_NONE |
|
| 187 | + */ |
|
| 188 | 188 | public function setHeadersPosition($position) |
| 189 | 189 | { |
| 190 | 190 | $validPositions = array( |
@@ -211,13 +211,13 @@ discard block |
||
| 211 | 211 | return $this; |
| 212 | 212 | } |
| 213 | 213 | |
| 214 | - /** |
|
| 215 | - * Resets all internal data, allowing to start entirely anew |
|
| 216 | - * with a new file, or to start building a new CSV file from |
|
| 217 | - * scratch. |
|
| 218 | - * |
|
| 219 | - * @return CSVHelper |
|
| 220 | - */ |
|
| 214 | + /** |
|
| 215 | + * Resets all internal data, allowing to start entirely anew |
|
| 216 | + * with a new file, or to start building a new CSV file from |
|
| 217 | + * scratch. |
|
| 218 | + * |
|
| 219 | + * @return CSVHelper |
|
| 220 | + */ |
|
| 221 | 221 | public function reset() |
| 222 | 222 | { |
| 223 | 223 | $this->data = array(); |
@@ -234,19 +234,19 @@ discard block |
||
| 234 | 234 | return $this->data; |
| 235 | 235 | } |
| 236 | 236 | |
| 237 | - /** |
|
| 238 | - * Retrieves the row at the specified index. |
|
| 239 | - * If there is no data at the index, this will |
|
| 240 | - * return an array populated with empty strings |
|
| 241 | - * for all available columns. |
|
| 242 | - * |
|
| 243 | - * Tip: Use the {@link rowExists()} method to check |
|
| 244 | - * whether the specified row exists. |
|
| 245 | - * |
|
| 246 | - * @param integer $index |
|
| 247 | - * @return array() |
|
| 248 | - * @see rowExists() |
|
| 249 | - */ |
|
| 237 | + /** |
|
| 238 | + * Retrieves the row at the specified index. |
|
| 239 | + * If there is no data at the index, this will |
|
| 240 | + * return an array populated with empty strings |
|
| 241 | + * for all available columns. |
|
| 242 | + * |
|
| 243 | + * Tip: Use the {@link rowExists()} method to check |
|
| 244 | + * whether the specified row exists. |
|
| 245 | + * |
|
| 246 | + * @param integer $index |
|
| 247 | + * @return array() |
|
| 248 | + * @see rowExists() |
|
| 249 | + */ |
|
| 250 | 250 | public function getRow($index) |
| 251 | 251 | { |
| 252 | 252 | if(isset($this->data[$index])) { |
@@ -256,63 +256,63 @@ discard block |
||
| 256 | 256 | return array_fill(0, $this->rowCount, ''); |
| 257 | 257 | } |
| 258 | 258 | |
| 259 | - /** |
|
| 260 | - * Checks whether the specified row exists in the data set. |
|
| 261 | - * @param integer $index |
|
| 262 | - * @return boolean |
|
| 263 | - */ |
|
| 259 | + /** |
|
| 260 | + * Checks whether the specified row exists in the data set. |
|
| 261 | + * @param integer $index |
|
| 262 | + * @return boolean |
|
| 263 | + */ |
|
| 264 | 264 | public function rowExists($index) |
| 265 | 265 | { |
| 266 | 266 | return isset($this->data[$index]); |
| 267 | 267 | } |
| 268 | 268 | |
| 269 | - /** |
|
| 270 | - * Counts the amount of rows in the parsed CSV, |
|
| 271 | - * excluding the headers if any, depending on |
|
| 272 | - * their position. |
|
| 273 | - * |
|
| 274 | - * @return integer |
|
| 275 | - */ |
|
| 269 | + /** |
|
| 270 | + * Counts the amount of rows in the parsed CSV, |
|
| 271 | + * excluding the headers if any, depending on |
|
| 272 | + * their position. |
|
| 273 | + * |
|
| 274 | + * @return integer |
|
| 275 | + */ |
|
| 276 | 276 | public function countRows() |
| 277 | 277 | { |
| 278 | 278 | return $this->rowCount; |
| 279 | 279 | } |
| 280 | 280 | |
| 281 | - /** |
|
| 282 | - * Counts the amount of rows in the parsed CSV, |
|
| 283 | - * excluding the headers if any, depending on |
|
| 284 | - * their position. |
|
| 285 | - * |
|
| 286 | - * @return integer |
|
| 287 | - */ |
|
| 281 | + /** |
|
| 282 | + * Counts the amount of rows in the parsed CSV, |
|
| 283 | + * excluding the headers if any, depending on |
|
| 284 | + * their position. |
|
| 285 | + * |
|
| 286 | + * @return integer |
|
| 287 | + */ |
|
| 288 | 288 | public function countColumns() |
| 289 | 289 | { |
| 290 | 290 | return $this->columnCount; |
| 291 | 291 | } |
| 292 | 292 | |
| 293 | - /** |
|
| 294 | - * Retrieves the headers, if any. Specify the position of the |
|
| 295 | - * headers first to ensure this works correctly. |
|
| 296 | - * |
|
| 297 | - * @return array Indexed array with header names. |
|
| 298 | - */ |
|
| 293 | + /** |
|
| 294 | + * Retrieves the headers, if any. Specify the position of the |
|
| 295 | + * headers first to ensure this works correctly. |
|
| 296 | + * |
|
| 297 | + * @return array Indexed array with header names. |
|
| 298 | + */ |
|
| 299 | 299 | public function getHeaders() |
| 300 | 300 | { |
| 301 | 301 | return $this->headers; |
| 302 | 302 | } |
| 303 | 303 | |
| 304 | - /** |
|
| 305 | - * Retrieves the column at the specified index. If there |
|
| 306 | - * is no column at the index, this returns an array |
|
| 307 | - * populated with empty strings. |
|
| 308 | - * |
|
| 309 | - * Tip: Use the {@link columnExists()} method to check |
|
| 310 | - * whether a column exists. |
|
| 311 | - * |
|
| 312 | - * @param integer $index |
|
| 313 | - * @return string[] |
|
| 314 | - * @see columnExists() |
|
| 315 | - */ |
|
| 304 | + /** |
|
| 305 | + * Retrieves the column at the specified index. If there |
|
| 306 | + * is no column at the index, this returns an array |
|
| 307 | + * populated with empty strings. |
|
| 308 | + * |
|
| 309 | + * Tip: Use the {@link columnExists()} method to check |
|
| 310 | + * whether a column exists. |
|
| 311 | + * |
|
| 312 | + * @param integer $index |
|
| 313 | + * @return string[] |
|
| 314 | + * @see columnExists() |
|
| 315 | + */ |
|
| 316 | 316 | public function getColumn($index) |
| 317 | 317 | { |
| 318 | 318 | $data = array(); |
@@ -328,11 +328,11 @@ discard block |
||
| 328 | 328 | return $data; |
| 329 | 329 | } |
| 330 | 330 | |
| 331 | - /** |
|
| 332 | - * Checks whether the specified column exists in the data set. |
|
| 333 | - * @param integer $index |
|
| 334 | - * @return boolean |
|
| 335 | - */ |
|
| 331 | + /** |
|
| 332 | + * Checks whether the specified column exists in the data set. |
|
| 333 | + * @param integer $index |
|
| 334 | + * @return boolean |
|
| 335 | + */ |
|
| 336 | 336 | public function columnExists($index) |
| 337 | 337 | { |
| 338 | 338 | if($index < $this->columnCount) { |
@@ -396,22 +396,22 @@ discard block |
||
| 396 | 396 | } |
| 397 | 397 | } |
| 398 | 398 | |
| 399 | - /** |
|
| 400 | - * Checks whether any errors have been encountered |
|
| 401 | - * while parsing the CSV. |
|
| 402 | - * |
|
| 403 | - * @return boolean |
|
| 404 | - * @see getErrorMessages() |
|
| 405 | - */ |
|
| 399 | + /** |
|
| 400 | + * Checks whether any errors have been encountered |
|
| 401 | + * while parsing the CSV. |
|
| 402 | + * |
|
| 403 | + * @return boolean |
|
| 404 | + * @see getErrorMessages() |
|
| 405 | + */ |
|
| 406 | 406 | public function hasErrors() |
| 407 | 407 | { |
| 408 | 408 | return !empty($this->errors); |
| 409 | 409 | } |
| 410 | 410 | |
| 411 | - /** |
|
| 412 | - * Retrieves all error messages. |
|
| 413 | - * @return array |
|
| 414 | - */ |
|
| 411 | + /** |
|
| 412 | + * Retrieves all error messages. |
|
| 413 | + * @return array |
|
| 414 | + */ |
|
| 415 | 415 | public function getErrorMessages() |
| 416 | 416 | { |
| 417 | 417 | return $this->errors; |
@@ -14,49 +14,49 @@ discard block |
||
| 14 | 14 | const CONTEXT_COMMAND_LINE = 'cli'; |
| 15 | 15 | const CONTEXT_WEB = 'web'; |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * @var \Throwable |
|
| 19 | - */ |
|
| 17 | + /** |
|
| 18 | + * @var \Throwable |
|
| 19 | + */ |
|
| 20 | 20 | protected $exception; |
| 21 | 21 | |
| 22 | - /** |
|
| 23 | - * @var ConvertHelper_ThrowableInfo_Call[] |
|
| 24 | - */ |
|
| 22 | + /** |
|
| 23 | + * @var ConvertHelper_ThrowableInfo_Call[] |
|
| 24 | + */ |
|
| 25 | 25 | protected $calls = array(); |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var integer |
|
| 29 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var integer |
|
| 29 | + */ |
|
| 30 | 30 | protected $code; |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var string |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var string |
|
| 34 | + */ |
|
| 35 | 35 | protected $message; |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @var integer |
|
| 39 | - */ |
|
| 37 | + /** |
|
| 38 | + * @var integer |
|
| 39 | + */ |
|
| 40 | 40 | protected $callsCount = 0; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var ConvertHelper_ThrowableInfo |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var ConvertHelper_ThrowableInfo |
|
| 44 | + */ |
|
| 45 | 45 | protected $previous; |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @var string |
|
| 49 | - */ |
|
| 47 | + /** |
|
| 48 | + * @var string |
|
| 49 | + */ |
|
| 50 | 50 | protected $referer = ''; |
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * @var \DateTime |
|
| 54 | - */ |
|
| 52 | + /** |
|
| 53 | + * @var \DateTime |
|
| 54 | + */ |
|
| 55 | 55 | protected $date; |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * @var string |
|
| 59 | - */ |
|
| 57 | + /** |
|
| 58 | + * @var string |
|
| 59 | + */ |
|
| 60 | 60 | protected $context = self::CONTEXT_WEB; |
| 61 | 61 | |
| 62 | 62 | protected function __construct($subject) |
@@ -103,16 +103,16 @@ discard block |
||
| 103 | 103 | return isset($this->previous); |
| 104 | 104 | } |
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * Retrieves the information on the previous exception. |
|
| 108 | - * |
|
| 109 | - * NOTE: Throws an exception if there is no previous |
|
| 110 | - * exception. Use hasPrevious() first to avoid this. |
|
| 111 | - * |
|
| 112 | - * @throws ConvertHelper_Exception |
|
| 113 | - * @return ConvertHelper_ThrowableInfo |
|
| 114 | - * @see ConvertHelper_ThrowableInfo::ERROR_NO_PREVIOUS_EXCEPTION |
|
| 115 | - */ |
|
| 106 | + /** |
|
| 107 | + * Retrieves the information on the previous exception. |
|
| 108 | + * |
|
| 109 | + * NOTE: Throws an exception if there is no previous |
|
| 110 | + * exception. Use hasPrevious() first to avoid this. |
|
| 111 | + * |
|
| 112 | + * @throws ConvertHelper_Exception |
|
| 113 | + * @return ConvertHelper_ThrowableInfo |
|
| 114 | + * @see ConvertHelper_ThrowableInfo::ERROR_NO_PREVIOUS_EXCEPTION |
|
| 115 | + */ |
|
| 116 | 116 | public function getPrevious() : ConvertHelper_ThrowableInfo |
| 117 | 117 | { |
| 118 | 118 | if(isset($this->previous)) { |
@@ -131,9 +131,9 @@ discard block |
||
| 131 | 131 | return !empty($this->code); |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - /** |
|
| 135 | - * Improved textonly exception trace. |
|
| 136 | - */ |
|
| 134 | + /** |
|
| 135 | + * Improved textonly exception trace. |
|
| 136 | + */ |
|
| 137 | 137 | public function toString() : string |
| 138 | 138 | { |
| 139 | 139 | $calls = $this->getCalls(); |
@@ -161,73 +161,73 @@ discard block |
||
| 161 | 161 | return $string; |
| 162 | 162 | } |
| 163 | 163 | |
| 164 | - /** |
|
| 165 | - * Retrieves the URL of the page in which the exception |
|
| 166 | - * was thrown, if applicable: in CLI context, this will |
|
| 167 | - * return an empty string. |
|
| 168 | - * |
|
| 169 | - * @return string |
|
| 170 | - */ |
|
| 164 | + /** |
|
| 165 | + * Retrieves the URL of the page in which the exception |
|
| 166 | + * was thrown, if applicable: in CLI context, this will |
|
| 167 | + * return an empty string. |
|
| 168 | + * |
|
| 169 | + * @return string |
|
| 170 | + */ |
|
| 171 | 171 | public function getReferer() : string |
| 172 | 172 | { |
| 173 | 173 | return $this->referer; |
| 174 | 174 | } |
| 175 | 175 | |
| 176 | - /** |
|
| 177 | - * Whether the exception occurred in a command line context. |
|
| 178 | - * @return bool |
|
| 179 | - */ |
|
| 176 | + /** |
|
| 177 | + * Whether the exception occurred in a command line context. |
|
| 178 | + * @return bool |
|
| 179 | + */ |
|
| 180 | 180 | public function isCommandLine() : bool |
| 181 | 181 | { |
| 182 | 182 | return $this->getContext() === self::CONTEXT_COMMAND_LINE; |
| 183 | 183 | } |
| 184 | 184 | |
| 185 | - /** |
|
| 186 | - * Whether the exception occurred during an http request. |
|
| 187 | - * @return bool |
|
| 188 | - */ |
|
| 185 | + /** |
|
| 186 | + * Whether the exception occurred during an http request. |
|
| 187 | + * @return bool |
|
| 188 | + */ |
|
| 189 | 189 | public function isWebRequest() : bool |
| 190 | 190 | { |
| 191 | 191 | return $this->getContext() === self::CONTEXT_WEB; |
| 192 | 192 | } |
| 193 | 193 | |
| 194 | - /** |
|
| 195 | - * Retrieves the context identifier, i.e. if the exception |
|
| 196 | - * occurred in a command line context or regular web request. |
|
| 197 | - * |
|
| 198 | - * @return string |
|
| 199 | - * |
|
| 200 | - * @see ConvertHelper_ThrowableInfo::isCommandLine() |
|
| 201 | - * @see ConvertHelper_ThrowableInfo::isWebRequest() |
|
| 202 | - * @see ConvertHelper_ThrowableInfo::CONTEXT_COMMAND_LINE |
|
| 203 | - * @see ConvertHelper_ThrowableInfo::CONTEXT_WEB |
|
| 204 | - */ |
|
| 194 | + /** |
|
| 195 | + * Retrieves the context identifier, i.e. if the exception |
|
| 196 | + * occurred in a command line context or regular web request. |
|
| 197 | + * |
|
| 198 | + * @return string |
|
| 199 | + * |
|
| 200 | + * @see ConvertHelper_ThrowableInfo::isCommandLine() |
|
| 201 | + * @see ConvertHelper_ThrowableInfo::isWebRequest() |
|
| 202 | + * @see ConvertHelper_ThrowableInfo::CONTEXT_COMMAND_LINE |
|
| 203 | + * @see ConvertHelper_ThrowableInfo::CONTEXT_WEB |
|
| 204 | + */ |
|
| 205 | 205 | public function getContext() : string |
| 206 | 206 | { |
| 207 | 207 | return $this->context; |
| 208 | 208 | } |
| 209 | 209 | |
| 210 | - /** |
|
| 211 | - * Retrieves the date of the exception, and approximate time: |
|
| 212 | - * since exceptions do not store time, this is captured the |
|
| 213 | - * moment the ThrowableInfo is created. |
|
| 214 | - * |
|
| 215 | - * @return \DateTime |
|
| 216 | - */ |
|
| 210 | + /** |
|
| 211 | + * Retrieves the date of the exception, and approximate time: |
|
| 212 | + * since exceptions do not store time, this is captured the |
|
| 213 | + * moment the ThrowableInfo is created. |
|
| 214 | + * |
|
| 215 | + * @return \DateTime |
|
| 216 | + */ |
|
| 217 | 217 | public function getDate() : \DateTime |
| 218 | 218 | { |
| 219 | 219 | return $this->date; |
| 220 | 220 | } |
| 221 | 221 | |
| 222 | - /** |
|
| 223 | - * Serializes all information on the exception to an |
|
| 224 | - * associative array. This can be saved (file, database, |
|
| 225 | - * session...), and later be restored into a throwable |
|
| 226 | - * info instance using the fromSerialized() method. |
|
| 227 | - * |
|
| 228 | - * @return array |
|
| 229 | - * @see ConvertHelper_ThrowableInfo::fromSerialized() |
|
| 230 | - */ |
|
| 222 | + /** |
|
| 223 | + * Serializes all information on the exception to an |
|
| 224 | + * associative array. This can be saved (file, database, |
|
| 225 | + * session...), and later be restored into a throwable |
|
| 226 | + * info instance using the fromSerialized() method. |
|
| 227 | + * |
|
| 228 | + * @return array |
|
| 229 | + * @see ConvertHelper_ThrowableInfo::fromSerialized() |
|
| 230 | + */ |
|
| 231 | 231 | public function serialize() : array |
| 232 | 232 | { |
| 233 | 233 | $result = array( |
@@ -254,24 +254,24 @@ discard block |
||
| 254 | 254 | return $result; |
| 255 | 255 | } |
| 256 | 256 | |
| 257 | - /** |
|
| 258 | - * Sets the maximum folder depth to show in the |
|
| 259 | - * file paths, to avoid them being too long. |
|
| 260 | - * |
|
| 261 | - * @param int $depth |
|
| 262 | - * @return ConvertHelper_ThrowableInfo |
|
| 263 | - */ |
|
| 257 | + /** |
|
| 258 | + * Sets the maximum folder depth to show in the |
|
| 259 | + * file paths, to avoid them being too long. |
|
| 260 | + * |
|
| 261 | + * @param int $depth |
|
| 262 | + * @return ConvertHelper_ThrowableInfo |
|
| 263 | + */ |
|
| 264 | 264 | public function setFolderDepth(int $depth) : ConvertHelper_ThrowableInfo |
| 265 | 265 | { |
| 266 | 266 | return $this->setOption('folder-depth', $depth); |
| 267 | 267 | } |
| 268 | 268 | |
| 269 | - /** |
|
| 270 | - * Retrieves the current folder depth option value. |
|
| 271 | - * |
|
| 272 | - * @return int |
|
| 273 | - * @see ConvertHelper_ThrowableInfo::setFolderDepth() |
|
| 274 | - */ |
|
| 269 | + /** |
|
| 270 | + * Retrieves the current folder depth option value. |
|
| 271 | + * |
|
| 272 | + * @return int |
|
| 273 | + * @see ConvertHelper_ThrowableInfo::setFolderDepth() |
|
| 274 | + */ |
|
| 275 | 275 | public function getFolderDepth() : int |
| 276 | 276 | { |
| 277 | 277 | $depth = $this->getOption('folder-depth'); |
@@ -282,19 +282,19 @@ discard block |
||
| 282 | 282 | return 2; |
| 283 | 283 | } |
| 284 | 284 | |
| 285 | - /** |
|
| 286 | - * Retrieves all function calls that led to the error. |
|
| 287 | - * @return ConvertHelper_ThrowableInfo_Call[] |
|
| 288 | - */ |
|
| 285 | + /** |
|
| 286 | + * Retrieves all function calls that led to the error. |
|
| 287 | + * @return ConvertHelper_ThrowableInfo_Call[] |
|
| 288 | + */ |
|
| 289 | 289 | public function getCalls() |
| 290 | 290 | { |
| 291 | 291 | return $this->calls; |
| 292 | 292 | } |
| 293 | 293 | |
| 294 | - /** |
|
| 295 | - * Returns the amount of function and method calls in the stack trace. |
|
| 296 | - * @return int |
|
| 297 | - */ |
|
| 294 | + /** |
|
| 295 | + * Returns the amount of function and method calls in the stack trace. |
|
| 296 | + * @return int |
|
| 297 | + */ |
|
| 298 | 298 | public function countCalls() : int |
| 299 | 299 | { |
| 300 | 300 | return $this->callsCount; |
@@ -29,19 +29,19 @@ discard block |
||
| 29 | 29 | const TYPE_LF = 'LF'; |
| 30 | 30 | const TYPE_CR = 'CR'; |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var string |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var string |
|
| 34 | + */ |
|
| 35 | 35 | protected $char; |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @var string |
|
| 39 | - */ |
|
| 37 | + /** |
|
| 38 | + * @var string |
|
| 39 | + */ |
|
| 40 | 40 | protected $type; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var string |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var string |
|
| 44 | + */ |
|
| 45 | 45 | protected $description; |
| 46 | 46 | |
| 47 | 47 | public function __construct(string $char, string $type, string $description) |
@@ -51,33 +51,33 @@ discard block |
||
| 51 | 51 | $this->description = $description; |
| 52 | 52 | } |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * The actual EOL character. |
|
| 56 | - * @return string |
|
| 57 | - */ |
|
| 54 | + /** |
|
| 55 | + * The actual EOL character. |
|
| 56 | + * @return string |
|
| 57 | + */ |
|
| 58 | 58 | public function getCharacter() : string |
| 59 | 59 | { |
| 60 | 60 | return $this->char; |
| 61 | 61 | } |
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * A more detailed, human readable description of the character. |
|
| 65 | - * @return string |
|
| 66 | - */ |
|
| 63 | + /** |
|
| 64 | + * A more detailed, human readable description of the character. |
|
| 65 | + * @return string |
|
| 66 | + */ |
|
| 67 | 67 | public function getDescription() : string |
| 68 | 68 | { |
| 69 | 69 | return $this->description; |
| 70 | 70 | } |
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * The EOL character type, e.g. "CR+LF", "CR"... |
|
| 74 | - * @return string |
|
| 75 | - * |
|
| 76 | - * @see ConvertHelper_EOL::TYPE_CR |
|
| 77 | - * @see ConvertHelper_EOL::TYPE_CRLF |
|
| 78 | - * @see ConvertHelper_EOL::TYPE_LF |
|
| 79 | - * @see ConvertHelper_EOL::TYPE_LFCR |
|
| 80 | - */ |
|
| 72 | + /** |
|
| 73 | + * The EOL character type, e.g. "CR+LF", "CR"... |
|
| 74 | + * @return string |
|
| 75 | + * |
|
| 76 | + * @see ConvertHelper_EOL::TYPE_CR |
|
| 77 | + * @see ConvertHelper_EOL::TYPE_CRLF |
|
| 78 | + * @see ConvertHelper_EOL::TYPE_LF |
|
| 79 | + * @see ConvertHelper_EOL::TYPE_LFCR |
|
| 80 | + */ |
|
| 81 | 81 | public function getType() : string |
| 82 | 82 | { |
| 83 | 83 | return $this->type; |
@@ -31,9 +31,9 @@ |
||
| 31 | 31 | |
| 32 | 32 | const PATH_MODE_STRIP = 'strip'; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * @var string |
|
| 36 | - */ |
|
| 34 | + /** |
|
| 35 | + * @var string |
|
| 36 | + */ |
|
| 37 | 37 | protected $path; |
| 38 | 38 | |
| 39 | 39 | public function __construct(string $path) |
@@ -60,23 +60,23 @@ discard block |
||
| 60 | 60 | } |
| 61 | 61 | } |
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * The end of line character used in the INI source string. |
|
| 65 | - * @return string |
|
| 66 | - */ |
|
| 63 | + /** |
|
| 64 | + * The end of line character used in the INI source string. |
|
| 65 | + * @return string |
|
| 66 | + */ |
|
| 67 | 67 | public function getEOLChar() : string |
| 68 | 68 | { |
| 69 | 69 | return $this->eol; |
| 70 | 70 | } |
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * Factory method: creates a new helper instance loading the |
|
| 74 | - * ini content from the specified file. |
|
| 75 | - * |
|
| 76 | - * @param string $iniPath |
|
| 77 | - * @throws IniHelper_Exception |
|
| 78 | - * @return \AppUtils\IniHelper |
|
| 79 | - */ |
|
| 72 | + /** |
|
| 73 | + * Factory method: creates a new helper instance loading the |
|
| 74 | + * ini content from the specified file. |
|
| 75 | + * |
|
| 76 | + * @param string $iniPath |
|
| 77 | + * @throws IniHelper_Exception |
|
| 78 | + * @return \AppUtils\IniHelper |
|
| 79 | + */ |
|
| 80 | 80 | public static function createFromFile(string $iniPath) |
| 81 | 81 | { |
| 82 | 82 | $iniPath = FileHelper::requireFileExists($iniPath); |
@@ -96,35 +96,35 @@ discard block |
||
| 96 | 96 | ); |
| 97 | 97 | } |
| 98 | 98 | |
| 99 | - /** |
|
| 100 | - * Factory method: Creates a new ini helper instance from an ini string. |
|
| 101 | - * |
|
| 102 | - * @param string $iniContent |
|
| 103 | - * @return \AppUtils\IniHelper |
|
| 104 | - */ |
|
| 99 | + /** |
|
| 100 | + * Factory method: Creates a new ini helper instance from an ini string. |
|
| 101 | + * |
|
| 102 | + * @param string $iniContent |
|
| 103 | + * @return \AppUtils\IniHelper |
|
| 104 | + */ |
|
| 105 | 105 | public static function createFromString(string $iniContent) |
| 106 | 106 | { |
| 107 | 107 | return new IniHelper($iniContent); |
| 108 | 108 | } |
| 109 | 109 | |
| 110 | - /** |
|
| 111 | - * Factory method: Creates a new empty ini helper. |
|
| 112 | - * |
|
| 113 | - * @return \AppUtils\IniHelper |
|
| 114 | - */ |
|
| 110 | + /** |
|
| 111 | + * Factory method: Creates a new empty ini helper. |
|
| 112 | + * |
|
| 113 | + * @return \AppUtils\IniHelper |
|
| 114 | + */ |
|
| 115 | 115 | public static function createNew() |
| 116 | 116 | { |
| 117 | 117 | return self::createFromString(''); |
| 118 | 118 | } |
| 119 | 119 | |
| 120 | - /** |
|
| 121 | - * Adds a new data section, and returns the section instance. |
|
| 122 | - * If a section with the name already exists, returns that |
|
| 123 | - * section instead of creating a new one. |
|
| 124 | - * |
|
| 125 | - * @param string $name |
|
| 126 | - * @return IniHelper_Section |
|
| 127 | - */ |
|
| 120 | + /** |
|
| 121 | + * Adds a new data section, and returns the section instance. |
|
| 122 | + * If a section with the name already exists, returns that |
|
| 123 | + * section instead of creating a new one. |
|
| 124 | + * |
|
| 125 | + * @param string $name |
|
| 126 | + * @return IniHelper_Section |
|
| 127 | + */ |
|
| 128 | 128 | public function addSection(string $name) : IniHelper_Section |
| 129 | 129 | { |
| 130 | 130 | if(!isset($this->sections[$name])) { |
@@ -134,12 +134,12 @@ discard block |
||
| 134 | 134 | return $this->sections[$name]; |
| 135 | 135 | } |
| 136 | 136 | |
| 137 | - /** |
|
| 138 | - * Retrieves a section by its name, if it exists. |
|
| 139 | - * |
|
| 140 | - * @param string $name |
|
| 141 | - * @return IniHelper_Section|NULL |
|
| 142 | - */ |
|
| 137 | + /** |
|
| 138 | + * Retrieves a section by its name, if it exists. |
|
| 139 | + * |
|
| 140 | + * @param string $name |
|
| 141 | + * @return IniHelper_Section|NULL |
|
| 142 | + */ |
|
| 143 | 143 | public function getSection(string $name) : ?IniHelper_Section |
| 144 | 144 | { |
| 145 | 145 | if(isset($this->sections[$name])) { |
@@ -149,11 +149,11 @@ discard block |
||
| 149 | 149 | return null; |
| 150 | 150 | } |
| 151 | 151 | |
| 152 | - /** |
|
| 153 | - * Gets the data from the INI file as an associative array. |
|
| 154 | - * |
|
| 155 | - * @return array |
|
| 156 | - */ |
|
| 152 | + /** |
|
| 153 | + * Gets the data from the INI file as an associative array. |
|
| 154 | + * |
|
| 155 | + * @return array |
|
| 156 | + */ |
|
| 157 | 157 | public function toArray() : array |
| 158 | 158 | { |
| 159 | 159 | $result = array(); |
@@ -173,17 +173,17 @@ discard block |
||
| 173 | 173 | return $result; |
| 174 | 174 | } |
| 175 | 175 | |
| 176 | - /** |
|
| 177 | - * Saves the INI content to the target file. |
|
| 178 | - * |
|
| 179 | - * @param string $filePath |
|
| 180 | - * @return IniHelper |
|
| 181 | - * @throws FileHelper_Exception |
|
| 182 | - * |
|
| 183 | - * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
| 184 | - * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
| 185 | - * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
| 186 | - */ |
|
| 176 | + /** |
|
| 177 | + * Saves the INI content to the target file. |
|
| 178 | + * |
|
| 179 | + * @param string $filePath |
|
| 180 | + * @return IniHelper |
|
| 181 | + * @throws FileHelper_Exception |
|
| 182 | + * |
|
| 183 | + * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
| 184 | + * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
| 185 | + * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
| 186 | + */ |
|
| 187 | 187 | public function saveToFile(string $filePath) : IniHelper |
| 188 | 188 | { |
| 189 | 189 | FileHelper::saveFile($filePath, $this->saveToString()); |
@@ -191,11 +191,11 @@ discard block |
||
| 191 | 191 | return $this; |
| 192 | 192 | } |
| 193 | 193 | |
| 194 | - /** |
|
| 195 | - * Returns the INI content as string. |
|
| 196 | - * |
|
| 197 | - * @return string |
|
| 198 | - */ |
|
| 194 | + /** |
|
| 195 | + * Returns the INI content as string. |
|
| 196 | + * |
|
| 197 | + * @return string |
|
| 198 | + */ |
|
| 199 | 199 | public function saveToString() : string |
| 200 | 200 | { |
| 201 | 201 | $parts = array(); |
@@ -208,15 +208,15 @@ discard block |
||
| 208 | 208 | return implode($this->eol, $parts); |
| 209 | 209 | } |
| 210 | 210 | |
| 211 | - /** |
|
| 212 | - * Sets or adds the value of a setting in the INI content. |
|
| 213 | - * If the setting does not exist, it is added. Otherwise, |
|
| 214 | - * the existing value is overwritten. |
|
| 215 | - * |
|
| 216 | - * @param string $path A variable path, either <code>varname</code> or <code>section.varname</code>. |
|
| 217 | - * @param mixed $value |
|
| 218 | - * @return IniHelper |
|
| 219 | - */ |
|
| 211 | + /** |
|
| 212 | + * Sets or adds the value of a setting in the INI content. |
|
| 213 | + * If the setting does not exist, it is added. Otherwise, |
|
| 214 | + * the existing value is overwritten. |
|
| 215 | + * |
|
| 216 | + * @param string $path A variable path, either <code>varname</code> or <code>section.varname</code>. |
|
| 217 | + * @param mixed $value |
|
| 218 | + * @return IniHelper |
|
| 219 | + */ |
|
| 220 | 220 | public function setValue(string $path, $value) : IniHelper |
| 221 | 221 | { |
| 222 | 222 | $path = $this->parsePath($path); |
@@ -235,12 +235,12 @@ discard block |
||
| 235 | 235 | return $this; |
| 236 | 236 | } |
| 237 | 237 | |
| 238 | - /** |
|
| 239 | - * Checks whether a section with the specified name exists. |
|
| 240 | - * |
|
| 241 | - * @param string $name |
|
| 242 | - * @return bool |
|
| 243 | - */ |
|
| 238 | + /** |
|
| 239 | + * Checks whether a section with the specified name exists. |
|
| 240 | + * |
|
| 241 | + * @param string $name |
|
| 242 | + * @return bool |
|
| 243 | + */ |
|
| 244 | 244 | public function sectionExists(string $name) : bool |
| 245 | 245 | { |
| 246 | 246 | foreach($this->sections as $section) { |
@@ -252,23 +252,23 @@ discard block |
||
| 252 | 252 | return false; |
| 253 | 253 | } |
| 254 | 254 | |
| 255 | - /** |
|
| 256 | - * Retrieves the default section, which is used to add |
|
| 257 | - * values in the root of the document. |
|
| 258 | - * |
|
| 259 | - * @return IniHelper_Section |
|
| 260 | - */ |
|
| 255 | + /** |
|
| 256 | + * Retrieves the default section, which is used to add |
|
| 257 | + * values in the root of the document. |
|
| 258 | + * |
|
| 259 | + * @return IniHelper_Section |
|
| 260 | + */ |
|
| 261 | 261 | public function getDefaultSection() : IniHelper_Section |
| 262 | 262 | { |
| 263 | 263 | return $this->addSection(self::SECTION_DEFAULT); |
| 264 | 264 | } |
| 265 | 265 | |
| 266 | - /** |
|
| 267 | - * Retrieves all variable lines for the specified path. |
|
| 268 | - * |
|
| 269 | - * @param string $path A variable path. Either <code>varname</code> or <code>section.varname</code>. |
|
| 270 | - * @return array|\AppUtils\IniHelper_Line[] |
|
| 271 | - */ |
|
| 266 | + /** |
|
| 267 | + * Retrieves all variable lines for the specified path. |
|
| 268 | + * |
|
| 269 | + * @param string $path A variable path. Either <code>varname</code> or <code>section.varname</code>. |
|
| 270 | + * @return array|\AppUtils\IniHelper_Line[] |
|
| 271 | + */ |
|
| 272 | 272 | public function getLinesByVariable(string $path) |
| 273 | 273 | { |
| 274 | 274 | $path = $this->parsePath($path); |
@@ -32,25 +32,25 @@ discard block |
||
| 32 | 32 | self::TYPE_CALLABLE => 'cf5e20' |
| 33 | 33 | ); |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var string |
|
| 37 | - */ |
|
| 35 | + /** |
|
| 36 | + * @var string |
|
| 37 | + */ |
|
| 38 | 38 | protected $string; |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * @var mixed |
|
| 42 | - */ |
|
| 40 | + /** |
|
| 41 | + * @var mixed |
|
| 42 | + */ |
|
| 43 | 43 | protected $value; |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @var string |
|
| 47 | - */ |
|
| 45 | + /** |
|
| 46 | + * @var string |
|
| 47 | + */ |
|
| 48 | 48 | protected $type; |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * @param mixed $value |
|
| 52 | - * @param array|null $serialized |
|
| 53 | - */ |
|
| 50 | + /** |
|
| 51 | + * @param mixed $value |
|
| 52 | + * @param array|null $serialized |
|
| 53 | + */ |
|
| 54 | 54 | public function __construct($value, $serialized=null) |
| 55 | 55 | { |
| 56 | 56 | if(is_array($serialized)) |
@@ -63,26 +63,26 @@ discard block |
||
| 63 | 63 | } |
| 64 | 64 | } |
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * Creates a new variable info instance from a PHP variable |
|
| 68 | - * of any type. |
|
| 69 | - * |
|
| 70 | - * @param mixed $variable |
|
| 71 | - * @return VariableInfo |
|
| 72 | - */ |
|
| 66 | + /** |
|
| 67 | + * Creates a new variable info instance from a PHP variable |
|
| 68 | + * of any type. |
|
| 69 | + * |
|
| 70 | + * @param mixed $variable |
|
| 71 | + * @return VariableInfo |
|
| 72 | + */ |
|
| 73 | 73 | public static function fromVariable($variable) : VariableInfo |
| 74 | 74 | { |
| 75 | 75 | return new VariableInfo($variable); |
| 76 | 76 | } |
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * Restores a variable info instance using a previously serialized |
|
| 80 | - * array using the serialize() method. |
|
| 81 | - * |
|
| 82 | - * @param array $serialized |
|
| 83 | - * @return VariableInfo |
|
| 84 | - * @see VariableInfo::serialize() |
|
| 85 | - */ |
|
| 78 | + /** |
|
| 79 | + * Restores a variable info instance using a previously serialized |
|
| 80 | + * array using the serialize() method. |
|
| 81 | + * |
|
| 82 | + * @param array $serialized |
|
| 83 | + * @return VariableInfo |
|
| 84 | + * @see VariableInfo::serialize() |
|
| 85 | + */ |
|
| 86 | 86 | public static function fromSerialized(array $serialized) : VariableInfo |
| 87 | 87 | { |
| 88 | 88 | return new VariableInfo(null, $serialized); |
@@ -108,12 +108,12 @@ discard block |
||
| 108 | 108 | $this->string = $this->_toString(); |
| 109 | 109 | } |
| 110 | 110 | |
| 111 | - /** |
|
| 112 | - * The variable type - this is the same string that |
|
| 113 | - * is returned by the PHP function `gettype`. |
|
| 114 | - * |
|
| 115 | - * @return string |
|
| 116 | - */ |
|
| 111 | + /** |
|
| 112 | + * The variable type - this is the same string that |
|
| 113 | + * is returned by the PHP function `gettype`. |
|
| 114 | + * |
|
| 115 | + * @return string |
|
| 116 | + */ |
|
| 117 | 117 | public function getType() : string |
| 118 | 118 | { |
| 119 | 119 | return $this->type; |
@@ -127,13 +127,13 @@ discard block |
||
| 127 | 127 | ); |
| 128 | 128 | } |
| 129 | 129 | |
| 130 | - /** |
|
| 131 | - * Whether to prepend the variable type before the value, |
|
| 132 | - * like the var_dump function. Example: <code>string "Some text"</code>. |
|
| 133 | - * |
|
| 134 | - * @param bool $enable |
|
| 135 | - * @return VariableInfo |
|
| 136 | - */ |
|
| 130 | + /** |
|
| 131 | + * Whether to prepend the variable type before the value, |
|
| 132 | + * like the var_dump function. Example: <code>string "Some text"</code>. |
|
| 133 | + * |
|
| 134 | + * @param bool $enable |
|
| 135 | + * @return VariableInfo |
|
| 136 | + */ |
|
| 137 | 137 | public function enableType(bool $enable=true) : VariableInfo |
| 138 | 138 | { |
| 139 | 139 | return $this->setOption('prepend-type', $enable); |
@@ -203,12 +203,12 @@ discard block |
||
| 203 | 203 | return $converted; |
| 204 | 204 | } |
| 205 | 205 | |
| 206 | - /** |
|
| 207 | - * Converts an array to a string. |
|
| 208 | - * @return string |
|
| 209 | - * |
|
| 210 | - * @todo Create custom dump implementation, using VariableInfo instances. |
|
| 211 | - */ |
|
| 206 | + /** |
|
| 207 | + * Converts an array to a string. |
|
| 208 | + * @return string |
|
| 209 | + * |
|
| 210 | + * @todo Create custom dump implementation, using VariableInfo instances. |
|
| 211 | + */ |
|
| 212 | 212 | protected function toString_array() : string |
| 213 | 213 | { |
| 214 | 214 | $result = json_encode($this->value, JSON_PRETTY_PRINT); |
@@ -39,9 +39,9 @@ discard block |
||
| 39 | 39 | */ |
| 40 | 40 | protected static $instance; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var string |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var string |
|
| 44 | + */ |
|
| 45 | 45 | protected $baseURL = ''; |
| 46 | 46 | |
| 47 | 47 | public function __construct() |
@@ -51,10 +51,10 @@ discard block |
||
| 51 | 51 | $this->init(); |
| 52 | 52 | } |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Can be extended in a subclass, to avoid |
|
| 56 | - * redefining the constructor. |
|
| 57 | - */ |
|
| 54 | + /** |
|
| 55 | + * Can be extended in a subclass, to avoid |
|
| 56 | + * redefining the constructor. |
|
| 57 | + */ |
|
| 58 | 58 | protected function init() |
| 59 | 59 | { |
| 60 | 60 | |
@@ -124,12 +124,12 @@ discard block |
||
| 124 | 124 | return $this->buildURL($params, $dispatcher); |
| 125 | 125 | } |
| 126 | 126 | |
| 127 | - /** |
|
| 128 | - * Retrieves the name of the current dispatcher script / page. |
|
| 129 | - * This is made to be extended and implemented in a subclass. |
|
| 130 | - * |
|
| 131 | - * @return string |
|
| 132 | - */ |
|
| 127 | + /** |
|
| 128 | + * Retrieves the name of the current dispatcher script / page. |
|
| 129 | + * This is made to be extended and implemented in a subclass. |
|
| 130 | + * |
|
| 131 | + * @return string |
|
| 132 | + */ |
|
| 133 | 133 | public function getDispatcher() : string |
| 134 | 134 | { |
| 135 | 135 | return ''; |
@@ -198,10 +198,10 @@ discard block |
||
| 198 | 198 | return $url; |
| 199 | 199 | } |
| 200 | 200 | |
| 201 | - /** |
|
| 202 | - * Retrieves the base URL of the application. |
|
| 203 | - * @return string |
|
| 204 | - */ |
|
| 201 | + /** |
|
| 202 | + * Retrieves the base URL of the application. |
|
| 203 | + * @return string |
|
| 204 | + */ |
|
| 205 | 205 | public function getBaseURL() : string |
| 206 | 206 | { |
| 207 | 207 | return $this->baseURL; |
@@ -231,13 +231,13 @@ discard block |
||
| 231 | 231 | return $this->knownParams[$name]; |
| 232 | 232 | } |
| 233 | 233 | |
| 234 | - /** |
|
| 235 | - * Retrieves a previously registered parameter instance. |
|
| 236 | - * |
|
| 237 | - * @param string $name |
|
| 238 | - * @throws Request_Exception |
|
| 239 | - * @return Request_Param |
|
| 240 | - */ |
|
| 234 | + /** |
|
| 235 | + * Retrieves a previously registered parameter instance. |
|
| 236 | + * |
|
| 237 | + * @param string $name |
|
| 238 | + * @throws Request_Exception |
|
| 239 | + * @return Request_Param |
|
| 240 | + */ |
|
| 241 | 241 | public function getRegisteredParam(string $name) : Request_Param |
| 242 | 242 | { |
| 243 | 243 | if(isset($this->knownParams[$name])) { |
@@ -254,13 +254,13 @@ discard block |
||
| 254 | 254 | ); |
| 255 | 255 | } |
| 256 | 256 | |
| 257 | - /** |
|
| 258 | - * Checks whether a parameter with the specified name |
|
| 259 | - * has been registered. |
|
| 260 | - * |
|
| 261 | - * @param string $name |
|
| 262 | - * @return bool |
|
| 263 | - */ |
|
| 257 | + /** |
|
| 258 | + * Checks whether a parameter with the specified name |
|
| 259 | + * has been registered. |
|
| 260 | + * |
|
| 261 | + * @param string $name |
|
| 262 | + * @return bool |
|
| 263 | + */ |
|
| 264 | 264 | public function hasRegisteredParam(string $name) : bool |
| 265 | 265 | { |
| 266 | 266 | return isset($this->knownParams[$name]); |
@@ -389,14 +389,14 @@ discard block |
||
| 389 | 389 | return false; |
| 390 | 390 | } |
| 391 | 391 | |
| 392 | - /** |
|
| 393 | - * Removes a single parameter from the request. |
|
| 394 | - * If the parameter has been registered, also |
|
| 395 | - * removes the registration info. |
|
| 396 | - * |
|
| 397 | - * @param string $name |
|
| 398 | - * @return Request |
|
| 399 | - */ |
|
| 392 | + /** |
|
| 393 | + * Removes a single parameter from the request. |
|
| 394 | + * If the parameter has been registered, also |
|
| 395 | + * removes the registration info. |
|
| 396 | + * |
|
| 397 | + * @param string $name |
|
| 398 | + * @return Request |
|
| 399 | + */ |
|
| 400 | 400 | public function removeParam(string $name) : Request |
| 401 | 401 | { |
| 402 | 402 | if(isset($_REQUEST[$name])) { |
@@ -410,12 +410,12 @@ discard block |
||
| 410 | 410 | return $this; |
| 411 | 411 | } |
| 412 | 412 | |
| 413 | - /** |
|
| 414 | - * Removes several parameters from the request. |
|
| 415 | - * |
|
| 416 | - * @param string[] $names |
|
| 417 | - * @return Request |
|
| 418 | - */ |
|
| 413 | + /** |
|
| 414 | + * Removes several parameters from the request. |
|
| 415 | + * |
|
| 416 | + * @param string[] $names |
|
| 417 | + * @return Request |
|
| 418 | + */ |
|
| 419 | 419 | public function removeParams(array $names) : Request |
| 420 | 420 | { |
| 421 | 421 | foreach($names as $name) { |
@@ -480,18 +480,18 @@ discard block |
||
| 480 | 480 | return $val; |
| 481 | 481 | } |
| 482 | 482 | |
| 483 | - /** |
|
| 484 | - * Treats the request parameter as a JSON string, and |
|
| 485 | - * if it exists and contains valid JSON, returns the |
|
| 486 | - * decoded JSON value as an array (default). |
|
| 487 | - * |
|
| 488 | - * @param string $name |
|
| 489 | - * @param bool $assoc |
|
| 490 | - * @return array|object |
|
| 491 | - * |
|
| 492 | - * @see Request::getJSONAssoc() |
|
| 493 | - * @see Request::getJSONObject() |
|
| 494 | - */ |
|
| 483 | + /** |
|
| 484 | + * Treats the request parameter as a JSON string, and |
|
| 485 | + * if it exists and contains valid JSON, returns the |
|
| 486 | + * decoded JSON value as an array (default). |
|
| 487 | + * |
|
| 488 | + * @param string $name |
|
| 489 | + * @param bool $assoc |
|
| 490 | + * @return array|object |
|
| 491 | + * |
|
| 492 | + * @see Request::getJSONAssoc() |
|
| 493 | + * @see Request::getJSONObject() |
|
| 494 | + */ |
|
| 495 | 495 | public function getJSON(string $name, bool $assoc=true) |
| 496 | 496 | { |
| 497 | 497 | $value = $this->getParam($name); |
@@ -516,13 +516,13 @@ discard block |
||
| 516 | 516 | return new \stdClass(); |
| 517 | 517 | } |
| 518 | 518 | |
| 519 | - /** |
|
| 520 | - * Like {@link Request::getJSON()}, but omitting the second |
|
| 521 | - * parameter. Use this for more readable code. |
|
| 522 | - * |
|
| 523 | - * @param string $name |
|
| 524 | - * @return array |
|
| 525 | - */ |
|
| 519 | + /** |
|
| 520 | + * Like {@link Request::getJSON()}, but omitting the second |
|
| 521 | + * parameter. Use this for more readable code. |
|
| 522 | + * |
|
| 523 | + * @param string $name |
|
| 524 | + * @return array |
|
| 525 | + */ |
|
| 526 | 526 | public function getJSONAssoc(string $name) : array |
| 527 | 527 | { |
| 528 | 528 | $result = $this->getJSON($name); |
@@ -533,13 +533,13 @@ discard block |
||
| 533 | 533 | return array(); |
| 534 | 534 | } |
| 535 | 535 | |
| 536 | - /** |
|
| 537 | - * Like {@link Request::getJSON()}, but omitting the second |
|
| 538 | - * parameter. Use this for more readable code. |
|
| 539 | - * |
|
| 540 | - * @param string $name |
|
| 541 | - * @return object |
|
| 542 | - */ |
|
| 536 | + /** |
|
| 537 | + * Like {@link Request::getJSON()}, but omitting the second |
|
| 538 | + * parameter. Use this for more readable code. |
|
| 539 | + * |
|
| 540 | + * @param string $name |
|
| 541 | + * @return object |
|
| 542 | + */ |
|
| 543 | 543 | public function getJSONObject(string $name) : object |
| 544 | 544 | { |
| 545 | 545 | $result = $this->getJSON($name, false); |
@@ -550,12 +550,12 @@ discard block |
||
| 550 | 550 | return new \stdClass(); |
| 551 | 551 | } |
| 552 | 552 | |
| 553 | - /** |
|
| 554 | - * Sends a JSON response with the correct headers. |
|
| 555 | - * |
|
| 556 | - * @param array|string $data |
|
| 557 | - * @param bool $exit Whether to exit the script afterwards. |
|
| 558 | - */ |
|
| 553 | + /** |
|
| 554 | + * Sends a JSON response with the correct headers. |
|
| 555 | + * |
|
| 556 | + * @param array|string $data |
|
| 557 | + * @param bool $exit Whether to exit the script afterwards. |
|
| 558 | + */ |
|
| 559 | 559 | public static function sendJSON($data, bool $exit=true) |
| 560 | 560 | { |
| 561 | 561 | $payload = $data; |
@@ -575,12 +575,12 @@ discard block |
||
| 575 | 575 | } |
| 576 | 576 | } |
| 577 | 577 | |
| 578 | - /** |
|
| 579 | - * Sends HTML to the browser with the correct headers. |
|
| 580 | - * |
|
| 581 | - * @param string $html |
|
| 582 | - * @param bool $exit Whether to exit the script afterwards. |
|
| 583 | - */ |
|
| 578 | + /** |
|
| 579 | + * Sends HTML to the browser with the correct headers. |
|
| 580 | + * |
|
| 581 | + * @param string $html |
|
| 582 | + * @param bool $exit Whether to exit the script afterwards. |
|
| 583 | + */ |
|
| 584 | 584 | public static function sendHTML(string $html, bool $exit=true) |
| 585 | 585 | { |
| 586 | 586 | header('Cache-Control: no-cache, must-revalidate'); |
@@ -595,16 +595,16 @@ discard block |
||
| 595 | 595 | } |
| 596 | 596 | } |
| 597 | 597 | |
| 598 | - /** |
|
| 599 | - * Creates a new instance of the URL comparer, which can check |
|
| 600 | - * whether the specified URLs match, regardless of the order in |
|
| 601 | - * which the query parameters are, if any. |
|
| 602 | - * |
|
| 603 | - * @param string $sourceURL |
|
| 604 | - * @param string $targetURL |
|
| 605 | - * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present) |
|
| 606 | - * @return Request_URLComparer |
|
| 607 | - */ |
|
| 598 | + /** |
|
| 599 | + * Creates a new instance of the URL comparer, which can check |
|
| 600 | + * whether the specified URLs match, regardless of the order in |
|
| 601 | + * which the query parameters are, if any. |
|
| 602 | + * |
|
| 603 | + * @param string $sourceURL |
|
| 604 | + * @param string $targetURL |
|
| 605 | + * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present) |
|
| 606 | + * @return Request_URLComparer |
|
| 607 | + */ |
|
| 608 | 608 | public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams=array()) : Request_URLComparer |
| 609 | 609 | { |
| 610 | 610 | $comparer = new Request_URLComparer($this, $sourceURL, $targetURL); |
@@ -613,10 +613,10 @@ discard block |
||
| 613 | 613 | return $comparer; |
| 614 | 614 | } |
| 615 | 615 | |
| 616 | - /** |
|
| 617 | - * Retrieves the full URL that was used to access the current page. |
|
| 618 | - * @return string |
|
| 619 | - */ |
|
| 616 | + /** |
|
| 617 | + * Retrieves the full URL that was used to access the current page. |
|
| 618 | + * @return string |
|
| 619 | + */ |
|
| 620 | 620 | public function getCurrentURL() : string |
| 621 | 621 | { |
| 622 | 622 | return $_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI']; |
@@ -111,18 +111,18 @@ discard block |
||
| 111 | 111 | } |
| 112 | 112 | } |
| 113 | 113 | |
| 114 | - /** |
|
| 115 | - * Adds a callback as a validation method. The callback gets the |
|
| 116 | - * value to validate as first parameter, and any additional |
|
| 117 | - * parameters passed here get appended to that. |
|
| 118 | - * |
|
| 119 | - * The callback must return boolean true or false depending on |
|
| 120 | - * whether the value is valid. |
|
| 121 | - * |
|
| 122 | - * @param mixed $callback |
|
| 123 | - * @param array $args |
|
| 124 | - * @return Request_Param |
|
| 125 | - */ |
|
| 114 | + /** |
|
| 115 | + * Adds a callback as a validation method. The callback gets the |
|
| 116 | + * value to validate as first parameter, and any additional |
|
| 117 | + * parameters passed here get appended to that. |
|
| 118 | + * |
|
| 119 | + * The callback must return boolean true or false depending on |
|
| 120 | + * whether the value is valid. |
|
| 121 | + * |
|
| 122 | + * @param mixed $callback |
|
| 123 | + * @param array $args |
|
| 124 | + * @return Request_Param |
|
| 125 | + */ |
|
| 126 | 126 | public function setCallback($callback, $args=array()) |
| 127 | 127 | { |
| 128 | 128 | if(!is_callable($callback)) { |
@@ -264,13 +264,13 @@ discard block |
||
| 264 | 264 | |
| 265 | 265 | protected $valueType = self::VALUE_TYPE_STRING; |
| 266 | 266 | |
| 267 | - /** |
|
| 268 | - * Sets the variable to contain a comma-separated list of integer IDs. |
|
| 269 | - * Example: <code>145,248,4556</code>. A single ID is also allowed, e.g. |
|
| 270 | - * <code>145</code>. |
|
| 271 | - * |
|
| 272 | - * @return Request_Param |
|
| 273 | - */ |
|
| 267 | + /** |
|
| 268 | + * Sets the variable to contain a comma-separated list of integer IDs. |
|
| 269 | + * Example: <code>145,248,4556</code>. A single ID is also allowed, e.g. |
|
| 270 | + * <code>145</code>. |
|
| 271 | + * |
|
| 272 | + * @return Request_Param |
|
| 273 | + */ |
|
| 274 | 274 | public function setIDList() |
| 275 | 275 | { |
| 276 | 276 | $this->valueType = self::VALUE_TYPE_ID_LIST; |
@@ -279,13 +279,13 @@ discard block |
||
| 279 | 279 | return $this; |
| 280 | 280 | } |
| 281 | 281 | |
| 282 | - /** |
|
| 283 | - * Sets the variable to be an alias, as defined by the |
|
| 284 | - * {@link RegexHelper::REGEX_ALIAS} regular expression. |
|
| 285 | - * |
|
| 286 | - * @return Request_Param |
|
| 287 | - * @see RegexHelper::REGEX_ALIAS |
|
| 288 | - */ |
|
| 282 | + /** |
|
| 283 | + * Sets the variable to be an alias, as defined by the |
|
| 284 | + * {@link RegexHelper::REGEX_ALIAS} regular expression. |
|
| 285 | + * |
|
| 286 | + * @return Request_Param |
|
| 287 | + * @see RegexHelper::REGEX_ALIAS |
|
| 288 | + */ |
|
| 289 | 289 | public function setAlias() |
| 290 | 290 | { |
| 291 | 291 | return $this->setRegex(RegexHelper::REGEX_ALIAS); |
@@ -326,12 +326,12 @@ discard block |
||
| 326 | 326 | return $this->setValidation(self::VALIDATION_TYPE_ALPHA); |
| 327 | 327 | } |
| 328 | 328 | |
| 329 | - /** |
|
| 330 | - * Sets the parameter value as a string containing lowercase |
|
| 331 | - * and/or uppercase letters, as well as numbers. |
|
| 332 | - * |
|
| 333 | - * @return Request_Param |
|
| 334 | - */ |
|
| 329 | + /** |
|
| 330 | + * Sets the parameter value as a string containing lowercase |
|
| 331 | + * and/or uppercase letters, as well as numbers. |
|
| 332 | + * |
|
| 333 | + * @return Request_Param |
|
| 334 | + */ |
|
| 335 | 335 | public function setAlnum() |
| 336 | 336 | { |
| 337 | 337 | return $this->setValidation(self::VALIDATION_TYPE_ALNUM); |
@@ -359,17 +359,17 @@ discard block |
||
| 359 | 359 | return $this->setValidation(self::VALIDATION_TYPE_ENUM, $args); |
| 360 | 360 | } |
| 361 | 361 | |
| 362 | - /** |
|
| 363 | - * Only available for array values: the parameter must be |
|
| 364 | - * an array value, and the array may only contain values |
|
| 365 | - * specified in the values array. |
|
| 366 | - * |
|
| 367 | - * Submitted values that are not in the allowed list of |
|
| 368 | - * values are stripped from the value. |
|
| 369 | - * |
|
| 370 | - * @param array $values List of allowed values |
|
| 371 | - * @return \AppUtils\Request_Param |
|
| 372 | - */ |
|
| 362 | + /** |
|
| 363 | + * Only available for array values: the parameter must be |
|
| 364 | + * an array value, and the array may only contain values |
|
| 365 | + * specified in the values array. |
|
| 366 | + * |
|
| 367 | + * Submitted values that are not in the allowed list of |
|
| 368 | + * values are stripped from the value. |
|
| 369 | + * |
|
| 370 | + * @param array $values List of allowed values |
|
| 371 | + * @return \AppUtils\Request_Param |
|
| 372 | + */ |
|
| 373 | 373 | public function setValuesList(array $values) |
| 374 | 374 | { |
| 375 | 375 | $this->setArray(); |
@@ -382,39 +382,39 @@ discard block |
||
| 382 | 382 | return $this->setValidation(self::VALIDATION_TYPE_ARRAY); |
| 383 | 383 | } |
| 384 | 384 | |
| 385 | - /** |
|
| 386 | - * Specifies that a JSON-encoded string is expected. |
|
| 387 | - * |
|
| 388 | - * NOTE: Numbers or quoted strings are technically valid |
|
| 389 | - * JSON, but are not accepted, because it is assumed |
|
| 390 | - * at least an array or object are expected. |
|
| 391 | - * |
|
| 392 | - * @return \AppUtils\Request_Param |
|
| 393 | - */ |
|
| 385 | + /** |
|
| 386 | + * Specifies that a JSON-encoded string is expected. |
|
| 387 | + * |
|
| 388 | + * NOTE: Numbers or quoted strings are technically valid |
|
| 389 | + * JSON, but are not accepted, because it is assumed |
|
| 390 | + * at least an array or object are expected. |
|
| 391 | + * |
|
| 392 | + * @return \AppUtils\Request_Param |
|
| 393 | + */ |
|
| 394 | 394 | public function setJSON() : Request_Param |
| 395 | 395 | { |
| 396 | 396 | return $this->setValidation(self::VALIDATION_TYPE_JSON, array('arrays' => true)); |
| 397 | 397 | } |
| 398 | 398 | |
| 399 | - /** |
|
| 400 | - * Like {@link Request_Param::setJSON()}, but accepts |
|
| 401 | - * only JSON objects. Arrays will not be accepted. |
|
| 402 | - * |
|
| 403 | - * @return \AppUtils\Request_Param |
|
| 404 | - */ |
|
| 399 | + /** |
|
| 400 | + * Like {@link Request_Param::setJSON()}, but accepts |
|
| 401 | + * only JSON objects. Arrays will not be accepted. |
|
| 402 | + * |
|
| 403 | + * @return \AppUtils\Request_Param |
|
| 404 | + */ |
|
| 405 | 405 | public function setJSONObject() : Request_Param |
| 406 | 406 | { |
| 407 | 407 | return $this->setValidation(self::VALIDATION_TYPE_JSON, array('arrays' => false)); |
| 408 | 408 | } |
| 409 | 409 | |
| 410 | - /** |
|
| 411 | - * The parameter is a string boolean representation. This means |
|
| 412 | - * it can be any of the following: "yes", "true", "no", "false". |
|
| 413 | - * The value is automatically converted to a boolean when retrieving |
|
| 414 | - * the parameter. |
|
| 415 | - * |
|
| 416 | - * @return Request_Param |
|
| 417 | - */ |
|
| 410 | + /** |
|
| 411 | + * The parameter is a string boolean representation. This means |
|
| 412 | + * it can be any of the following: "yes", "true", "no", "false". |
|
| 413 | + * The value is automatically converted to a boolean when retrieving |
|
| 414 | + * the parameter. |
|
| 415 | + * |
|
| 416 | + * @return Request_Param |
|
| 417 | + */ |
|
| 418 | 418 | public function setBoolean() : Request_Param |
| 419 | 419 | { |
| 420 | 420 | $this->addCallbackFilter(array($this, 'applyFilter_boolean')); |
@@ -478,15 +478,15 @@ discard block |
||
| 478 | 478 | return $keep; |
| 479 | 479 | } |
| 480 | 480 | |
| 481 | - /** |
|
| 482 | - * Validates the request parameter as an MD5 string, |
|
| 483 | - * so that only values resembling md5 values are accepted. |
|
| 484 | - * |
|
| 485 | - * NOTE: This can only guarantee the format, not whether |
|
| 486 | - * it is an actual valid hash of something. |
|
| 487 | - * |
|
| 488 | - * @return \AppUtils\Request_Param |
|
| 489 | - */ |
|
| 481 | + /** |
|
| 482 | + * Validates the request parameter as an MD5 string, |
|
| 483 | + * so that only values resembling md5 values are accepted. |
|
| 484 | + * |
|
| 485 | + * NOTE: This can only guarantee the format, not whether |
|
| 486 | + * it is an actual valid hash of something. |
|
| 487 | + * |
|
| 488 | + * @return \AppUtils\Request_Param |
|
| 489 | + */ |
|
| 490 | 490 | public function setMD5() : Request_Param |
| 491 | 491 | { |
| 492 | 492 | return $this->setRegex(RegexHelper::REGEX_MD5); |
@@ -528,14 +528,14 @@ discard block |
||
| 528 | 528 | return $this; |
| 529 | 529 | } |
| 530 | 530 | |
| 531 | - /** |
|
| 532 | - * Retrieves the value of the request parameter, |
|
| 533 | - * applying all filters (if any) and validation |
|
| 534 | - * (if any). |
|
| 535 | - * |
|
| 536 | - * @param mixed $default |
|
| 537 | - * @return mixed |
|
| 538 | - */ |
|
| 531 | + /** |
|
| 532 | + * Retrieves the value of the request parameter, |
|
| 533 | + * applying all filters (if any) and validation |
|
| 534 | + * (if any). |
|
| 535 | + * |
|
| 536 | + * @param mixed $default |
|
| 537 | + * @return mixed |
|
| 538 | + */ |
|
| 539 | 539 | public function get($default=null) |
| 540 | 540 | { |
| 541 | 541 | $value = $this->request->getParam($this->paramName); |
@@ -565,12 +565,12 @@ discard block |
||
| 565 | 565 | return null; |
| 566 | 566 | } |
| 567 | 567 | |
| 568 | - /** |
|
| 569 | - * Validates the syntax of an URL, but not its actual validity. |
|
| 570 | - * |
|
| 571 | - * @param mixed $value |
|
| 572 | - * @return string |
|
| 573 | - */ |
|
| 568 | + /** |
|
| 569 | + * Validates the syntax of an URL, but not its actual validity. |
|
| 570 | + * |
|
| 571 | + * @param mixed $value |
|
| 572 | + * @return string |
|
| 573 | + */ |
|
| 574 | 574 | protected function validate_url($value) : string |
| 575 | 575 | { |
| 576 | 576 | if(!is_string($value)) { |
@@ -710,10 +710,10 @@ discard block |
||
| 710 | 710 | return null; |
| 711 | 711 | } |
| 712 | 712 | |
| 713 | - /** |
|
| 714 | - * Makes sure that the value is a JSON-encoded string. |
|
| 715 | - * @param mixed $value |
|
| 716 | - */ |
|
| 713 | + /** |
|
| 714 | + * Makes sure that the value is a JSON-encoded string. |
|
| 715 | + * @param mixed $value |
|
| 716 | + */ |
|
| 717 | 717 | protected function validate_json($value) : string |
| 718 | 718 | { |
| 719 | 719 | if(!is_string($value)) { |
@@ -730,7 +730,7 @@ discard block |
||
| 730 | 730 | if($this->validationParams['arrays'] === false) |
| 731 | 731 | { |
| 732 | 732 | if(is_object(json_decode($value))) { |
| 733 | - return $value; |
|
| 733 | + return $value; |
|
| 734 | 734 | } |
| 735 | 735 | } |
| 736 | 736 | else |
@@ -810,12 +810,12 @@ discard block |
||
| 810 | 810 | return $this; |
| 811 | 811 | } |
| 812 | 812 | |
| 813 | - /** |
|
| 814 | - * Adds a filter that trims whitespace from the request |
|
| 815 | - * parameter using the PHP <code>trim</code> function. |
|
| 816 | - * |
|
| 817 | - * @return \AppUtils\Request_Param |
|
| 818 | - */ |
|
| 813 | + /** |
|
| 814 | + * Adds a filter that trims whitespace from the request |
|
| 815 | + * parameter using the PHP <code>trim</code> function. |
|
| 816 | + * |
|
| 817 | + * @return \AppUtils\Request_Param |
|
| 818 | + */ |
|
| 819 | 819 | public function addFilterTrim() : Request_Param |
| 820 | 820 | { |
| 821 | 821 | // to guarantee we only work with strings |
@@ -824,13 +824,13 @@ discard block |
||
| 824 | 824 | return $this->addCallbackFilter('trim'); |
| 825 | 825 | } |
| 826 | 826 | |
| 827 | - /** |
|
| 828 | - * Converts the value to a string, even if it is not |
|
| 829 | - * a string value. Complex types like arrays and objects |
|
| 830 | - * are converted to an empty string. |
|
| 831 | - * |
|
| 832 | - * @return \AppUtils\Request_Param |
|
| 833 | - */ |
|
| 827 | + /** |
|
| 828 | + * Converts the value to a string, even if it is not |
|
| 829 | + * a string value. Complex types like arrays and objects |
|
| 830 | + * are converted to an empty string. |
|
| 831 | + * |
|
| 832 | + * @return \AppUtils\Request_Param |
|
| 833 | + */ |
|
| 834 | 834 | public function addStringFilter() : Request_Param |
| 835 | 835 | { |
| 836 | 836 | return $this->addCallbackFilter(array($this, 'applyFilter_string')); |
@@ -880,12 +880,12 @@ discard block |
||
| 880 | 880 | return $this->addCallbackFilter('strip_tags', array($allowedTags)); |
| 881 | 881 | } |
| 882 | 882 | |
| 883 | - /** |
|
| 884 | - * Adds a filter that strips all whitespace from the |
|
| 885 | - * request parameter, from spaces to tabs and newlines. |
|
| 886 | - * |
|
| 887 | - * @return \AppUtils\Request_Param |
|
| 888 | - */ |
|
| 883 | + /** |
|
| 884 | + * Adds a filter that strips all whitespace from the |
|
| 885 | + * request parameter, from spaces to tabs and newlines. |
|
| 886 | + * |
|
| 887 | + * @return \AppUtils\Request_Param |
|
| 888 | + */ |
|
| 889 | 889 | public function addStripWhitespaceFilter() : Request_Param |
| 890 | 890 | { |
| 891 | 891 | // to ensure we only work with strings. |
@@ -894,14 +894,14 @@ discard block |
||
| 894 | 894 | return $this->addCallbackFilter(array($this, 'applyFilter_stripWhitespace')); |
| 895 | 895 | } |
| 896 | 896 | |
| 897 | - /** |
|
| 898 | - * Adds a filter that transforms comma separated values |
|
| 899 | - * into an array of values. |
|
| 900 | - * |
|
| 901 | - * @param bool $trimEntries Trim whitespace from each entry? |
|
| 902 | - * @param bool $stripEmptyEntries Remove empty entries from the array? |
|
| 903 | - * @return \AppUtils\Request_Param |
|
| 904 | - */ |
|
| 897 | + /** |
|
| 898 | + * Adds a filter that transforms comma separated values |
|
| 899 | + * into an array of values. |
|
| 900 | + * |
|
| 901 | + * @param bool $trimEntries Trim whitespace from each entry? |
|
| 902 | + * @param bool $stripEmptyEntries Remove empty entries from the array? |
|
| 903 | + * @return \AppUtils\Request_Param |
|
| 904 | + */ |
|
| 905 | 905 | public function addCommaSeparatedFilter(bool $trimEntries=true, bool $stripEmptyEntries=true) : Request_Param |
| 906 | 906 | { |
| 907 | 907 | $this->setArray(); |
@@ -915,12 +915,12 @@ discard block |
||
| 915 | 915 | ); |
| 916 | 916 | } |
| 917 | 917 | |
| 918 | - /** |
|
| 919 | - * Adds a filter that encodes all HTML special characters |
|
| 920 | - * using the PHP <code>htmlspecialchars</code> function. |
|
| 921 | - * |
|
| 922 | - * @return \AppUtils\Request_Param |
|
| 923 | - */ |
|
| 918 | + /** |
|
| 919 | + * Adds a filter that encodes all HTML special characters |
|
| 920 | + * using the PHP <code>htmlspecialchars</code> function. |
|
| 921 | + * |
|
| 922 | + * @return \AppUtils\Request_Param |
|
| 923 | + */ |
|
| 924 | 924 | public function addHTMLSpecialcharsFilter() : Request_Param |
| 925 | 925 | { |
| 926 | 926 | return $this->addCallbackFilter('htmlspecialchars', array(ENT_QUOTES, 'UTF-8')); |
@@ -933,14 +933,14 @@ discard block |
||
| 933 | 933 | |
| 934 | 934 | protected $required = false; |
| 935 | 935 | |
| 936 | - /** |
|
| 937 | - * Marks this request parameter as required. To use this feature, |
|
| 938 | - * you have to call the request's {@link Request::validate()} |
|
| 939 | - * method. |
|
| 940 | - * |
|
| 941 | - * @return Request_Param |
|
| 942 | - * @see Request::validate() |
|
| 943 | - */ |
|
| 936 | + /** |
|
| 937 | + * Marks this request parameter as required. To use this feature, |
|
| 938 | + * you have to call the request's {@link Request::validate()} |
|
| 939 | + * method. |
|
| 940 | + * |
|
| 941 | + * @return Request_Param |
|
| 942 | + * @see Request::validate() |
|
| 943 | + */ |
|
| 944 | 944 | public function makeRequired() : Request_Param |
| 945 | 945 | { |
| 946 | 946 | $this->required = true; |
@@ -20,17 +20,17 @@ discard block |
||
| 20 | 20 | */ |
| 21 | 21 | class BaseException extends \Exception |
| 22 | 22 | { |
| 23 | - /** |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 23 | + /** |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | 26 | protected $details; |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @param string $message |
|
| 30 | - * @param string $details |
|
| 31 | - * @param int $code |
|
| 32 | - * @param \Exception $previous |
|
| 33 | - */ |
|
| 28 | + /** |
|
| 29 | + * @param string $message |
|
| 30 | + * @param string $details |
|
| 31 | + * @param int $code |
|
| 32 | + * @param \Exception $previous |
|
| 33 | + */ |
|
| 34 | 34 | public function __construct(string $message, $details=null, $code=null, $previous=null) |
| 35 | 35 | { |
| 36 | 36 | parent::__construct($message, $code, $previous); |
@@ -38,10 +38,10 @@ discard block |
||
| 38 | 38 | $this->details = $details; |
| 39 | 39 | } |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Retrieves the detailed error description, if any. |
|
| 43 | - * @return string |
|
| 44 | - */ |
|
| 41 | + /** |
|
| 42 | + * Retrieves the detailed error description, if any. |
|
| 43 | + * @return string |
|
| 44 | + */ |
|
| 45 | 45 | public function getDetails() : string |
| 46 | 46 | { |
| 47 | 47 | if($this->details !== null) { |
@@ -51,9 +51,9 @@ discard block |
||
| 51 | 51 | return ''; |
| 52 | 52 | } |
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * Displays pertinent information on the exception. |
|
| 56 | - */ |
|
| 54 | + /** |
|
| 55 | + * Displays pertinent information on the exception. |
|
| 56 | + */ |
|
| 57 | 57 | public function display() |
| 58 | 58 | { |
| 59 | 59 | if(!headers_sent()) { |
@@ -63,20 +63,20 @@ discard block |
||
| 63 | 63 | echo $this->getInfo(); |
| 64 | 64 | } |
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * Retrieves information on the exception that can be |
|
| 68 | - * easily accessed. |
|
| 69 | - * |
|
| 70 | - * @return ConvertHelper_ThrowableInfo |
|
| 71 | - */ |
|
| 66 | + /** |
|
| 67 | + * Retrieves information on the exception that can be |
|
| 68 | + * easily accessed. |
|
| 69 | + * |
|
| 70 | + * @return ConvertHelper_ThrowableInfo |
|
| 71 | + */ |
|
| 72 | 72 | public function getInfo() : ConvertHelper_ThrowableInfo |
| 73 | 73 | { |
| 74 | 74 | return ConvertHelper::throwable2info($this); |
| 75 | 75 | } |
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * Dumps a current PHP function trace, as a textonly string. |
|
| 79 | - */ |
|
| 77 | + /** |
|
| 78 | + * Dumps a current PHP function trace, as a textonly string. |
|
| 79 | + */ |
|
| 80 | 80 | public static function dumpTraceAsString() |
| 81 | 81 | { |
| 82 | 82 | try |
@@ -89,9 +89,9 @@ discard block |
||
| 89 | 89 | } |
| 90 | 90 | } |
| 91 | 91 | |
| 92 | - /** |
|
| 93 | - * Dumps a current PHP function trace, with HTML styling. |
|
| 94 | - */ |
|
| 92 | + /** |
|
| 93 | + * Dumps a current PHP function trace, with HTML styling. |
|
| 94 | + */ |
|
| 95 | 95 | public static function dumpTraceAsHTML() |
| 96 | 96 | { |
| 97 | 97 | try |
@@ -106,13 +106,13 @@ discard block |
||
| 106 | 106 | } |
| 107 | 107 | } |
| 108 | 108 | |
| 109 | - /** |
|
| 110 | - * Creates an exception info instance from a throwable instance. |
|
| 111 | - * |
|
| 112 | - * @param \Throwable $e |
|
| 113 | - * @return ConvertHelper_ThrowableInfo |
|
| 114 | - * @see ConvertHelper::throwable2info() |
|
| 115 | - */ |
|
| 109 | + /** |
|
| 110 | + * Creates an exception info instance from a throwable instance. |
|
| 111 | + * |
|
| 112 | + * @param \Throwable $e |
|
| 113 | + * @return ConvertHelper_ThrowableInfo |
|
| 114 | + * @see ConvertHelper::throwable2info() |
|
| 115 | + */ |
|
| 116 | 116 | public static function createInfo(\Throwable $e) : ConvertHelper_ThrowableInfo |
| 117 | 117 | { |
| 118 | 118 | return ConvertHelper::throwable2info($e); |