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

\Alddesign\Crudkit\ClassesAuthHelper

Provides functionality for user/permisson handling.

Summary

Methods
Properties
Constants
__construct()
addUserObject()
getUsers()
addUser()
userHasAccessTo()
isLoggedIn()
isAdmin()
getUserId()
onAfterLogin()
triggerEvent()
checkStartpage()
checkCookies()
checkAuth()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
loginFailed()
checkPermissions()
performLogin()
$users
$callbacks
N/A

Properties

$callbacks

$callbacks : array<mixed,callable>

Type

array<mixed,callable> — Event callback function. [Key => Event name, Value => Callback function ]

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

userHasAccessTo()

userHasAccessTo(string  $action, \Alddesign\Crudkit\Classes\string  $pageId) : boolean

Checks if a certains user has access to a certain page/action

Parameters

string $action

['list', 'card', 'create', 'update', 'delete', 'export', 'chart', '']
\Alddesign\Crudkit\Classes\string $pageId

Returns

boolean

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

triggerEvent()

triggerEvent(string  $name)

Triggers an event.

Parameters

string $name

Name of the Event

checkStartpage()

checkStartpage()

checkCookies()

checkCookies() : void

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

checkAuth()

checkAuth(\Alddesign\Crudkit\Classes\string  $action, \Alddesign\Crudkit\Classes\string  $pageId, \Alddesign\Crudkit\Classes\bool  $noPermissionCheck = false, \Alddesign\Crudkit\Classes\bool  $loginAttempt = false)

Checks if user is logged in and his permissions to the current page/action.

Parameters

\Alddesign\Crudkit\Classes\string $action
\Alddesign\Crudkit\Classes\string $pageId
\Alddesign\Crudkit\Classes\bool $noPermissionCheck
\Alddesign\Crudkit\Classes\bool $loginAttempt

loginFailed()

loginFailed(\Alddesign\Crudkit\Classes\string  $message = '')

Parameters

\Alddesign\Crudkit\Classes\string $message

checkPermissions()

checkPermissions(\Alddesign\Crudkit\Classes\string  $action, \Alddesign\Crudkit\Classes\string  $pageId)

Parameters

\Alddesign\Crudkit\Classes\string $action
\Alddesign\Crudkit\Classes\string $pageId

performLogin()

performLogin()