Trait Roles

Trait for \MvcCore\Ext\Auths\Basics\User class. Trait contains: - Instance property $admin and $roles with their public getters and setters to manipulate with user roles. - Method IsAllowed() to get allowed permissions from user instance or from user roles.

Direct Known Users

MvcCore\Ext\Auths\Basics\User\Features

Namespace: MvcCore\Ext\Auths\Basics\User
Located at ext-auth-basic/src/MvcCore/Ext/Auths/Basics/User/Roles.php

Methods summary
`public boolean`	# `IsAdmin( )` Get if user is Administrator. Administrator has always allowed everything. Get if user is Administrator. Administrator has always allowed everything. Returns boolean
`public boolean`	# `GetAdmin( )` Get if user is Administrator. Administrator has always allowed everything. Get if user is Administrator. Administrator has always allowed everything. Returns boolean
`public MvcCore\Ext\Auths\Basics\User`	# `SetAdmin( boolean $admin = TRUE )` Set user to Administrator. Administrator has always allowed everything. Set user to Administrator. Administrator has always allowed everything. Parameters `$admin` `TRUE` by default. Returns `MvcCore\Ext\Auths\Basics\User`
`public string[] &`	# `GetRoles( )` Return array of user's roles names. Return array of user's roles names. Returns string[]
`public MvcCore\Ext\Auths\Basics\User`	# `SetRoles( string[]\|MvcCore\Ext\Auths\Basics\Role[] $rolesOrRolesNames = [] )` Set new user's roles or roles names. Set new user's roles or roles names. Parameters `$rolesOrRolesNames` Returns `MvcCore\Ext\Auths\Basics\User`
`public MvcCore\Ext\Auths\Basics\User`	# `AddRole( string\|MvcCore\Ext\Auths\Basics\Role $roleOrRoleName )` Add user role or role name. Add user role or role name. Parameters `$roleOrRoleName` Returns `MvcCore\Ext\Auths\Basics\User` Throws InvalidArgumentException
`public boolean`	# `HasRole( string\|MvcCore\Ext\Auths\Basics\Role $roleOrRoleName )` Get `TRUE` if user has already assigned role or role name. Get `TRUE` if user has already assigned role or role name. Parameters `$roleOrRoleName` Returns boolean Throws InvalidArgumentException
`public MvcCore\Ext\Auths\Basics\User`	# `RemoveRole( string\|MvcCore\Ext\Auths\Basics\Role $roleOrRoleName )` Remove user role or role name from user roles. Remove user role or role name from user roles. Parameters `$roleOrRoleName` Returns `MvcCore\Ext\Auths\Basics\User` Throws InvalidArgumentException
`protected static string`	# `getRoleName( string\|MvcCore\Ext\Auths\Basics\Role $roleOrRoleName )` Get role name from given role instance or given role name. Get role name from given role instance or given role name. Parameters `$roleOrRoleName` Returns string Throws InvalidArgumentException

Properties summary
`protected boolean`	`$admin`	# `FALSE`
`protected array`	`$roles`	# `[]`

Classes

Interfaces

Traits

Exceptions

Functions

Trait Roles

Direct Known Users

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws