Piwik\

AuthResult

Authentication result.

Methods

The class defines the following methods:

• __construct() — Constructor for AuthResult
• getIdentity() — Returns the login used to authenticate.
• getTokenAuth() — Returns the token_auth to authenticate the current user in the API
• getCode() — Returns the authentication result code.
• hasSuperUserAccess() — Returns true if the user has Super User access, false otherwise.
• wasAuthenticationSuccessful() — Returns true if this result was successfully authentication.

__construct()

Constructor for AuthResult

Signature

• It accepts the following parameter(s):

  • $code (int) —

  • $login (string) — identity

  • $tokenAuth (string) —

getIdentity()

Returns the login used to authenticate.

Signature

• It returns a string value.

getTokenAuth()

Returns the token_auth to authenticate the current user in the API

Signature

• It returns a string value.

getCode()

Returns the authentication result code.

Signature

• It returns a int value.

hasSuperUserAccess()

Returns true if the user has Super User access, false otherwise.

Signature

• It returns a bool value.

wasAuthenticationSuccessful()

Returns true if this result was successfully authentication.

Signature

• It returns a bool value.