CRUDKit api-doc [Developer]

User
in package

Represents a user account (login)

Table of Contents

$fullname  : mixed
$id  : mixed
$password  : mixed
$restrictionSet  : RestrictionSet
$startpage  : Startpage
__construct()  : mixed
Constructor.
getId()  : mixed
getPassword()  : mixed
getRestrictionSet()  : mixed
getStartpage()  : mixed
hasAccessTo()  : mixed
setRestrictionSet()  : mixed
setStartpage()  : mixed

Properties

$fullname

private mixed $fullname = ''
Tags
internal

$id

private mixed $id = ''
Tags
internal

$password

private mixed $password = ''
Tags
internal

$restrictionSet

private RestrictionSet $restrictionSet = null

(default = null, no restrictions)

Tags
internal

Methods

__construct()

Constructor.

public __construct(string $id, string $password[, RestrictionSet $restrictionSet = null ][, Startpage $startpage = null ]) : mixed

See CrudkitServiceProvider documentation for how to define Users.

Parameters
$id : string

The (unique) id of the user

$password : string

The users password

$restrictionSet : RestrictionSet = null

(optional)

$startpage : Startpage = null

(optional)

Tags
see
CrudkitServiceProvider
see
RestrictionSet
see
Startpage
Return values
mixed

getId()

public getId() : mixed
Tags
internal
Return values
mixed

getPassword()

public getPassword() : mixed
Tags
internal
Return values
mixed

getRestrictionSet()

public getRestrictionSet() : mixed
Tags
internal
Return values
mixed

getStartpage()

public getStartpage() : mixed
Tags
internal
Return values
mixed

hasAccessTo()

public hasAccessTo(string $action, string $pageId) : mixed
Parameters
$action : string
$pageId : string
Tags
internal
Return values
mixed

setRestrictionSet()

public setRestrictionSet(RestrictionSet $restrictionSet) : mixed
Parameters
$restrictionSet : RestrictionSet
Tags
internal
Return values
mixed

setStartpage()

public setStartpage(Startpage $startpage) : mixed
Parameters
$startpage : Startpage
Tags
internal
Return values
mixed

Search results