includes/libs/rdbms/exception/DBExpectedError.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  * Base class for the more common types of database errors. These are known to occur
  25  * frequently, so we try to give friendly error messages for them.
  26  *
  27  * @ingroup Database
  28  * @since 1.23
  29  */
  30 class DBExpectedError extends DBError implements MessageSpecifier, ILocalizedException {
  31         /** @var string[] Message parameters */
  32         protected $params;
  33
  34         function __construct( IDatabase $db = null, $error, array $params = [] ) {
  35                 parent::__construct( $db, $error );
  36                 $this->params = $params;
  37         }
  38
  39         public function getKey() {
  40                 return 'databaseerror-text';
  41         }
  42
  43         public function getParams() {
  44                 return $this->params;
  45         }
  46
  47         /**
  48          * @inheritdoc
  49          * @since 1.29
  50          */
  51         public function getMessageObject() {
  52                 return Message::newFromSpecifier( $this );
  53         }
  54 }