Interface HasPermissionsInterface in namespace com\setasign\SetaFramework\Permissions in SetaFramework API Reference

Index

\com\setasign\SetaFramework
1. Permissions

com\setasign\SetaFramework\Permissions

HasPermissionsInterface Interface PermissionControlInterface

File: /SetaFramework/src/Permissions/HasPermissionsInterface.php

Implemented in

Summary

Methods

allow()

abstract public HasPermissionsInterface::allow (

ResourceDefinition $resource,
array|string|callable|null $actionsOrCallback = null

): void

Allow one or more actions of a resource

Parameters

$resource: ResourceDefinition
$actionsOrCallback: array|string|callable|null

Exceptions

Throws \InvalidArgumentException

deny()

abstract public HasPermissionsInterface::deny (

ResourceDefinition $resource,
array|string|callable|null $actionsOrCallback = null

): void

Deny one or more actions of a resource

Parameters

$resource: ResourceDefinition
$actionsOrCallback: array|string|callable|null

Exceptions

Throws \InvalidArgumentException

getIndividualPermissions()

abstract public HasPermissionsInterface::getIndividualPermissions (

void

): array

Get all individual permissions that are defined in the $actions array

isAllowed()

abstract public HasPermissionsInterface::isAllowed (

object|string|ResourceDefinition $nameOrObject,
string $action

): bool

Checks whether a action of a resource is allowed

Parameters

$nameOrObject: object|string|ResourceDefinition
$action: string

requirePermission()

abstract public HasPermissionsInterface::requirePermission (

object|string|ResourceDefinition $nameOrObject,
string $action

): void

Checks whether a action of a resource is allowed and if not an exception will be thrown

Parameters

$nameOrObject: object|string|ResourceDefinition
$action: string

Exceptions

Throws PermissionException If the permission is rejected!