Class: GalleryPendingUser

Source Location: /modules/register/classes/GalleryPendingUser.class

Class GalleryPendingUser

Class Overview

Representation of a single pending self-registered user (not yet a valid GalleryUser).

This class is the container for information about Gallery users. Each instance of User contains a unique user id. It must be implemented by a class that has a persistent store for the relevant user data.

Located in /modules/register/classes/GalleryPendingUser.class [line 54]

GalleryPersistent
   |
   --GalleryEntity
      |
      --GalleryPendingUser

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From GalleryEntity

GalleryEntity::$creationTimestamp

GalleryEntity::$entityType

GalleryEntity::$id

GalleryEntity::$isLinkable

GalleryEntity::$linkedEntity

GalleryEntity::$linkId

GalleryEntity::$modificationTimestamp

GalleryEntity::$onLoadHandlers

GalleryEntity::$serialNumber

Inherited From GalleryPersistent

GalleryPersistent::$_persistentStatus

Inherited From GalleryEntity

GalleryEntity::addOnLoadHandler()

Add onLoad handler.

GalleryEntity::create()

Create a new instance of this GalleryEntity in the persistent store

GalleryEntity::createLink()

Create a new linked version of this item into a new album

GalleryEntity::delete()

Delete this GalleryEntity

GalleryEntity::detachLink()

Detach this entity from the entity it is linked to by the simple expedient of overwriting over all non-null members with the equivalent from the link target.

GalleryEntity::getClassName()

Return the case sensitive name of this entity class. This is exactly what get_class() would return in PHP5. PHP4 is case-insensitive though so we must rely on it being set in each entity. The framework uses this as an index into entity related tables.

GalleryEntity::getCreationTimestamp()

GalleryEntity::getEntityType()

GalleryEntity::getId()

GalleryEntity::getIsLinkable()

GalleryEntity::getLinkedEntity()

GalleryEntity::getLinkId()

GalleryEntity::getModificationTimestamp()

GalleryEntity::getOnLoadHandlers()

GalleryEntity::getRenderer()

GalleryEntity::getSerialNumber()

GalleryEntity::hasOnLoadHandler()

Check for an onLoad handler.

GalleryEntity::isLinked()

Return true if this entity is linked to another

GalleryEntity::itemTypeName()

Return the name of this type of item.

GalleryEntity::onLoad()

This is called after an entity is loaded by the GalleryStorage subsystem.

GalleryEntity::onSave()

This is called after an entity is saved by the GalleryStorage subsystem.

GalleryEntity::refresh()

Refresh this item from the persistent store

GalleryEntity::removeOnLoadHandler()

Remove onLoad handler.

GalleryEntity::save()

Save the changes to this GalleryEntity.

GalleryEntity::setCreationTimestamp()

GalleryEntity::setEntityType()

GalleryEntity::setId()

GalleryEntity::setIsLinkable()

GalleryEntity::setLinkedEntity()

GalleryEntity::setLinkId()

GalleryEntity::setModificationTimestamp()

GalleryEntity::setOnLoadHandlers()

GalleryEntity::setSerialNumber()

Inherited From GalleryPersistent

GalleryPersistent::GalleryPersistent()

GalleryPersistent::clearPersistentFlag()

Clear a flag.

GalleryPersistent::getClassFile()

Return the relative path to the class for this entity

GalleryPersistent::getOriginalValue()

Return the original value of the given member.

GalleryPersistent::isModified()

Have we modified any data in this class?

GalleryPersistent::resetOriginalValues()

Reset all original values to the current values in the entity (or null if so specified).

GalleryPersistent::setPersistentFlag()

Set a flag.

GalleryPersistent::testPersistentFlag()

Test a flag.

[ Top ]

Property Summary

string	$email	The User's email address.
string	$fullName	The User's full name
string	$hashedPassword	The User's password in a hashed form.
string	$language	The User's language preference
string	$registrationKey	The registration key (used in confirmation url)
string	$userName	The User's username

[ Top ]

Method Summary

void	changePassword()	Change the user's password to the new value provided.
GalleryStatus	create()	Create a new instance of this user in the persistent store
void	getClassName()
void	getEmail()
void	getFullName()
void	getHashedPassword()
void	getLanguage()
void	getRegistrationKey()
void	getUserName()
void	setEmail()
void	setFullName()
void	setHashedPassword()
void	setLanguage()
void	setRegistrationKey()
void	setUserName()

[ Top ]

Properties

string $email [line 114]

The User's email address.

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>email</member-name>
G2:	<member-type>STRING</member-type>
G2:	<member-size>MEDIUM</member-size>
G2:	</member>

[ Top ]

string $fullName [line 86]

The User's full name

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>fullName</member-name>
G2:	<member-type>STRING</member-type>
G2:	<member-external-access>FULL</member-external-access>
G2:	<member-size>MEDIUM</member-size>
G2:	</member>

[ Top ]

string $hashedPassword [line 100]

The User's password in a hashed form.

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>hashedPassword</member-name>
G2:	<member-type>STRING</member-type>
G2:	<member-size>MEDIUM</member-size>
G2:	</member>

[ Top ]

string $language [line 128]

The User's language preference

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>language</member-name>
G2:	<member-type>STRING</member-type>
G2:	<member-size>MEDIUM</member-size>
G2:	</member>

[ Top ]

string $registrationKey [line 142]

The registration key (used in confirmation url)

API Tags:

Access:

public

Information Tags:

G2:	<member>
G2:	<member-name>registrationKey</member-name>
G2:	<member-type>STRING</member-type>
G2:	<member-size>SMALL</member-size>
G2:	</member>

[ Top ]

string $userName [line 71]

The User's username

API Tags:

Access:

public

Information Tags:

G2:	<member-name>userName</member-name>
G2:	<member>
G2:	<member-type>STRING</member-type>
G2:	<member-size>SMALL</member-size>
G2:	<member-external-access>READ</member-external-access>
G2:	<required/>
G2:	<unique/>
G2:	</member>

[ Top ]

Methods

changePassword [line 214]

void changePassword(
string
$newPassword 
)

Change the user's password to the new value provided.

Parameters:

string

$newPassword:

a plaintext password

[ Top ]

create [line 149]

GalleryStatus create(

$userName 
)

Create a new instance of this user in the persistent store

Parameters:

$userName:

API Tags:

Return:

a status code

Redefinition of:

GalleryEntity::create(): Create a new instance of this GalleryEntity in the persistent store

[ Top ]

getClassName [line 221]

void getClassName(
)

API Tags:

See:

GalleryEntity::getClassName

Redefinition of:

GalleryEntity::getClassName(): Return the case sensitive name of this entity class. This is exactly what get_class() would return in PHP5. PHP4 is case-insensitive though so we must rely on it being set in each entity. The framework uses this as an index into entity related tables.

[ Top ]

getEmail [line 249]

void getEmail(
)

[ Top ]

getFullName [line 233]

void getFullName(
)

[ Top ]

getHashedPassword [line 241]

void getHashedPassword(
)

[ Top ]

getLanguage [line 257]

void getLanguage(
)

[ Top ]

getRegistrationKey [line 265]

void getRegistrationKey(
)

[ Top ]

getUserName [line 225]

void getUserName(
)

[ Top ]

setEmail [line 253]

void setEmail(

$email 
)

Parameters:

$email:

[ Top ]

setFullName [line 237]

void setFullName(

$fullName 
)

Parameters:

$fullName:

[ Top ]

setHashedPassword [line 245]

void setHashedPassword(

$hashedPassword 
)

Parameters:

$hashedPassword:

[ Top ]

setLanguage [line 261]

void setLanguage(

$language 
)

Parameters:

$language:

[ Top ]

setRegistrationKey [line 269]

void setRegistrationKey(

$registrationKey 
)

Parameters:

$registrationKey:

[ Top ]

setUserName [line 229]

void setUserName(

$userName 
)

Parameters:

$userName:

[ Top ]

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

	Registration Classes

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