MediaWiki master
Public Member Functions | Public Attributes | List of all members
MediaWiki\RenameUser\RenameUserFactory Class Reference

Public Member Functions

 __construct (ServiceOptions $options, CentralIdLookupFactory $centralIdLookupFactory, JobQueueGroupFactory $jobQueueGroupFactory, MovePageFactory $movePageFactory, UserFactory $userFactory, UserNameUtils $userNameUtils, PermissionManager $permissionManager, TitleFactory $titleFactory)
 
 newDerivedRenameUser (User $performer, int $uid, string $oldName, string $newName, string $reason, array $renameOptions=[])
 Creates a RenameUser for performing a local rename operation derived from a global rename.
 
 newRenameUser (User $performer, $target, string $newName, string $reason, array $renameOptions=[])
 Creates a RenameUser for performing a new rename operation.
 

Public Attributes

const CONSTRUCTOR_OPTIONS = RenameUser::CONSTRUCTOR_OPTIONS
 

Detailed Description

Since
1.44

Definition at line 18 of file RenameUserFactory.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\RenameUser\RenameUserFactory::__construct ( ServiceOptions $options,
CentralIdLookupFactory $centralIdLookupFactory,
JobQueueGroupFactory $jobQueueGroupFactory,
MovePageFactory $movePageFactory,
UserFactory $userFactory,
UserNameUtils $userNameUtils,
PermissionManager $permissionManager,
TitleFactory $titleFactory )

Definition at line 33 of file RenameUserFactory.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ newDerivedRenameUser()

MediaWiki\RenameUser\RenameUserFactory::newDerivedRenameUser ( User $performer,
int $uid,
string $oldName,
string $newName,
string $reason,
array $renameOptions = [] )

Creates a RenameUser for performing a local rename operation derived from a global rename.

The operation must have been performed on central wiki and not locally.

Parameters
User$performer
int$uid
string$oldName
string$newName
string$reason
array$renameOptions
Returns
RenameUser

Definition at line 105 of file RenameUserFactory.php.

◆ newRenameUser()

MediaWiki\RenameUser\RenameUserFactory::newRenameUser ( User $performer,
$target,
string $newName,
string $reason,
array $renameOptions = [] )

Creates a RenameUser for performing a new rename operation.

The operation should not have been performed on any wikis yet.

Parameters
User$performer
User$target
string$newName
string$reason
array$renameOptions
Returns
RenameUser

Definition at line 67 of file RenameUserFactory.php.

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\RenameUser\RenameUserFactory::CONSTRUCTOR_OPTIONS = RenameUser::CONSTRUCTOR_OPTIONS
Access: internal
Use only in ServiceWiring

Definition at line 31 of file RenameUserFactory.php.

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