1. class
  2. Ceo
  3. Core
  4. Auth
  5. AuthManager

AuthManager

class AuthManager extends Component

AuthManager manages central email/password authentication for web interaction. API authentication is state-less and handled by the ApiKeyListener.

Methods

boolean
check(array $creds, boolean $checkOnly = false)

Check credentials as defined as an array containing: * email * password

boolean
isLoggedIn()

Determine if user is logged in

User
getUser()

Fetch user for associated session

string
getUserId()

Returns the id of the user

remove()

Reset the session and private data bag.

Details

at line line 22
boolean check(array $creds, boolean $checkOnly = false)

Check credentials as defined as an array containing: * email * password

Parameters

array $creds
boolean $checkOnly If true don't set identity

Return Value

boolean

at line line 68
boolean isLoggedIn()

Determine if user is logged in

Return Value

boolean

at line line 81
User getUser()

Fetch user for associated session

Return Value

User user object

at line line 106
string getUserId()

Returns the id of the user

Return Value

string

at line line 115
remove()

Reset the session and private data bag.

Effectively logs the user out.