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