Base class for the more common types of database errors. More...

Inheritance diagram for Wikimedia\Rdbms\DBExpectedError:

[legend]

Collaboration diagram for Wikimedia\Rdbms\DBExpectedError:

[legend]

Public Member Functions
	__construct (?IDatabase $db, $error, array $params=[], \Throwable $prev=null)
	Stable to call.

	getKey ()
	Returns the message key.

	getParams ()
	Returns the message parameters.

Public Member Functions inherited from Wikimedia\Rdbms\DBError
	__construct (?IDatabase $db, $error, \Throwable $prev=null)
	Construct a database error Stable to call.

Protected Attributes
string[]	$params
	Message parameters.

Additional Inherited Members
Public Attributes inherited from Wikimedia\Rdbms\DBError
IDatabase null	$db

Detailed Description

Base class for the more common types of database errors.

These are known to occur frequently, so we try to give friendly error messages for them.

@newable Stable to extend

Since: 1.23

Definition at line 34 of file DBExpectedError.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\DBExpectedError::__construct	(	?IDatabase	$db,
			$error,
		array	$params = `[]`,
		\Throwable	$prev = `null`
	)

Stable to call.

Parameters

IDatabase \| null	$db
string	$error
array	$params
\\Throwable \| null	$prev

Definition at line 45 of file DBExpectedError.php.

References Wikimedia\Rdbms\DBError\$db, and Wikimedia\Rdbms\DBExpectedError\$params.

Member Function Documentation

◆ getKey()

Wikimedia\Rdbms\DBExpectedError::getKey ( )

Returns the message key.

If a list of multiple possible keys was supplied to the constructor, this method may return any of these keys. After the message has been fetched, this method will return the key that was actually used to fetch the message.