Diviner Tech Docs PhabricatorUserEditor

final class PhabricatorUserEditor
Phorge Technical Documentation (People)

Editor class for creating and adjusting users. This class guarantees data integrity and writes logs when user information changes.

Tasks

Configuration

No methods for this task.

Creating and Editing Users

public function createNewUser($user, $email, $allow_reassign)

Editing Roles

public function makeSystemAgentUser($user, $system_agent)
public function makeMailingListUser($user, $mailing_list)

Adding, Removing and Changing Email

public function addEmail($user, $email)
public function removeEmail($user, $email)
public function changePrimaryEmail($user, $email)
public function verifyEmail($user, $email) — Verify a user's email address.

Internals

private function willAddEmail($email)

Other Methods

public function __get($name)
public function __set($name, $value)
public function current()
public function key()
public function next()
public function rewind()
public function valid()
private function throwOnAttemptedIteration()
public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.
final public function setActor($actor)
final public function getActor()
final public function requireActor()
final public function setExcludeMailRecipientPHIDs($phids)
final protected function getExcludeMailRecipientPHIDs()
public function reassignEmail($user, $email) — Reassign an unverified email address.
public function revokePasswordResetLinks($user)
private function didVerifyEmail($user, $email)

Methods

public function __get($name)
Inherited

This method is not documented.

Parameters

$name

Return

wild

public function __set($name, $value)
Inherited

This method is not documented.

Parameters

	$name
	$value

Return

wild

public function current()
Inherited

This method is not documented.

Return

wild

public function key()
Inherited

This method is not documented.

Return

wild

public function next()
Inherited

This method is not documented.

Return

wild

public function rewind()
Inherited

This method is not documented.

Return

wild

public function valid()
Inherited

This method is not documented.

Return

wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.

Return

wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters

string	$key	Name of the constant.
int\|null	$byte_limit	Maximum number of bytes permitted in the value.

Return

string

Value of the constant.

final public function setActor($actor)
Inherited

This method is not documented.

Parameters

PhabricatorUser

$actor

Return

wild

final public function getActor()
Inherited

This method is not documented.

Return

wild

final public function requireActor()
Inherited

This method is not documented.

Return

wild

final public function setExcludeMailRecipientPHIDs($phids)
Inherited

This method is not documented.

Parameters

$phids

Return

wild

final protected function getExcludeMailRecipientPHIDs()
Inherited

This method is not documented.

Return

wild

public function createNewUser($user, $email, $allow_reassign)

This method is not documented.

Parameters

PhabricatorUser	$user
PhabricatorUserEmail	$email
	$allow_reassign

Return

wild

public function makeSystemAgentUser($user, $system_agent)

This method is not documented.

Parameters

PhabricatorUser	$user
	$system_agent

Return

wild

public function makeMailingListUser($user, $mailing_list)

This method is not documented.

Parameters

PhabricatorUser	$user
	$mailing_list

Return

wild

public function addEmail($user, $email)

This method is not documented.

Parameters

PhabricatorUser	$user
PhabricatorUserEmail	$email

Return

wild

public function removeEmail($user, $email)

This method is not documented.

Parameters

PhabricatorUser	$user
PhabricatorUserEmail	$email

Return

wild

public function changePrimaryEmail($user, $email)

This method is not documented.

Parameters

PhabricatorUser	$user
PhabricatorUserEmail	$email

Return

wild

public function verifyEmail($user, $email)

Verify a user's email address.

This verifies an individual email address. If the address is the user's primary address and their account was not previously verified, their account is marked as email verified.

Parameters

PhabricatorUser	$user
PhabricatorUserEmail	$email

Return

wild

public function reassignEmail($user, $email)

Reassign an unverified email address.

Parameters

PhabricatorUser	$user
PhabricatorUserEmail	$email

Return

wild

private function willAddEmail($email)

This method is not documented.

Parameters

PhabricatorUserEmail

$email

Return

wild

public function revokePasswordResetLinks($user)

This method is not documented.

Parameters

PhabricatorUser

$user

Return

wild

private function didVerifyEmail($user, $email)

This method is not documented.

Parameters

PhabricatorUser	$user
PhabricatorUserEmail	$email

Return

wild

Defined: src/applications/people/editor/PhabricatorUserEditor.php:13
Extends: PhobjectPhabricatorEditor

final class PhabricatorUserEditorPhorge Technical Documentation (People)

Tasks

Configuration

Creating and Editing Users

Editing Roles

Adding, Removing and Changing Email

Internals

Other Methods

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

final public function setActor($actor)Inherited

final public function getActor()Inherited

final public function requireActor()Inherited

final public function setExcludeMailRecipientPHIDs($phids)Inherited

final protected function getExcludeMailRecipientPHIDs()Inherited

public function createNewUser($user, $email, $allow_reassign)

public function makeSystemAgentUser($user, $system_agent)

public function makeMailingListUser($user, $mailing_list)

public function addEmail($user, $email)

public function removeEmail($user, $email)

public function changePrimaryEmail($user, $email)

public function verifyEmail($user, $email)

public function reassignEmail($user, $email)

private function willAddEmail($email)

public function revokePasswordResetLinks($user)

private function didVerifyEmail($user, $email)

final class PhabricatorUserEditor
Phorge Technical Documentation (People)

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

final public function setActor($actor)
Inherited

final public function getActor()
Inherited

final public function requireActor()
Inherited

final public function setExcludeMailRecipientPHIDs($phids)
Inherited

final protected function getExcludeMailRecipientPHIDs()
Inherited