MediaWiki\User\BotPasswordStore Class Reference

BotPassword interaction with databases. More...

Public Member Functions
	__construct (ServiceOptions $options, CentralIdLookup $centralIdLookup, IConnectionProvider $dbProvider)
	deleteBotPassword (BotPassword $botPassword)
	Delete an existing BotPassword in the database.
	getByCentralId (int $centralId, string $appId, int $flags=IDBAccessObject::READ_NORMAL)
	Load a BotPassword from the database.
	getByUser (UserIdentity $userIdentity, string $appId, int $flags=IDBAccessObject::READ_NORMAL)
	Load a BotPassword from the database based on a UserIdentity object.
	getPrimaryDatabase ()
	Get a database connection for the bot passwords database.
	getReplicaDatabase ()
	Get a database connection for the bot passwords database.
	insertBotPassword (BotPassword $botPassword, ?Password $password=null)
	Save the new BotPassword to the database.
	invalidateUserPasswords (string $username)
	Invalidate all passwords for a user, by name.
	newUnsavedBotPassword (array $data, int $flags=IDBAccessObject::READ_NORMAL)
	Create an unsaved BotPassword.
	removeUserPasswords (string $username)
	Remove all passwords for a user, by name.
	updateBotPassword (BotPassword $botPassword, ?Password $password=null)
	Update an existing BotPassword in the database.

Public Attributes
const	CONSTRUCTOR_OPTIONS

Detailed Description

BotPassword interaction with databases.

Author

DannyS712

Since

1.37

Definition at line 29 of file BotPasswordStore.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\User\BotPasswordStore::__construct	(	ServiceOptions	$options,
		CentralIdLookup	$centralIdLookup,
		IConnectionProvider	$dbProvider )

Parameters

ServiceOptions	$options
CentralIdLookup	$centralIdLookup
IConnectionProvider	$dbProvider

Definition at line 47 of file BotPasswordStore.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

deleteBotPassword()

MediaWiki\User\BotPasswordStore::deleteBotPassword

(

BotPassword

$botPassword

)

Delete an existing BotPassword in the database.

Parameters

BotPassword

$botPassword

Returns

bool

Definition at line 318 of file BotPasswordStore.php.

getByCentralId()

MediaWiki\User\BotPasswordStore::getByCentralId	(	int	$centralId,
		string	$appId,
		int	$flags = IDBAccessObject::READ_NORMAL )

Load a BotPassword from the database.

Parameters

int	$centralId	from CentralIdLookup
string	$appId
int	$flags	IDBAccessObject read flags

Returns

BotPassword|null

Definition at line 107 of file BotPasswordStore.php.

getByUser()

MediaWiki\User\BotPasswordStore::getByUser	(	UserIdentity	$userIdentity,
		string	$appId,
		int	$flags = IDBAccessObject::READ_NORMAL )

Load a BotPassword from the database based on a UserIdentity object.

Parameters

UserIdentity	$userIdentity
string	$appId
int	$flags	IDBAccessObject read flags

Returns

BotPassword|null

Definition at line 83 of file BotPasswordStore.php.

getPrimaryDatabase()

MediaWiki\User\BotPasswordStore::getPrimaryDatabase

(

)

Get a database connection for the bot passwords database.

Returns

IDatabase

Access: internal

Definition at line 72 of file BotPasswordStore.php.

getReplicaDatabase()

MediaWiki\User\BotPasswordStore::getReplicaDatabase

(

)

Get a database connection for the bot passwords database.

Returns

IReadableDatabase

Access: internal

Definition at line 63 of file BotPasswordStore.php.

insertBotPassword()

MediaWiki\User\BotPasswordStore::insertBotPassword	(	BotPassword	$botPassword,
		?Password	$password = null )

Save the new BotPassword to the database.

Access: internal

Parameters

BotPassword	$botPassword
Password | null	$password	Use null for an invalid password

Returns

StatusValue if everything worked, the value of the StatusValue is the new token

Definition at line 202 of file BotPasswordStore.php.

invalidateUserPasswords()

MediaWiki\User\BotPasswordStore::invalidateUserPasswords

(

string

$username

)

Invalidate all passwords for a user, by name.

Parameters

string

$username

Returns

bool Whether any passwords were invalidated

Definition at line 334 of file BotPasswordStore.php.

newUnsavedBotPassword()

MediaWiki\User\BotPasswordStore::newUnsavedBotPassword	(	array	$data,
		int	$flags = IDBAccessObject::READ_NORMAL )

Create an unsaved BotPassword.

Parameters

array	$data	Data to use to create the bot password. Keys are: user: (UserIdentity) UserIdentity to create the password for. Overrides username and centralId. username: (string) Username to create the password for. Overrides centralId. centralId: (int) User central ID to create the password for. appId: (string, required) App ID for the password. restrictions: (MWRestrictions, optional) Restrictions. grants: (string[], optional) Grants.
int	$flags	IDBAccessObject read flags

Returns

BotPassword|null

Definition at line 142 of file BotPasswordStore.php.

removeUserPasswords()

MediaWiki\User\BotPasswordStore::removeUserPasswords

(

string

$username

)

Remove all passwords for a user, by name.

Parameters

string

$username

Returns

bool Whether any passwords were removed

Definition at line 362 of file BotPasswordStore.php.

updateBotPassword()

MediaWiki\User\BotPasswordStore::updateBotPassword	(	BotPassword	$botPassword,
		?Password	$password = null )

Update an existing BotPassword in the database.

Access: internal

Parameters

BotPassword	$botPassword
Password | null	$password	Use null for an invalid password

Returns

StatusValue if everything worked, the value of the StatusValue is the new token

Definition at line 248 of file BotPasswordStore.php.

Member Data Documentation

CONSTRUCTOR_OPTIONS

const MediaWiki\User\BotPasswordStore::CONSTRUCTOR_OPTIONS

Initial value:

= [
        MainConfigNames::EnableBotPasswords,
    ]

Access: internal

For use by ServiceWiring

Definition at line 34 of file BotPasswordStore.php.

---

The documentation for this class was generated from the following file:

• includes/User/BotPasswordStore.php