API Documentation
\

\Horde_Core_Auth_Signup_Sql

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

Summary

Methods
Properties
Constants
addSignup()
queueSignup()
exists()
getQueuedSignup()
getQueuedSignups()
removeQueuedSignup()
newSignup()
__construct()
No public properties found
No constants found
_preSignup()
_queueSignup()
$_params
N/A
No private methods found
No private properties found
N/A

Properties

$_params

$_params : array

Configuration parameters.

Type

array

Methods

addSignup()

addSignup(mixed  $info)

Adds a new user to the system and handles any extra fields that may have been compiled, relying on the hooks.php file.

Parameters

mixed $info

Reference to array of parameters to be passed to hook.

Throws

\Horde_Exception

queueSignup()

queueSignup(mixed  $info)

Queues the user's submitted registration info for later admin approval.

Parameters

mixed $info

Reference to array of parameters to be passed to hook.

Throws

\Horde_Exception
\Horde_Mime_Exception

exists()

exists(string  $user) : boolean

Checks if a user exists in the system.

Parameters

string $user

The user to check.

Throws

\Horde_Db_Exception

Returns

boolean —

True if the user exists.

getQueuedSignup()

getQueuedSignup(string  $username) : \Horde_Core_Auth_Signup_SqlObject

Get a user's queued signup information.

Parameters

string $username

The username to retrieve the queued info for.

Throws

\Horde_Exception
\Horde_Db_Exception

Returns

\Horde_Core_Auth_Signup_SqlObject —

$signup The object for the requested signup.

getQueuedSignups()

getQueuedSignups() : array

Get the queued information for all pending signups.

Throws

\Horde_Db_Exception

Returns

array —

An array of signup objects, one for each signup in the queue.

removeQueuedSignup()

removeQueuedSignup(string  $username)

Remove a queued signup.

Parameters

string $username

The user to remove from the signup queue.

Throws

\Horde_Db_Exception

newSignup()

newSignup(string  $name) : \Horde_Core_Auth_Signup_SqlObject

Return a new signup object.

Parameters

string $name

The signups's name.

Throws

\InvalidArgumentException

Returns

\Horde_Core_Auth_Signup_SqlObject —

A new signup object.

__construct()

__construct()

Constructor.

_preSignup()

_preSignup(array  $info)

Perform common presignup actions.

Parameters

array $info

Reference to array of parameters.

Throws

\Horde_Exception

_queueSignup()

_queueSignup(\Horde_Core_Auth_Signup_SqlObject  $signup)

Stores the signup data in the backend.

Parameters

\Horde_Core_Auth_Signup_SqlObject $signup

Signup data.

Throws

\Horde_Db_Exception