MediaWiki\Extension\Translate\TranslatorSandbox\TranslateSandbox Class Reference

Utility class for the sandbox feature of Translate. More...

Public Member Functions
	__construct (UserFactory $userFactory, ILoadBalancer $loadBalancer, PermissionManager $permissionManager, AuthManager $authManager, UserGroupManager $userGroupManager, ActorStore $actorStore, UserOptionsManager $userOptionsManager, JobQueueGroup $jobQueueGroup, HookRunner $hookRunner, ServiceOptions $options)
	addUser (string $name, string $email, string $password)
	Adds a new user without doing much validation.
	deleteUser (User $user, string $force='')
	Deletes a sandboxed user without doing much validation.
	getUsers ()
	Get all sandboxed users.
	promoteUser (User $user)
	Removes the user from the sandbox.
	sendEmail (User $sender, User $target, string $type)
	Sends a reminder to the user.

Static Public Member Functions
static	isSandboxed (User $user)
	Shortcut for checking if given user is in the sandbox.

Public Attributes
const	CONSTRUCTOR_OPTIONS
const	USER_CREATION_FAILURE = 56739
	Custom exception code used when user creation fails in order to differentiate between other exceptions that might occur.

Detailed Description

Utility class for the sandbox feature of Translate.

Do not try this yourself. This code makes a lot of assumptions about what happens to the user account.

Author

Niklas Laxström @license GPL-2.0-or-later

Definition at line 38 of file TranslateSandbox.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Extension\Translate\TranslatorSandbox\TranslateSandbox::__construct	(	UserFactory	$userFactory,
		ILoadBalancer	$loadBalancer,
		PermissionManager	$permissionManager,
		AuthManager	$authManager,
		UserGroupManager	$userGroupManager,
		ActorStore	$actorStore,
		UserOptionsManager	$userOptionsManager,
		JobQueueGroup	$jobQueueGroup,
		HookRunner	$hookRunner,
		ServiceOptions	$options )

Definition at line 55 of file TranslateSandbox.php.

Member Function Documentation

addUser()

MediaWiki\Extension\Translate\TranslatorSandbox\TranslateSandbox::addUser	(	string	$name,
		string	$email,
		string	$password )

Adds a new user without doing much validation.

Definition at line 87 of file TranslateSandbox.php.

deleteUser()

MediaWiki\Extension\Translate\TranslatorSandbox\TranslateSandbox::deleteUser	(	User	$user,
		string	$force = '' )

Deletes a sandboxed user without doing much validation.

Parameters

User	$user
string	$force	If set to 'force' will skip the little validation we have.

Exceptions

UserNotSandboxedException

Definition at line 148 of file TranslateSandbox.php.

getUsers()

MediaWiki\Extension\Translate\TranslatorSandbox\TranslateSandbox::getUsers

(

)

Get all sandboxed users.

Definition at line 182 of file TranslateSandbox.php.

isSandboxed()

static MediaWiki\Extension\Translate\TranslatorSandbox\TranslateSandbox::isSandboxed ( User $user )

static

Shortcut for checking if given user is in the sandbox.

Definition at line 284 of file TranslateSandbox.php.

promoteUser()

MediaWiki\Extension\Translate\TranslatorSandbox\TranslateSandbox::promoteUser

(

User

$user

)

Removes the user from the sandbox.

Exceptions

UserNotSandboxedException

Definition at line 198 of file TranslateSandbox.php.

sendEmail()

MediaWiki\Extension\Translate\TranslatorSandbox\TranslateSandbox::sendEmail	(	User	$sender,
		User	$target,
		string	$type )

Sends a reminder to the user.

Parameters

User	$sender
User	$target
string	$type	'reminder' or 'promotion'

Exceptions

UserNotSandboxedException

Definition at line 223 of file TranslateSandbox.php.

Member Data Documentation

CONSTRUCTOR_OPTIONS

const MediaWiki\Extension\Translate\TranslatorSandbox\TranslateSandbox::CONSTRUCTOR_OPTIONS

Initial value:

= [
        'EmergencyContact',
        'TranslateSandboxPromotedGroup',
    ]

Definition at line 39 of file TranslateSandbox.php.

USER_CREATION_FAILURE

const MediaWiki\Extension\Translate\TranslatorSandbox\TranslateSandbox::USER_CREATION_FAILURE = 56739

Custom exception code used when user creation fails in order to differentiate between other exceptions that might occur.

Definition at line 84 of file TranslateSandbox.php.

---

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

• src/TranslatorSandbox/TranslateSandbox.php