Elgg  Version 4.3
Static Public Member Functions | List of all members
Elgg\Users\Validation Class Reference

User Validation related hooks/events. More...

Static Public Member Functions

static notifyUserAfterValidation (\Elgg\Event $event)
 Notify the user that their account is approved. More...
 
static checkAdminValidation (\Elgg\Hook $hook)
 Check if new users need to be validated by an administrator. More...
 
static notifyAdminsAboutPendingUsers (\Elgg\Hook $hook)
 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\Hook $hook)
 Set the correct forward url after user registration. More...
 
static removeUnvalidatedUsers (\Elgg\Hook $hook)
 Remove unvalidated users after x days. More...
 

Detailed Description

User Validation related hooks/events.

Since
4.0

Definition at line 13 of file Validation.php.

Member Function Documentation

static Elgg\Users\Validation::checkAdminValidation ( \Elgg\Hook  $hook)
static

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

Parameters
\Elgg\Hook$hook'register', 'user'
Returns
void

Definition at line 57 of file Validation.php.

static Elgg\Users\Validation::notifyAdminsAboutPendingUsers ( \Elgg\Hook  $hook)
static

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

Parameters
\Elgg\Hook$hookvarious hooks
Returns
void

Definition at line 95 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 153 of file Validation.php.

static Elgg\Users\Validation::removeUnvalidatedUsers ( \Elgg\Hook  $hook)
static

Remove unvalidated users after x days.

Parameters
\Elgg\Hook$hook'cron', 'daily'
Returns
void
Since
4.2

Definition at line 210 of file Validation.php.

static Elgg\Users\Validation::setRegistrationForwardUrl ( \Elgg\Hook  $hook)
static

Set the correct forward url after user registration.

Parameters
\Elgg\Hook$hook'response', 'action:register'
Returns
void|ResponseBuilder

Definition at line 180 of file Validation.php.


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