1. class
  2. Arikaim
  3. \
  4. Core
  5. \
  6. Access
  7. \
  8. Access

Access

class Access implements AccessInterface

Manage permissions.

Constants

DEFAULT_AUTH_PROVIDER

Methods

__construct(PermissionsInterface $adapter, UserProviderInterface $user, AuthProviderInterface|null $provider = null, array $providerOptions = [])

Constructor

bool
authenticate(array $credentials)

Auth user

object|null
middleware(string $authName, array $options = [], UserProviderInterface|null $user = null)

Create auth middleware

AuthProviderInterface
requireProvider(AuthProviderInterface|string $provider, UserProviderInterface|null $user = null, array $params = [])

Set provider if is null

AuthProviderInterface
withProvider(AuthProviderInterface|string $provider, UserProviderInterface|null $user = null, array $params = [])

Change auth provider

object|null
createProvider(string $name, UserProviderInterface|null $user = null, array|null $params = null)

Create auth provider

void
setProvider(AuthProviderInterface $provider)

Set auth provider

AuthProviderInterface|null
getProvider()

Return auth provider

array
getFullPermissions()

Full Permissions

string
getControlPanelPermission()

Control panel permission name

void
setAdapter(PermissionsInterface $adapter)

Set permissions adapter

PermissionsInterface
getAdapter()

Get permissions adapter

bool
hasControlPanelAccess(integer|null $authId = null)

Check if current loged user have control panel access

bool
hasAccess(string|int $name, string|array|null $type = null, integer|null $authId = null)

Check access

mixed
getUserPermissions(integer|null $authId = null)

Get user permissions

bool
addPermission(string $name, string|null $title = null, string|null $description = null, string|null $extension = null)

Add permission item.

array
resolvePermissionName(string $name)

Resolve permission full name name:type

array|null
resolvePermissionType(string|array $type)

Resolve permission type

void
logout()

Logout

array|null
getUser()

Get logged user

int|null
getLoginAttempts()

Get login attempts

null|integer|string
getId()

Get auth id

bool
isLogged()

Return true if user is logged

string|null
getAuthName(int $auth)

Return auth name

array
getAuthNames(mixed $auth)

Get auth names

null|integer|string
resolveAuthType(string|integer $type)

Resolve auth type

Details

at line 59
__construct(PermissionsInterface $adapter, UserProviderInterface $user, AuthProviderInterface|null $provider = null, array $providerOptions = [])

Constructor

Parameters

PermissionsInterface $adapter
UserProviderInterface $user
AuthProviderInterface|null $provider
array $providerOptions

at line 78
bool authenticate(array $credentials)

Auth user

Parameters

array $credentials

Return Value

bool

at line 91
object|null middleware(string $authName, array $options = [], UserProviderInterface|null $user = null)

Create auth middleware

Parameters

string $authName
array $options
UserProviderInterface|null $user

Return Value

object|null

at line 106
AuthProviderInterface requireProvider(AuthProviderInterface|string $provider, UserProviderInterface|null $user = null, array $params = [])

Set provider if is null

Parameters

AuthProviderInterface|string $provider
UserProviderInterface|null $user
array $params

Return Value

AuthProviderInterface

at line 123
AuthProviderInterface withProvider(AuthProviderInterface|string $provider, UserProviderInterface|null $user = null, array $params = [])

Change auth provider

Parameters

AuthProviderInterface|string $provider
UserProviderInterface|null $user
array $params

Return Value

AuthProviderInterface

at line 141
object|null createProvider(string $name, UserProviderInterface|null $user = null, array|null $params = null)

Create auth provider

Parameters

string $name
UserProviderInterface|null $user
array|null $params

Return Value

object|null

at line 155
void setProvider(AuthProviderInterface $provider)

Set auth provider

Parameters

AuthProviderInterface $provider

Return Value

void

at line 165
AuthProviderInterface|null getProvider()

Return auth provider

Return Value

AuthProviderInterface|null

at line 175
array getFullPermissions()

Full Permissions

Return Value

array

at line 185
string getControlPanelPermission()

Control panel permission name

Return Value

string

at line 196
void setAdapter(PermissionsInterface $adapter)

Set permissions adapter

Parameters

PermissionsInterface $adapter

Return Value

void

at line 206
PermissionsInterface getAdapter()

Get permissions adapter

Return Value

PermissionsInterface

at line 217
bool hasControlPanelAccess(integer|null $authId = null)

Check if current loged user have control panel access

Parameters

integer|null $authId

Return Value

bool

at line 235
bool hasAccess(string|int $name, string|array|null $type = null, integer|null $authId = null)

Check access

Parameters

string|int $name Permission name
string|array|null $type PermissionType (read,write,execute,delete)
integer|null $authId

Return Value

bool

at line 258
mixed getUserPermissions(integer|null $authId = null)

Get user permissions

Parameters

integer|null $authId

Return Value

mixed

at line 274
bool addPermission(string $name, string|null $title = null, string|null $description = null, string|null $extension = null)

Add permission item.

Parameters

string $name
string|null $title
string|null $description
string|null $extension

Return Value

bool

at line 285
array resolvePermissionName(string $name)

Resolve permission full name name:type

Parameters

string $name

Return Value

array

at line 304
protected array|null resolvePermissionType(string|array $type)

Resolve permission type

Parameters

string|array $type

Return Value

array|null

at line 322
void logout()

Logout

Return Value

void

at line 334
array|null getUser()

Get logged user

Return Value

array|null

at line 344
int|null getLoginAttempts()

Get login attempts

Return Value

int|null

at line 354
null|integer|string getId()

Get auth id

Return Value

null|integer|string

at line 368
bool isLogged()

Return true if user is logged

Return Value

bool

at line 379
string|null getAuthName(int $auth)

Return auth name

Parameters

int $auth

Return Value

string|null

at line 390
array getAuthNames(mixed $auth)

Get auth names

Parameters

mixed $auth

Return Value

array

at line 407
null|integer|string resolveAuthType(string|integer $type)

Resolve auth type

Parameters

string|integer $type

Return Value

null|integer|string