includes/libs/rdbms/exception/DBQueryError.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 /**
  25  * @ingroup Database
  26  */
  27 class DBQueryError extends DBExpectedError {
  28         /** @var string */
  29         public $error;
  30         /** @var int */
  31         public $errno;
  32         /** @var string */
  33         public $sql;
  34         /** @var string */
  35         public $fname;
  36
  37         /**
  38          * @param IDatabase $db
  39          * @param string $error
  40          * @param int|string $errno
  41          * @param string $sql
  42          * @param string $fname
  43          * @param string $message Optional message, intended for subclases (optional)
  44          */
  45         public function __construct( IDatabase $db, $error, $errno, $sql, $fname, $message = null ) {
  46                 if ( $message === null ) {
  47                         if ( $db instanceof Database && $db->wasConnectionError( $errno ) ) {
  48                                 $message = "A connection error occured. \n" .
  49                                          "Query: $sql\n" .
  50                                          "Function: $fname\n" .
  51                                          "Error: $errno $error\n";
  52                         } else {
  53                                 $message = "A database query error has occurred. Did you forget to run " .
  54                                          "your application's database schema updater after upgrading? \n" .
  55                                          "Query: $sql\n" .
  56                                          "Function: $fname\n" .
  57                                          "Error: $errno $error\n";
  58                         }
  59                 }
  60
  61                 parent::__construct( $db, $message );
  62
  63                 $this->error = $error;
  64                 $this->errno = $errno;
  65                 $this->sql = $sql;
  66                 $this->fname = $fname;
  67         }
  68 }
  69
  70 class_alias( DBQueryError::class, 'DBQueryError' );