PHP Class Piwik\Plugins\Login\Auth

Inheritance: implements Piwik\Auth

Protected Properties

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

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

public __construct ( )

Authenticates user

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

Returns the login of the user being authenticated.

public getLogin ( ) : string
return	string

Authentication module's name, e.g., "Login"

public getName ( ) : string
return	string

Returns the secret used to calculate a user's token auth.

public getTokenAuthSecret ( ) : string
return	string

Accessor to set login name

public setLogin ( string $login )
$login	string	user login

Sets the password to authenticate with.

public setPassword ( string $password )
$password	string

Sets the password hash to use when authentication.

public setPasswordHash ( string $passwordHash )
$passwordHash	string	The password hash.

Accessor to set authentication token

public setTokenAuth ( string $token_auth )
$token_auth	string	authentication token

protected $hashedPassword

protected $login

protected $token_auth