Class Auth_Signup_datatree

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/datatree.php,v 1.1.2.4 2009/11/17 14:17:41 mrubinsk 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/datatree.php (line 21)

Auth_Signup
   |
   --Auth_Signup_datatree
Variable Summary
Method Summary
 Auth_Signup_datatree Auth_Signup_datatree ()
 boolean exists (string $name)
 array getQueuedSignups ()
 void removeQueuedSignup (string $username)
 void _queueSignup ( $signup)
Variables
DataTree $_datatree (line 28)

Pointer to a DataTree instance to manage/store signups

Methods
Constructor Auth_Signup_datatree (line 30)
Auth_Signup_datatree Auth_Signup_datatree ()
exists (line 100)

See if an existing request exists.

boolean exists (string $name)
  • string $name: The signup name.
getQueuedSignup (line 61)

Get a user's queued signup information.

  • return: The DataTreeObject for the requested signup.
DataTreeObject_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 72)

Get the queued information for all pending signups.

  • return: An array of DataTreeObject_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 112)

Return a new signup object.

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

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

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.
_queueSignup (line 48)

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:16:33 +0000 by phpDocumentor 1.4.3