Caridea\Acl\Rule

Complexity

Total Complexity

9

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	isAllowed()	0	4	1
A	match()	0	6	4
A	allow()	0	4	1
A	deny()	0	4	1

<?php
declare(strict_types=1);
/**
 * Caridea
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 * @copyright 2015-2018 LibreWorks contributors
 * @license   Apache-2.0
 */
namespace Caridea\Acl;

/**
 * An ACL rule.
 *
 * @copyright 2015-2018 LibreWorks contributors
 * @license   Apache-2.0
 */
class Rule
{
    /**
     * @var \Caridea\Acl\Subject The subject
     */
    private $subject;
    /**
     * @var array|null An array of verbs granted access, or null for all verbs
     */
    private $verbs;
    /**
     * @var bool Whether the Subject is allowed or forbidden
     */
    private $allowed;

    /**
     * Creates a new Rule.
     *
     * @param \Caridea\Acl\Subject $subject The subject
     * @param bool $allowed Whether this is an allowing rule
     * @param array<string>|null $verbs Array of verbs, or `null` for all verbs
     */
    protected function __construct(Subject $subject, bool $allowed, array $verbs = null)
    {
        $this->subject = $subject;
        $this->allowed = (bool) $allowed;
        $this->verbs = empty($verbs) ? null : $verbs;
    }

    /**
     * Gets whether this is an allowing rule.
     *
     * @return bool Whether this is an allowing rule
     */
    public function isAllowed(): bool
    {
        return $this->allowed;
    }

    /**
     * Gets whether this Rule matches the `Subject` and verb provided.
     *
     * @param \Caridea\Acl\Subject $subject The subject to check
     * @param string $verb The verb to check
     * @return bool Whether this Rule matches the arguments provided
     */
    public function match(Subject $subject, string $verb): bool
    {
        return $this->subject->getType() == $subject->getType() &&
            $this->subject->getId() === $subject->getId() &&
            ($this->verbs === null || in_array($verb, $this->verbs, true));
    }

    /**
     * Creates an allowing Rule.
     *
     * @param \Caridea\Acl\Subject $subject The subject to allow access
     * @param array<string>|null $verbs Optional list of allowed verbs.
     *     Empty or `null` means *all*.
     * @return Rule The allowing Rule
     */
    public static function allow(Subject $subject, array $verbs = null): Rule
    {
        return new self($subject, true, $verbs);
    }

    /**
     * Creates an denying Rule.
     *
     * @param \Caridea\Acl\Subject $subject The subject to allow access
     * @param array<string>|null $verbs Optional list of denied verbs.
     *     Empty or `null` means *all*.
     * @return Rule The denying Rule
     */
    public static function deny(Subject $subject, array $verbs = null): Rule
    {
        return new self($subject, false, $verbs);
    }
}