Docs For Class Research

Description

abstract:

Located in /packages/research/lib/researcher.inc.php (line 2)

Variable Summary

string $Address

string $Address2

CollectionID[]|CollectionContentID[] $Cart

string $City

string $Email

string $FirstName

integer $ID

string $LastName

string $Password

string $PasswordHash

integer $Pending

string $PendingHash

string $Phone

string $PhoneExtension

integer $RegisterTime

ResearcherType $ResearcherType

integer $ResearcherTypeID

string $State

string $ZIPCode

string $ZIPPlusFour

Method Summary

boolean dbActivate ()

boolean dbAddToCart ( $CollectionID, [integer $CollectionContentID = 0])

boolean dbDeactivate ()

boolean dbDelete ()

boolean dbDeleteFromCart (integer $CollectionID, [ $CollectionContentID = 0], integer $CollectionContentID[optional])

boolean dbEmptyCart ()

boolean dbLoad ()

boolean dbLoadCart ()

boolean dbSetPassword (string $Password)

boolean dbStore ()

boolean sendConfirmationEmail ()

string toString ([ $MakeIntoLink = LINK_NONE], [ $ConcatinateEmail = false], integer $MakeIntoLink[optional], boolean $ConcatinateEmail[optional])

boolean verifyPassword (string $Password)

string __toString ()

Variables

string $Address = NULL (line 931)

access: public

string $Address2 = NULL (line 936)

access: public

CollectionID[]|CollectionContentID[] $Cart = array() (line 998)

access: public

string $City = NULL (line 941)

access: public

string $Email = NULL (line 906)

access: public

string $FirstName = NULL (line 921)

access: public

integer $ID = 0 (line 901)

access: public

string $LastName = NULL (line 916)

access: public

string $Password = NULL (line 988)

access: public

string $PasswordHash = NULL (line 911)

access: public

integer $Pending = 1 (line 976)

access: public

string $PendingHash = NULL (line 981)

access: public

string $Phone = NULL (line 961)

access: public

string $PhoneExtension = NULL (line 966)

access: public

integer $RegisterTime = 0 (line 971)

access: public

ResearcherType $ResearcherType = NULL (line 993)

access: public

integer $ResearcherTypeID = 0 (line 926)

access: public

string $State = NULL (line 946)

access: public

string $ZIPCode = NULL (line 951)

access: public

string $ZIPPlusFour = NULL (line 956)

access: public

Methods

dbActivate (line 9)

Activates Researcher account

access: public

boolean dbActivate ()

dbAddToCart (line 67)

Add CollectionID and CollectionContentID to Researcher Cart

access: public

boolean dbAddToCart ( $CollectionID, integer $CollectionContentID)

integer $CollectionContentID
$CollectionID

dbDeactivate (line 160)

Deactivates Researcher account

access: public

boolean dbDeactivate ()

dbDelete (line 219)

Deletes Researcher from the database

access: public

boolean dbDelete ()

dbDeleteFromCart (line 283)

Delete CollectionID and CollectionContentID from Researcher Cart

access: public

boolean dbDeleteFromCart (integer $CollectionID, $CollectionContentID, integer $CollectionContentID[optional])

integer $CollectionID
integer $CollectionContentID[optional]
$CollectionContentID

dbEmptyCart (line 363)

Clear Researcher Cart

access: public

boolean dbEmptyCart ()

dbLoad (line 416)

Loads Researcher from the database

access: public

boolean dbLoad ()

dbLoadCart (line 475)

Loads CollectionContentIDs in cart for Researcher instance

access: public

boolean dbLoadCart ()

dbSetPassword (line 520)

Sets Researcher Password in the database

access: public

boolean dbSetPassword (string $Password)

string $Password

dbStore (line 625)

Stores Researcher to the database

access: public

boolean dbStore ()

sendConfirmationEmail (line 576)

Sends confirmation e-mail to researcher

access: public

boolean sendConfirmationEmail ()

toString (line 808)

Generates a formatted string of the Researcher object

access: public
todo: Custom Formatting

string toString ([ $MakeIntoLink = LINK_NONE], [ $ConcatinateEmail = false], integer $MakeIntoLink[optional], boolean $ConcatinateEmail[optional])

integer $MakeIntoLink[optional]
boolean $ConcatinateEmail[optional]
$MakeIntoLink
$ConcatinateEmail

verifyPassword (line 862)

Verifies a User's Password

access: public

boolean verifyPassword (string $Password)

string $Password

__toString (line 892)

access: public
magic:
see: Research_Researcher::toString()

string __toString ()

Class Research_Researcher