src/Database/DatabaseException.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 declare(strict_types=1);
  23
  24 namespace Friendica\Database;
  25
  26 use Exception;
  27 use Throwable;
  28
  29 /**
  30  * A database fatal exception, which shouldn't occur
  31  */
  32 class DatabaseException extends Exception
  33 {
  34         protected $query;
  35
  36         /**
  37          * Construct the exception. Note: The message is NOT binary safe.
  38          *
  39          * @link https://php.net/manual/en/exception.construct.php
  40          *
  41          * @param string    $message  The Database error message.
  42          * @param int       $code     The Database error code.
  43          * @param string    $query    The Database error query.
  44          * @param Throwable $previous [optional] The previous throwable used for the exception chaining.
  45          */
  46         public function __construct(string $message, int $code, string $query, Throwable $previous = null)
  47         {
  48                 parent::__construct($message, $code, $previous);
  49                 $this->query = $query;
  50         }
  51
  52         /**
  53          * {@inheritDoc}
  54          */
  55         public function __toString()
  56         {
  57                 return sprintf('Database error %d "%s" at "%s"', $this->message, $this->code, $this->query);
  58         }
  59 }