Authorizer.php

<?php


namespace Source\Authorization;

interface Authorizer
{
    /**
     * @param string|null $id
     */
    public function setCurrentUserId(?string $id): void;

    /**
     * Returns list of permission from \Source\Authorization\Permissions that the user has
     *
     * @return string[]
     */
    public function getPermissions(): array;

    /**
     * The user needs ALL of the permissions.
     *
     * @param string[] $permissions
     * @return bool
     * @throws \Source\Exceptions\EntityNotFoundException
     */
    public function allowsAll(array $permissions): bool;

    /**
     * The user needs only ONE of the permissions
     *
     * @param string[] $permissions
     * @return bool
     * @throws \Source\Exceptions\EntityNotFoundException
     */
    public function allowsOne(array $permissions): bool;

    /**
     * Permissions to check against from \Source\Authorization\Permissions
     * Te user needs ALL of the permissions
     *
     * @param string[] $permissions
     * @throws \Source\Exceptions\AuthorizationException
     * @throws \Source\Exceptions\EntityNotFoundException
     */
    public function protectAll(array $permissions): void;

    /**
     * Permissions to check against from \Source\Authorization\Permissions
     * The user only needs ONE of the permissions
     *
     * @param string[] $permissions
     * @throws \Source\Exceptions\AuthorizationException
     * @throws \Source\Exceptions\EntityNotFoundException
     */
    public function protectOne(array $permissions): void;

    /**
     * Permissions to check against from \Source\Authorization\Permissions
     * The user needs the permission
     *
     * @param string $permission
     * @throws \Source\Exceptions\AuthorizationException
     * @throws \Source\Exceptions\EntityNotFoundException
     */
    public function protect(string $permission): void;

    /**
     * Permissions to check against from \Source\Authorization\Permissions
     * The user needs the permission
     *
     * @param string $permission
     * @return bool
     * @throws \Source\Exceptions\EntityNotFoundException
     */
    public function allows(string $permission): bool;

    /**
     * Protects the admin user from being modified.
     * Throws an exception if the currently authenticated user does not have
     * the permissions to perform an action on the passed user or group
     *
     * @param string      $userId
     * @param string|null $groupId
     * @throws \Source\Exceptions\AuthorizationException
     * @throws \Source\Exceptions\EntityNotFoundException
     */
    public function protectAdminRights(string $userId, ?string $groupId = null): void;
}