Horde_Core_Auth_Signup_Sql
extends Horde_Core_Auth_Signup_Base
in package
The SQL implementation of Horde_Core_Auth_Signup.
Copyright 2008-2017 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://opensource.org/licenses/lgpl-2.1.php
Tags
Table of Contents
Properties
- $_params : array<string|int, mixed>
- Configuration parameters.
Methods
- __construct() : mixed
- Constructor.
- addSignup() : mixed
- Adds a new user to the system and handles any extra fields that may have been compiled, relying on the hooks.php file.
- exists() : bool
- Checks if a user exists in the system.
- getQueuedSignup() : Horde_Core_Auth_Signup_SqlObject
- Get a user's queued signup information.
- getQueuedSignups() : array<string|int, mixed>
- Get the queued information for all pending signups.
- newSignup() : Horde_Core_Auth_Signup_SqlObject
- Return a new signup object.
- queueSignup() : mixed
- Queues the user's submitted registration info for later admin approval.
- removeQueuedSignup() : mixed
- Remove a queued signup.
- _preSignup() : mixed
- Perform common presignup actions.
- _queueSignup() : mixed
- Stores the signup data in the backend.
Properties
$_params
Configuration parameters.
protected
array<string|int, mixed>
$_params
= array()
Methods
__construct()
Constructor.
public
__construct() : mixed
addSignup()
Adds a new user to the system and handles any extra fields that may have been compiled, relying on the hooks.php file.
public
addSignup(mixed &$info) : mixed
Parameters
- $info : mixed
-
Reference to array of parameters to be passed to hook.
Tags
exists()
Checks if a user exists in the system.
public
exists(string $user) : bool
Parameters
- $user : string
-
The user to check.
Tags
Return values
bool —True if the user exists.
getQueuedSignup()
Get a user's queued signup information.
public
getQueuedSignup(string $username) : Horde_Core_Auth_Signup_SqlObject
Parameters
- $username : string
-
The username to retrieve the queued info for.
Tags
Return values
Horde_Core_Auth_Signup_SqlObject —$signup The object for the requested signup.
getQueuedSignups()
Get the queued information for all pending signups.
public
getQueuedSignups() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —An array of signup objects, one for each signup in the queue.
newSignup()
Return a new signup object.
public
newSignup(string $name) : Horde_Core_Auth_Signup_SqlObject
Parameters
- $name : string
-
The signups's name.
Tags
Return values
Horde_Core_Auth_Signup_SqlObject —A new signup object.
queueSignup()
Queues the user's submitted registration info for later admin approval.
public
queueSignup(mixed &$info) : mixed
Parameters
- $info : mixed
-
Reference to array of parameters to be passed to hook.
Tags
removeQueuedSignup()
Remove a queued signup.
public
removeQueuedSignup(string $username) : mixed
Parameters
- $username : string
-
The user to remove from the signup queue.
Tags
_preSignup()
Perform common presignup actions.
protected
_preSignup(array<string|int, mixed> &$info) : mixed
Parameters
- $info : array<string|int, mixed>
-
Reference to array of parameters.
Tags
_queueSignup()
Stores the signup data in the backend.
protected
_queueSignup(Horde_Core_Auth_Signup_SqlObject $signup) : mixed
Parameters
- $signup : Horde_Core_Auth_Signup_SqlObject
-
Signup data.