Class Auth_Signup

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.php,v 1.38.2.23 2009/08/13 15:43:57 jan Exp $

Copyright 2002-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.php (line 22)


	
			
Direct descendents
Class Description
 class Auth_Signup_datatree 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.
 class Auth_Signup_sql 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.
Method Summary
 mixed addSignup ( &$info)
 Auth_Signup factory ([string $driver = null], [array $params = null])
 object The getQueuedSignup (string $username)
 array getQueuedSignups ()
 object A newSignup (string $name)
 mixed queueSignup ( &$info)
 void removeQueuedSignup (string $username)
 mixed &_queueSignup ( &$info)
Methods
addSignup (line 73)

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

  • return: PEAR_Error if any errors, otherwise true.
mixed addSignup ( &$info)
  • &$info
factory (line 37)

Attempts to return a concrete Auth_Signup instance based on $driver.

  • return: The newly created concrete Auth_Signup instance, or false on an error.
Auth_Signup factory ([string $driver = null], [array $params = null])
  • string $driver: The type of the concrete Auth_Signup subclass to return. The class name is based on the storage driver ($driver). The code is dynamically included.
  • array $params: A hash containing any additional configuration or connection parameters a subclass might need.
getQueuedSignup (line 206)

Get a user's queued signup information.

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

Redefined in descendants as:
getQueuedSignups (line 216)

Get the queued information for all pending signups.

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

Redefined in descendants as:
newSignup (line 238)

Return a new signup object.

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

Redefined in descendants as:
queueSignup (line 120)

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

  • return: PEAR_Error if any errors, otherwise true.
mixed queueSignup ( &$info)
  • &$info
removeQueuedSignup (line 226)

Remove a queued signup.

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

Redefined in descendants as:
_queueSignup (line 194)

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

  • return: PEAR_Error if any errors, otherwise true.
mixed &_queueSignup ( &$info)
  • &$info

Redefined in descendants as:

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