Class Auth_Signup_sql

Description

Auth_Signup:: This class provides an interface to sign up or have new users sign themselves up into the horde installation, depending on how the admin has configured Horde.

$Horde: framework/Auth/Auth/Signup/sql.php,v 1.3.2.6 2010/07/28 08:55:33 jan Exp $

Copyright 2008-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://opensource.org/licenses/lgpl-license.php.

Located in /Auth/Auth/Signup/sql.php (line 21)

Auth_Signup
   |
   --Auth_Signup_sql
Variable Summary
 DB $_db
 mixed $_params
Method Summary
 Auth_Signup_sql Auth_Signup_sql ( $params)
 boolean exists (string $user)
 SQLObject_Signup getQueuedSignup (string $username)
 array getQueuedSignups ()
 SQLObject_Signup newSignup (string $name)
 void removeQueuedSignup (string $username)
 boolean _connect ()
 void _queueSignup ( $signup)
Variables
DB $_db (line 28)

Handle for the current database connection.

mixed $_params = array() (line 41)

SQL connection parameters

DB $_write_db (line 36)

Handle for the current database connection, used for writing. Defaults to the same handle as $db if a separate write database is not required.

Methods
Constructor Auth_Signup_sql (line 46)

Connect to DB

Auth_Signup_sql Auth_Signup_sql ( $params)
  • $params
exists (line 87)

Checks if a user exists in the system.

  • return: True if the user exists.
boolean exists (string $user)
  • string $user: The user to check.
getQueuedSignup (line 117)

Get a user's queued signup information.

  • return: The SQLObject for the requested signup.
SQLObject_Signup getQueuedSignup (string $username)
  • string $username: The username to retrieve the queued info for.

Redefinition of:
Auth_Signup::getQueuedSignup()
Get a user's queued signup information.
getQueuedSignups (line 151)

Get the queued information for all pending signups.

  • return: An array of SQLObject_Signup objects, one for each signup in the queue.
array getQueuedSignups ()

Redefinition of:
Auth_Signup::getQueuedSignups()
Get the queued information for all pending signups.
newSignup (line 203)

Return a new signup object.

  • return: A new signup object.
SQLObject_Signup newSignup (string $name)
  • string $name: The signups's name.

Redefinition of:
Auth_Signup::newSignup()
Return a new signup object.
removeQueuedSignup (line 179)

Remove a queued signup.

void removeQueuedSignup (string $username)
  • string $username: The user to remove from the signup queue.

Redefinition of:
Auth_Signup::removeQueuedSignup()
Remove a queued signup.
_connect (line 216)

Attempts to open a connection to the sql server.

  • return: True on success; exits (Horde::fatal()) on error.
boolean _connect ()
_queueSignup (line 57)

Stores the signup data in the backend.

void _queueSignup ( $signup)
  • $signup

Redefinition of:
Auth_Signup::_queueSignup()
Queues the user's submitted registration info for later admin approval.

Inherited Methods

Inherited From Auth_Signup

 Auth_Signup::addSignup()
 Auth_Signup::factory()
 Auth_Signup::getQueuedSignup()
 Auth_Signup::getQueuedSignups()
 Auth_Signup::newSignup()
 Auth_Signup::queueSignup()
 Auth_Signup::removeQueuedSignup()
 Auth_Signup::_queueSignup()

Documentation generated on Sun, 30 Jan 2011 05:21:46 +0000 by phpDocumentor 1.4.3