MediaWiki  1.34.4
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables Class Reference
Collaboration diagram for MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables:
Collaboration graph
[legend]

Public Member Functions

 schemaUpdateOldUsersFromInstaller (DatabaseUpdater $updater)
 Helper function for converting old users to the new schema. More...
 

Static Public Member Functions

static callback ( $updater)
 
static convertToGenericFields (IDatabase $db)
 Converts old, TOTP specific, column values to new structure. More...
 
static schemaUpdateOldUsers (IDatabase $db)
 Helper function for converting old users to the new schema. More...
 
static schemaUpdateSubstituteForGenericFields (DatabaseUpdater $updater)
 Helper function for converting old, TOTP specific, column values to new structure. More...
 
static schemaUpdateTOTPToMultipleKeys (DatabaseUpdater $updater)
 Helper function for converting single TOTP keys to multi-key system. More...
 
static switchTOTPToMultipleKeys (IDatabase $db)
 Switch from using single keys to multi-key support. More...
 

Protected Member Functions

 __construct ( $updater, $base)
 
 execute ()
 

Protected Attributes

string $base
 
DatabaseUpdater $updater
 

Detailed Description

Definition at line 12 of file UpdateTables.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables::__construct (   $updater,
  $base 
)
protected
Parameters
DatabaseUpdater$updater
string$base

Definition at line 37 of file UpdateTables.php.

References MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables\$base, and MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables\$updater.

Member Function Documentation

◆ callback()

static MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables::callback (   $updater)
static
Parameters
DatabaseUpdater$updater
Returns
bool

Definition at line 27 of file UpdateTables.php.

References MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables\$updater.

◆ convertToGenericFields()

static MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables::convertToGenericFields ( IDatabase  $db)
static

Converts old, TOTP specific, column values to new structure.

Parameters
IDatabase$db
Returns
bool
Exceptions
ConfigException

Definition at line 135 of file UpdateTables.php.

References $res, FormatJson\encode(), Wikimedia\Rdbms\IDatabase\fieldExists(), MediaWiki\MediaWikiServices\getInstance(), Wikimedia\Rdbms\IDatabase\select(), and Wikimedia\Rdbms\IDatabase\update().

Referenced by MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables\schemaUpdateSubstituteForGenericFields().

◆ execute()

MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables::execute ( )
protected

Definition at line 42 of file UpdateTables.php.

◆ schemaUpdateOldUsers()

static MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables::schemaUpdateOldUsers ( IDatabase  $db)
static

Helper function for converting old users to the new schema.

Parameters
IDatabase$db
Returns
bool

Definition at line 230 of file UpdateTables.php.

References $res, Wikimedia\Rdbms\IDatabase\delete(), Wikimedia\Rdbms\IDatabase\fieldExists(), Wikimedia\Rdbms\IDatabase\select(), unserialize(), and Wikimedia\Rdbms\IDatabase\update().

Referenced by MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables\schemaUpdateOldUsersFromInstaller().

◆ schemaUpdateOldUsersFromInstaller()

MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables::schemaUpdateOldUsersFromInstaller ( DatabaseUpdater  $updater)

Helper function for converting old users to the new schema.

Parameters
DatabaseUpdater$updater
Returns
bool

Definition at line 93 of file UpdateTables.php.

References DB_MASTER, MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables\schemaUpdateOldUsers().

◆ schemaUpdateSubstituteForGenericFields()

static MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables::schemaUpdateSubstituteForGenericFields ( DatabaseUpdater  $updater)
static

Helper function for converting old, TOTP specific, column values to new structure.

Parameters
DatabaseUpdater$updater
Returns
bool
Exceptions
ConfigException

Definition at line 107 of file UpdateTables.php.

References MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables\convertToGenericFields(), DB_MASTER, and MediaWiki\MediaWikiServices\getInstance().

◆ schemaUpdateTOTPToMultipleKeys()

static MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables::schemaUpdateTOTPToMultipleKeys ( DatabaseUpdater  $updater)
static

Helper function for converting single TOTP keys to multi-key system.

Parameters
DatabaseUpdater$updater
Returns
bool
Exceptions
ConfigException

Definition at line 121 of file UpdateTables.php.

References DB_MASTER, MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables\switchTOTPToMultipleKeys().

◆ switchTOTPToMultipleKeys()

static MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables::switchTOTPToMultipleKeys ( IDatabase  $db)
static

Switch from using single keys to multi-key support.

Parameters
IDatabase$db
Returns
bool
Exceptions
ConfigException

Definition at line 190 of file UpdateTables.php.

References $res, FormatJson\decode(), FormatJson\encode(), Wikimedia\Rdbms\IDatabase\fieldExists(), Wikimedia\Rdbms\IDatabase\select(), and Wikimedia\Rdbms\IDatabase\update().

Referenced by MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables\schemaUpdateTOTPToMultipleKeys().

Member Data Documentation

◆ $base

string MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables::$base
protected

Definition at line 21 of file UpdateTables.php.

Referenced by MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables\__construct().

◆ $updater

DatabaseUpdater MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables::$updater
protected

Definition at line 16 of file UpdateTables.php.

Referenced by MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables\__construct(), and MediaWiki\Extension\OATHAuth\Hook\LoadExtensionSchemaUpdates\UpdateTables\callback().

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