Stud.IP  2.0 Revision 48548
 All Data Structures Namespaces Files Functions Variables Pages
StudipAuthCAS Class Reference
Inheritance diagram for StudipAuthCAS:
Inheritance graph
Collaboration diagram for StudipAuthCAS:
Collaboration graph

Public Member Functions

 StudipAuthCAS ()
 getUser ()
 isAuthenticated ($username, $password, $jscript)
 authenticateUser ($username, $password, $jscript=false)
 getUserData ($key)
 logout ()
- Public Member Functions inherited from StudipAuthSSO
 isUsedUsername ($username)
- Public Member Functions inherited from StudipAuthAbstract
 StudipAuthAbstract ()
 getStudipUserid ($username)
 doNewUserInit ($uid)
 setUserDomains ($uid)
 getUserDomains ()
 doDataMapping ($uid)
 isMappedField ($name)
 verifyUsername ($username)

Data Fields

 $host
 $port
 $uri
 $cacert
 $cas
 $userdata

Additional Inherited Members

- Static Public Member Functions inherited from StudipAuthAbstract
 GetInstance ($plugin_name=false)
 CheckAuthentication ($username, $password, $jscript=false)
 CheckUsername ($username)
 CheckField ($field_name, $plugin_name)

Member Function Documentation

authenticateUser (   $username,
  $password,
  $jscript = false 
)

authentication method

this method authenticates the passed username, it is used by StudipAuthAbstract::CheckAuthentication() if authentication succeeds it calls StudipAuthAbstract::doDataMapping() to map data fields if the authenticated user logs in for the first time it calls StudipAuthAbstract::doNewUserInit() to initialize the new user private

Parameters
stringthe username to check
stringthe password to check
boolindicates if javascript was enabled/disabled during the login process
Returns
string if authentication succeeds the Stud.IP user id, else false

Reimplemented from StudipAuthAbstract.

Here is the call graph for this function:

getUser ( )

Return the current username.

Reimplemented from StudipAuthSSO.

Here is the caller graph for this function:

getUserData (   $key)
isAuthenticated (   $username,
  $password,
  $jscript 
)

Check whether this user can be authenticated. The default implementation just checks whether $username is not empty.

Reimplemented from StudipAuthSSO.

Here is the caller graph for this function:

logout ( )

Constructor

public

Field Documentation

$cacert
$cas
$host
$port
$uri
$userdata

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