Inheritance diagram for MediaWiki\User\BotPasswordStore:

Collaboration diagram for MediaWiki\User\BotPasswordStore:

[legend]

Public Member Functions
	__construct (ServiceOptions $options, CentralIdLookup $centralIdLookup, LBFactory $lbFactory)

	deleteBotPassword (BotPassword $botPassword)
	Delete an existing BotPassword in the database.

	getByCentralId (int $centralId, string $appId, int $flags=self::READ_NORMAL)
	Load a BotPassword from the database.

	getByUser (UserIdentity $userIdentity, string $appId, int $flags=self::READ_NORMAL)
	Load a BotPassword from the database based on a UserIdentity object.

	getDatabase (int $db)
	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=self::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

Public Attributes inherited from IDBAccessObject
const	READ_NONE = -1
	Constants for object loading bitfield flags (higher => higher QoS)

Private Member Functions
	validateBotPassword (BotPassword $botPassword)
	Check if a BotPassword is valid to save in the database (either inserting a new one or updating an existing one) based on the size of the restrictions and grants.

Private Attributes
CentralIdLookup	$centralIdLookup

LBFactory	$lbFactory

ServiceOptions	$options

Detailed Description

Author: DannyS712

Since: 1.37

Definition at line 44 of file BotPasswordStore.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\User\BotPasswordStore::__construct	(	ServiceOptions	$options,
		CentralIdLookup	$centralIdLookup,
		LBFactory	$lbFactory
	)

Parameters

ServiceOptions	$options
CentralIdLookup	$centralIdLookup
LBFactory	$lbFactory

Definition at line 69 of file BotPasswordStore.php.

References MediaWiki\User\BotPasswordStore\$centralIdLookup, MediaWiki\User\BotPasswordStore\$lbFactory, MediaWiki\User\BotPasswordStore\$options, and 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 353 of file BotPasswordStore.php.

◆ getByCentralId()

MediaWiki\User\BotPasswordStore::getByCentralId	(	int	$centralId,
		string	$appId,
		int	$flags = `self::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 134 of file BotPasswordStore.php.

◆ getByUser()

MediaWiki\User\BotPasswordStore::getByUser	(	UserIdentity	$userIdentity,
		string	$appId,
		int	$flags = `self::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 110 of file BotPasswordStore.php.

◆ getDatabase()

MediaWiki\User\BotPasswordStore::getDatabase ( int $db )

Get a database connection for the bot passwords database.

Parameters

int $db Index of the connection to get, e.g. DB_PRIMARY or DB_REPLICA.

Returns: IDatabase

Access: internal

Definition at line 86 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 227 of file BotPasswordStore.php.

References $res.

◆ invalidateUserPasswords()

MediaWiki\User\BotPasswordStore::invalidateUserPasswords ( string $username )

Invalidate all passwords for a user, by name.

Parameters

string $username User name

Returns: bool Whether any passwords were invalidated

Definition at line 372 of file BotPasswordStore.php.

◆ newUnsavedBotPassword()

MediaWiki\User\BotPasswordStore::newUnsavedBotPassword	(	array	$data,
		int	$flags = `self::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 167 of file BotPasswordStore.php.

◆ removeUserPasswords()

MediaWiki\User\BotPasswordStore::removeUserPasswords ( string $username )

Remove all passwords for a user, by name.

Parameters

string $username User name

Returns: bool Whether any passwords were removed

Definition at line 401 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 281 of file BotPasswordStore.php.

References $res.

◆ validateBotPassword()

MediaWiki\User\BotPasswordStore::validateBotPassword ( BotPassword $botPassword )

private

Check if a BotPassword is valid to save in the database (either inserting a new one or updating an existing one) based on the size of the restrictions and grants.

Parameters

BotPassword $botPassword

Returns: StatusValue

Definition at line 331 of file BotPasswordStore.php.

References $res.

Member Data Documentation

◆ $centralIdLookup

CentralIdLookup MediaWiki\User\BotPasswordStore::$centralIdLookup

private

Definition at line 62 of file BotPasswordStore.php.

Referenced by MediaWiki\User\BotPasswordStore\__construct().

◆ $lbFactory

LBFactory MediaWiki\User\BotPasswordStore::$lbFactory

private

Definition at line 59 of file BotPasswordStore.php.

Referenced by MediaWiki\User\BotPasswordStore\__construct().

◆ $options

ServiceOptions MediaWiki\User\BotPasswordStore::$options

private

Definition at line 56 of file BotPasswordStore.php.

Referenced by MediaWiki\User\BotPasswordStore\__construct().

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\User\BotPasswordStore::CONSTRUCTOR_OPTIONS

Initial value:

= [
        'EnableBotPasswords',
        'BotPasswordsCluster',
        'BotPasswordsDatabase',
    ]

Access: internal: For use by ServiceWiring

Definition at line 49 of file BotPasswordStore.php.

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

includes/user/BotPasswordStore.php

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteBotPassword()

◆ getByCentralId()

◆ getByUser()

◆ getDatabase()

◆ insertBotPassword()

◆ invalidateUserPasswords()

◆ newUnsavedBotPassword()

◆ removeUserPasswords()

◆ updateBotPassword()

◆ validateBotPassword()

Member Data Documentation

◆ $centralIdLookup

◆ $lbFactory

◆ $options

◆ CONSTRUCTOR_OPTIONS