includes/libs/rdbms/exception/DBError.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20 namespace Wikimedia\Rdbms;
  21
  22 use RuntimeException;
  23
  24 /**
  25  * Database error base class.
  26  *
  27  * Catching and silencing this class or its subclasses is strongly discouraged.
  28  * Most code should not catch DB errors at all,
  29  * but let them bubble to the MediaWiki exception handler.
  30  * If necessary, cleanup can be done in a finally block;
  31  * catching the exception and then rethrowing it is also acceptable.
  32  *
  33  * @newable
  34  * @ingroup Database
  35  */
  36 class DBError extends RuntimeException {
  37         /** @var IDatabase|null */
  38         public $db;
  39
  40         /**
  41          * Construct a database error
  42          * @stable to call
  43          * @param IDatabase|null $db Object which threw the error
  44          * @param string $error A simple error message to be used for debugging
  45          * @param \Throwable|null $prev Previous throwable
  46          */
  47         public function __construct( ?IDatabase $db, $error, ?\Throwable $prev = null ) {
  48                 parent::__construct( $error, 0, $prev );
  49                 $this->db = $db;
  50         }
  51 }