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