PHP Class Piwik\Plugins\Login\Auth

Inheritance: implements Piwik\Auth
Show file Open project: piwik/piwik Class Usage Examples

Protected Properties

Property Type Description
$hashedPassword
$login
$token_auth

Public Methods

Method Description
__construct ( )
authenticate ( ) : Piwik\AuthResult Authenticates user
getLogin ( ) : string Returns the login of the user being authenticated.
getName ( ) : string Authentication module's name, e.g., "Login"
getTokenAuthSecret ( ) : string Returns the secret used to calculate a user's token auth.
setLogin ( string $login ) Accessor to set login name
setPassword ( string $password ) Sets the password to authenticate with.
setPasswordHash ( string $passwordHash ) Sets the password hash to use when authentication.
setTokenAuth ( string $token_auth ) Accessor to set authentication token

Private Methods

Method Description
authenticateWithPassword ( $login, $passwordHash )
authenticateWithToken ( $token )
authenticateWithTokenOrHashToken ( $token, $login )
authenticationSuccess ( array $user )

Method Details

__construct() public method

public __construct ( )

authenticate() public method

Authenticates user
public authenticate ( ) : Piwik\AuthResult
return Piwik\AuthResult

getLogin() public method

Returns the login of the user being authenticated.
public getLogin ( ) : string
return string

getName() public method

Authentication module's name, e.g., "Login"
public getName ( ) : string
return string

getTokenAuthSecret() public method

Returns the secret used to calculate a user's token auth.
public getTokenAuthSecret ( ) : string
return string

setLogin() public method

Accessor to set login name
public setLogin ( string $login )
$login string user login

setPassword() public method

Sets the password to authenticate with.
public setPassword ( string $password )
$password string

setPasswordHash() public method

Sets the password hash to use when authentication.
public setPasswordHash ( string $passwordHash )
$passwordHash string The password hash.

setTokenAuth() public method

Accessor to set authentication token
public setTokenAuth ( string $token_auth )
$token_auth string authentication token

Property Details

$hashedPassword protected property

protected $hashedPassword

$login protected property

protected $login

$token_auth protected property

protected $token_auth