Class AuthorizationService
Property Summary
-
$authorizationChecked protected
boolTrack whether or not authorization was checked.
-
$resolver protected
Authorization\Policy\ResolverInterfaceAuthorization policy resolver.
Method Summary
-
__construct() public
-
applyScope() public
Apply authorization scope conditions/restrictions.
-
authorizationChecked() public
Return a boolean based on whether or not this object has had an authorization operation performed.
-
can() public
Check whether the provided user can perform an action on a resource.
-
canResult() public
Check whether the provided user can perform an action on a resource.
-
getCanHandler() protected
Returns a policy action handler.
-
getScopeHandler() protected
Returns a policy scope action handler.
-
performCheck() protected
Check whether the provided user can perform an action on a resource.
-
resultTypeCheck() protected
Check result type.
-
skipAuthorization() public
Allow for authorization to be skipped for this object.
Method Detail
__construct() ¶ public
__construct(Authorization\Policy\ResolverInterface $resolver)Parameters
-
Authorization\Policy\ResolverInterface$resolver Authorization policy resolver.
applyScope() ¶ public
applyScope(Authorization\IdentityInterface|null $user, string $action, mixed $resource): mixedApply authorization scope conditions/restrictions.
This method is intended for applying authorization to objects that are then used to access authorized collections of objects. The typical use case for scopes are restricting a query to only return records visible to the current user.
Parameters
-
Authorization\IdentityInterface|null$user -
string$action -
mixed$resource
Returns
mixedauthorizationChecked() ¶ public
authorizationChecked(): boolReturn a boolean based on whether or not this object has had an authorization operation performed.
Returns
boolcan() ¶ public
can(Authorization\IdentityInterface|null $user, string $action, mixed $resource): boolCheck whether the provided user can perform an action on a resource.
This method is intended to allow your application to build conditional logic around authorization checks.
Parameters
-
Authorization\IdentityInterface|null$user -
string$action -
mixed$resource
Returns
boolcanResult() ¶ public
canResult(Authorization\IdentityInterface|null $user, string $action, mixed $resource): Authorization\Policy\ResultInterfaceCheck whether the provided user can perform an action on a resource.
This method is intended to allow your application to build conditional logic around authorization checks.
Parameters
-
Authorization\IdentityInterface|null$user -
string$action -
mixed$resource
Returns
Authorization\Policy\ResultInterfacegetCanHandler() ¶ protected
getCanHandler(mixed $policy, string $action): callableReturns a policy action handler.
Parameters
-
mixed$policy Policy object.
-
string$action Action name.
Returns
callableThrows
Authorization\Policy\Exception\MissingMethodExceptiongetScopeHandler() ¶ protected
getScopeHandler(mixed $policy, string $action): callableReturns a policy scope action handler.
Parameters
-
mixed$policy Policy object.
-
string$action Action name.
Returns
callableThrows
Authorization\Policy\Exception\MissingMethodExceptionperformCheck() ¶ protected
performCheck(Authorization\IdentityInterface|null $user, string $action, mixed $resource): boolAuthorization\Policy\ResultInterfaceCheck whether the provided user can perform an action on a resource.
Parameters
-
Authorization\IdentityInterface|null$user The user to check permissions for.
-
string$action The action/operation being performed.
-
mixed$resource The resource being operated on.
Returns
boolAuthorization\Policy\ResultInterfaceresultTypeCheck() ¶ protected
resultTypeCheck(mixed $result): boolAuthorization\Policy\ResultInterfaceCheck result type.
Parameters
-
mixed$result Result from policy class instance.
Returns
boolAuthorization\Policy\ResultInterfaceThrows
Authorization\Exception\ExceptionIf $result argument is not a boolean or ResultInterface instance.
skipAuthorization() ¶ public
skipAuthorization(): $thisAllow for authorization to be skipped for this object.
After calling this method the value of authorizationChecked() should
return true regardless of whether authorization has been performed or not.
Returns
$this