DBExpectedError.php 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  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. use MessageSpecifier;
  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 {
  30. /** @var string[] Message parameters */
  31. protected $params;
  32. /**
  33. * @param IDatabase|null $db
  34. * @param string $error
  35. * @param array $params
  36. * @param \Exception|\Throwable|null $prev
  37. */
  38. public function __construct(
  39. IDatabase $db = null, $error, array $params = [], $prev = null
  40. ) {
  41. parent::__construct( $db, $error, $prev );
  42. $this->params = $params;
  43. }
  44. public function getKey() {
  45. return 'databaseerror-text';
  46. }
  47. public function getParams() {
  48. return $this->params;
  49. }
  50. }
  51. /**
  52. * @deprecated since 1.29
  53. */
  54. class_alias( DBExpectedError::class, 'DBExpectedError' );