Subversion Repositories oidplus

Rev

Rev 1219 | Blame | Compare with Previous | Last modification | View Log | RSS feed

  1. <?php
  2.  
  3. /*
  4.  * OIDplus 2.0
  5.  * Copyright 2019 - 2023 Daniel Marschall, ViaThinkSoft
  6.  *
  7.  * Licensed under the Apache License, Version 2.0 (the "License");
  8.  * you may not use this file except in compliance with the License.
  9.  * You may obtain a copy of the License at
  10.  *
  11.  *     http://www.apache.org/licenses/LICENSE-2.0
  12.  *
  13.  * Unless required by applicable law or agreed to in writing, software
  14.  * distributed under the License is distributed on an "AS IS" BASIS,
  15.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16.  * See the License for the specific language governing permissions and
  17.  * limitations under the License.
  18.  */
  19.  
  20. namespace ViaThinkSoft\OIDplus;
  21.  
  22. // phpcs:disable PSR1.Files.SideEffects
  23. \defined('INSIDE_OIDPLUS') or die;
  24. // phpcs:enable PSR1.Files.SideEffects
  25.  
  26. /**
  27.  * Every Exception that is thrown in OIDplus should be an OIDplusException.
  28.  */
  29. class OIDplusException extends \Exception {
  30.  
  31.         /**
  32.          * @var string|null
  33.          */
  34.         protected $title = null;
  35.  
  36.         /**
  37.          * @var int
  38.          */
  39.         protected $httpStatus = 500;
  40.  
  41.         /**
  42.          * @param string $message
  43.          * @param string|null $title
  44.          * @param int $httpStatus
  45.          */
  46.         public function __construct(string $message, string $title=null, int $httpStatus=500) {
  47.                 $this->title = $title;
  48.                 $this->httpStatus = $httpStatus;
  49.                 parent::__construct($message);
  50.         }
  51.  
  52.         /**
  53.          * @return string
  54.          */
  55.         public function getTitle(): string {
  56.                 return $this->title ?? '';
  57.         }
  58.  
  59.         /**
  60.          * @return int
  61.          */
  62.         public function getHttpStatus(): int {
  63.                 return $this->httpStatus;
  64.         }
  65.  
  66.         /**
  67.          * @return string
  68.          */
  69.         public function getHtmlTitle(): string {
  70.                 return htmlentities($this->getTitle(), ENT_SUBSTITUTE); // ENT_SUBSTITUTE because ODBC drivers might return ANSI instead of UTF-8 stuff
  71.         }
  72.  
  73.         /**
  74.          * @return string
  75.          */
  76.         public function getHtmlMessage(): string {
  77.                 return nl2br(htmlentities($this->getMessage(), ENT_SUBSTITUTE)); // ENT_SUBSTITUTE because ODBC drivers might return ANSI instead of UTF-8 stuff
  78.         }
  79.  
  80. }