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