Elgg\Users\Validation Class Reference

User Validation related events. More...

Static Public Member Functions
static	notifyUserAfterValidation (\Elgg\Event $event)
	Notify the user that their account is approved. More...
static	addRiverActivityAfterValidation (\Elgg\Event $event)
	Adds river activity that a new user joined the site. More...
static	checkAdminValidation (\Elgg\Event $event)
	Check if new users need to be validated by an administrator. More...
static	notifyAdminsAboutPendingUsers (\Elgg\Event $event)
	Send a notification to all admins that there are pending user validations. More...
static	preventUserLogin (\Elgg\Event $event)
	Prevent unvalidated users from logging in. More...
static	setRegistrationForwardUrl (\Elgg\Event $event)
	Set the correct forward url after user registration. More...
static	removeUnvalidatedUsers (\Elgg\Event $event)
	Remove unvalidated users after x days. More...

Detailed Description

User Validation related events.

Since

4.0

Definition at line 13 of file Validation.php.

Member Function Documentation

static Elgg\Users\Validation::addRiverActivityAfterValidation ( \Elgg\Event  $event )

static

Adds river activity that a new user joined the site.

Parameters

\Elgg\Event

$event

'validate:after', 'user'

Returns

void

Definition at line 57 of file Validation.php.

static Elgg\Users\Validation::checkAdminValidation ( \Elgg\Event  $event )

static

Check if new users need to be validated by an administrator.

Parameters

\Elgg\Event

$event

'register', 'user'

Returns

void

Definition at line 76 of file Validation.php.

static Elgg\Users\Validation::notifyAdminsAboutPendingUsers ( \Elgg\Event  $event )

static

Send a notification to all admins that there are pending user validations.

Parameters

\Elgg\Event

$event

various events

Returns

void

Definition at line 114 of file Validation.php.

static Elgg\Users\Validation::notifyUserAfterValidation ( \Elgg\Event  $event )

static

Notify the user that their account is approved.

Parameters

\Elgg\Event

$event

'validate:after', 'user'

Returns

void

Definition at line 22 of file Validation.php.

static Elgg\Users\Validation::preventUserLogin ( \Elgg\Event  $event )

static

Prevent unvalidated users from logging in.

Parameters

\Elgg\Event

$event

'login:before', 'user'

Returns

void

Exceptions

LoginException

Definition at line 172 of file Validation.php.

static Elgg\Users\Validation::removeUnvalidatedUsers ( \Elgg\Event  $event )

static

Remove unvalidated users after x days.

Parameters

\Elgg\Event

$event

'cron', 'daily'

Returns

void

Since

4.2

Definition at line 229 of file Validation.php.

static Elgg\Users\Validation::setRegistrationForwardUrl ( \Elgg\Event  $event )

static

Set the correct forward url after user registration.

Parameters

\Elgg\Event

$event

'response', 'action:register'

Returns

void|ResponseBuilder

Definition at line 199 of file Validation.php.

---

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

• engine/classes/Elgg/Users/Validation.php