dmCdmUser Class Reference

Inheritance diagram for dmCdmUser:
dmModel idmUser

Public Member Functions

Static Public Member Functions

Protected Member Functions


Detailed Description

Definition at line 20 of file dmCdmUser.class.php.


Constructor & Destructor Documentation

dmCdmUser::__construct ( username  )  [protected]
Parameters:
string username

Definition at line 94 of file dmCdmUser.class.php.


Member Function Documentation

dmCdmUser::__toString (  ) 
Returns:
string The user's username
Since:
0.1

Definition at line 105 of file dmCdmUser.class.php.

static dmCdmUser::authenticate ( username,
password 
) [static]

If authentication is successful, returns a logged-in dmCdmUser object as well as saving the user in the session.

Parameters:
string username
string password
Returns:
A dmCdmUser object if the supplied username and password authenticate successfully against CONTENTdm(R)'s login.exe program; false if not
Exceptions:
dmMissingExtensionException if cURL is not available in the PHP core
Since:
0.1

Definition at line 46 of file dmCdmUser.class.php.

static dmCdmUser::getInstance (  )  [static, final]
Returns:
dmCdmUser object, or null if not logged in
Since:
0.1

Definition at line 29 of file dmCdmUser.class.php.

dmCdmUser::getUsername (  )  [final]
Returns:
string
Since:
0.1

Implements idmUser.

Definition at line 122 of file dmCdmUser.class.php.

Referenced by __toString().

static dmCdmUser::isLoggedIn (  )  [static, final]
Returns:
Boolean
Since:
0.1

Definition at line 82 of file dmCdmUser.class.php.

dmCdmUser::logout (  ) 
Returns:
void
Since:
0.1

Definition at line 113 of file dmCdmUser.class.php.


The documentation for this class was generated from the following file:

Generated on Fri Aug 20 13:16:49 2010 for dmBridge PHP API by  doxygen 1.6.1