PHP Class Xavrsl\Cas\Sso

Author: Xavier Roussel
Mostra file Open project: xavrsl/cas

Public Methods

Method Description
__construct ( $config )
authenticate ( ) Authenticates the user based on the current request.
checkAuthenticate ( ) Authenticates the user based on the current request without redirect to login page.
getAttributes ( ) : array | null getAttributes' simple wrapper
getCurrentUser ( ) : array | null Returns information about the currently logged in user.
isAuthenticated ( ) : boolean Checks to see is user is authenticated
logout ( $params = [] ) : none This method is used to logout from CAS
user ( ) : array | null getCurrentUser Alias

Private Methods

Method Description
configureCasClient ( ) Configure CAS Client
configureDebug ( ) Configure CAS debug
configureProxyChain ( ) Configure Cas Proxy Chain
configureSslValidation ( ) Configure SSL Validation
initializeCas ( ) : none Make PHPCAS Initialization
isPretending ( ) isPretending

Method Details

__construct() public method

public __construct ( $config )
$config

authenticate() public method

If authentication fails, an exception must be thrown.
public authenticate ( )

checkAuthenticate() public method

If authentication fails, an exception must be thrown.
public checkAuthenticate ( )

getAttributes() public method

getAttributes' simple wrapper
public getAttributes ( ) : array | null
return array | null

getCurrentUser() public method

If nobody is currently logged in, this method should return null.
public getCurrentUser ( ) : array | null
return array | null

isAuthenticated() public method

Checks to see is user is authenticated
public isAuthenticated ( ) : boolean
return boolean

logout() public method

This method is used to logout from CAS
public logout ( $params = [] ) : none
return none

user() public method

getCurrentUser Alias
public user ( ) : array | null
return array | null