Docs For Class GalleryPendingUserHelper

Class GalleryPendingUserHelper

Method Summary

GalleryStatus	createGalleryUser()	Create GalleryUser from GalleryPendingUser
array	fetchPendingUserByUserName()	Return the GalleryPendingUser specified by the username
array	fetchUserCount()	Return the total number of pending users
array	fetchUserData()	Return a map of user ids and data
GalleryStatus	sendAdminEmail()	Send notification email to site administrators
GalleryStatus	sendConfirmationEmail()	Send an email with a confirmation link

[ Top ]

Methods

createGalleryUser [line 330]

GalleryStatus createGalleryUser(

&$pendingUser, [boolean
$delete = true], GalleryPendingUser
$pendingUser 
)

Create GalleryUser from GalleryPendingUser

Parameters:

GalleryPendingUser	$pendingUser:
boolean	$delete:	if true delete the GalleryPendingUser
	&$pendingUser:

API Tags:

Return:

a status code

[ Top ]

fetchPendingUserByUserName [line 44]

array fetchPendingUserByUserName(
string
$userName 
)

Return the GalleryPendingUser specified by the username

Parameters:

string

$userName:

API Tags:

Return:

GalleryStatus a status code GalleryPendingUser a pending user

[ Top ]

fetchUserCount [line 77]

array fetchUserCount(
[string
$substring = null] 
)

Return the total number of pending users

Parameters:

string

$substring:

an optional substring to match against the username

API Tags:

Return:

GalleryStatus a status code int number of pending users

[ Top ]

fetchUserData [line 109]

array fetchUserData(
[int
$count = null], [int
$offset = null], [string
$substring = null] 
)

Return a map of user ids and data

You can specify how many usernames to list, and where the windows is in the list of all users.

Parameters:

int	$count:	[optional] the number of usernames desired
int	$offset:	[optional] the start of the range
string	$substring:	[optional] a substring to match

API Tags:

Return:

GalleryStatus a status code array (id => array('userName'=>name, 'fullName'=>name, 'email'=>email), ...)

[ Top ]

sendAdminEmail [line 228]

GalleryStatus sendAdminEmail(

&$pendingUser, GalleryPendingUser
$pendingUser 
)

Send notification email to site administrators

Parameters:

GalleryPendingUser	$pendingUser:
	&$pendingUser:

API Tags:

Return:

a status code

[ Top ]

sendConfirmationEmail [line 156]

GalleryStatus sendConfirmationEmail(

&$pendingUser, [string
$tplFile = 'ConfirmationEmail.tpl'], [string
$subjectParam = 'subject'], [int
$userIdForLocale = null], GalleryPendingUser
$pendingUser 
)

Send an email with a confirmation link

Parameters:

GalleryPendingUser	$pendingUser:
string	$tplFile:	(optional) Path to the template file of the email. Defaults to 'ConfirmationEmail.tpl'.
string	$subjectParam:	(optional) Name of the module parameter to use as subject of the email. Defaults to 'subject'.
int	$userIdForLocale:	(optional) GalleryUser id of the recipient. Used to determine the locale for the email.
	&$pendingUser:

API Tags:

Return:

a status code

[ Top ]

Documentation generated on Fri, 08 Oct 2010 05:01:18 -0700 by phpDocumentor 1.3.0RC6

	Registration Classes

[ class tree: Registration ] [ index: Registration ] [ all elements ]

Class: GalleryPendingUserHelper

Class GalleryPendingUserHelper