CRUDKit User API Doc v1.0.0-beta.2
\
Alddesign
Crudkit
Classes

\Alddesign\Crudkit\ClassesAuthHelper

Provides functionality for user/permisson handling.

Summary

Methods
Properties
Constants
__construct()
addUserObject()
getUsers()
addUser()
isLoggedIn()
isAdmin()
getUserId()
onAfterLogin()
checkCookies()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

getUsers()

getUsers() : array<mixed,\Alddesign\Crudkit\Classes\CurdkitUser>

Gets all users

Returns

array<mixed,\Alddesign\Crudkit\Classes\CurdkitUser>

addUser()

addUser(string  $id, string  $password, \Alddesign\Crudkit\Classes\RestrictionSet  $restrictionSet = null, \Alddesign\Crudkit\Classes\Startpage  $startpage = null) : \Alddesign\Crudkit\Classes\AuthHelper

Defines a new User.

Parameters

string $id

The user ID
string $password

The password for this user
\Alddesign\Crudkit\Classes\RestrictionSet $restrictionSet

(optional) The restriction set (permissions) for this user
\Alddesign\Crudkit\Classes\Startpage $startpage

(optional) The startpage for this user

Returns

\Alddesign\Crudkit\Classes\AuthHelper

isLoggedIn()

isLoggedIn() : boolean

Checks if the user is logged in.

Returns

boolean

isAdmin()

isAdmin() : boolean

Checks if the user is an admin user (and if the user is logged in)

Returns

boolean

getUserId()

getUserId() : string

Gets the current user id. Returns '' if not logged in.

Returns

string

onAfterLogin()

onAfterLogin(callable  $callback) : \Alddesign\Crudkit\Classes\AuthHelper

Register event handler. Occours after a user has logged in successfully.

$f = function(string $username, bool $isAdmin){...};
authHelper->onAfterLogin($f);

Parameters

callable $callback

Callback function which is beeing called if this event occours.

Returns

\Alddesign\Crudkit\Classes\AuthHelper

checkCookies()

checkCookies() : void

Checks if there is cookie data for skin/accent. If yes, override crudkit config.