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  * @ingroup Database
  20  */
  21
  22 namespace Wikimedia\Rdbms;
  23
  24 use Exception;
  25
  26 /**
  27  * Database error base class
  28  * @ingroup Database
  29  */
  30 class DBError extends Exception {
  31         /** @var IDatabase|null */
  32         public $db;
  33
  34         /**
  35          * Construct a database error
  36          * @param IDatabase $db Object which threw the error
  37          * @param string $error A simple error message to be used for debugging
  38          */
  39         public function __construct( IDatabase $db = null, $error ) {
  40                 $this->db = $db;
  41                 parent::__construct( $error );
  42         }
  43 }
  44
  45 class_alias( DBError::class, 'DBError' );