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