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