Casbin\Model\Policy

Complexity

Total Complexity

37

Size/Duplication

Total Lines	243
Duplicated Lines	0 %

Test Coverage

Coverage

95.06%

Importance

Changes	4
Bugs	1	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
B	removeFilteredPolicy()	0	29	7
A	getFilteredPolicy()	0	20	6
A	getPolicy()	0	3	1
A	removePolicy()	0	15	3
A	printPolicy()	0	9	4
A	getValuesForFieldInPolicy()	0	15	3
A	addPolicy()	0	9	2
A	buildRoleLinks()	0	7	3
A	hasPolicy()	0	7	2
A	clearPolicy()	0	8	4
A	getValuesForFieldInPolicyAllTypes()	0	11	2

<?php

Missing file doc comment

declare(strict_types=1);

namespace Casbin\Model;

use Casbin\Log\Log;
use Casbin\Rbac\RoleManager;
use Casbin\Util\Util;

/**
 * Trait Policy.
 *
 * @author techlee@qq.com

Content of the @author tag must be in the form "Display Name <username@example.com>"

 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

trait Policy
{
    /**
     * initializes the roles in RBAC.

Doc comment short description must start with a capital letter

     *
     * @param RoleManager $rm

Missing parameter comment

     */

Missing @return tag in function comment

    public function buildRoleLinks(RoleManager $rm): void
    {
        if (!isset($this->items['g'])) {
            return;
        }
        foreach ($this->items['g'] as $ast) {
            $ast->buildRoleLinks($rm);
        }
    }

    /**
     * prints the policy to log.

Doc comment short description must start with a capital letter

     */

Missing @return tag in function comment

    public function printPolicy(): void
    {
        Log::logPrint('Policy:');
        foreach (['p', 'g'] as $sec) {
            if (!isset($this->items[$sec])) {
                return;
            }
            foreach ($this->items[$sec] as $key => $ast) {
                Log::logPrint($key, ': ', $ast->value, ': ', $ast->policy);
            }
        }
    }

    /**
     * clears all current policy.

Doc comment short description must start with a capital letter

     */

Missing @return tag in function comment

    public function clearPolicy(): void
    {
        foreach (['p', 'g'] as $sec) {
            if (!isset($this->items[$sec])) {
                return;
            }
            foreach ($this->items[$sec] as $key => $ast) {
                $this->items[$sec][$key]->policy = [];
            }
        }
    }

    /**
     * gets all rules in a policy.

Doc comment short description must start with a capital letter

     *
     * @param string $sec

Missing parameter comment

     * @param string $ptype

Missing parameter comment

     *
     * @return array
     */
    public function getPolicy(string $sec, string $ptype): array
    {
        return $this->items[$sec][$ptype]->policy;
    }

    /**
     * gets rules based on field filters from a policy.

Doc comment short description must start with a capital letter

     *
     * @param string $sec

Missing parameter comment

     * @param string $ptype

Missing parameter comment

     * @param int    $fieldIndex

Missing parameter comment

     * @param string ...$fieldValues

Missing parameter comment

     *
     * @return array
     */
    public function getFilteredPolicy(string $sec, string $ptype, int $fieldIndex, string ...$fieldValues): array
    {
        $res = [];

        foreach ($this->items[$sec][$ptype]->policy as $rule) {
            $matched = true;
            foreach ($fieldValues as $i => $fieldValue) {
                if ('' != $fieldValue && $rule[$fieldIndex + $i] != $fieldValue) {
                    $matched = false;

                    break;
                }
            }

            if ($matched) {
                $res[] = $rule;
            }
        }

        return $res;
    }

    /**
     * determines whether a model has the specified policy rule.

Doc comment short description must start with a capital letter

     *
     * @param string $sec

Missing parameter comment

     * @param string $ptype

Missing parameter comment

     * @param array  $rule

Missing parameter comment

     *
     * @return bool
     */
    public function hasPolicy(string $sec, string $ptype, array $rule): bool
    {
        if (!isset($this->items[$sec][$ptype])) {
            return false;
        }

        return in_array($rule, $this->items[$sec][$ptype]->policy, true);
    }

    /**
     * adds a policy rule to the model.

Doc comment short description must start with a capital letter

     *
     * @param string $sec

Missing parameter comment

     * @param string $ptype

Missing parameter comment

     * @param array  $rule

Missing parameter comment

     *
     * @return bool
     */
    public function addPolicy(string $sec, string $ptype, array $rule): bool
    {
        if (!$this->hasPolicy($sec, $ptype, $rule)) {
            $this->items[$sec][$ptype]->policy[] = $rule;

            return true;
        }

        return false;
    }

    /**
     * removes a policy rule from the model.

Doc comment short description must start with a capital letter

     *
     * @param string $sec

Missing parameter comment

     * @param string $ptype

Missing parameter comment

     * @param array  $rule

Missing parameter comment

     *
     * @return bool
     */
    public function removePolicy(string $sec, string $ptype, array $rule): bool
    {
        if (!isset($this->items[$sec][$ptype])) {
            return false;
        }

        $offset = array_search($rule, $this->items[$sec][$ptype]->policy, true);

        if (false === $offset) {
            return false;
        }

        array_splice($this->items[$sec][$ptype]->policy, $offset, 1);

It seems like $offset can also be of type string; however, parameter $offset of array_splice() does only seem to accept integer, maybe add an additional type check?

        return true;
    }

    /**
     * removes policy rules based on field filters from the model.

Doc comment short description must start with a capital letter

     *
     * @param string $sec

Missing parameter comment

     * @param string $ptype

Missing parameter comment

     * @param int    $fieldIndex

Missing parameter comment

     * @param string ...$fieldValues

Missing parameter comment

     *
     * @return bool
     */
    public function removeFilteredPolicy(string $sec, string $ptype, int $fieldIndex, string ...$fieldValues): bool
    {
        $tmp = [];
        $res = false;

        if (!isset($this->items[$sec][$ptype])) {
            return $res;
        }

        foreach ($this->items[$sec][$ptype]->policy as $rule) {
            $matched = true;
            foreach ($fieldValues as $i => $fieldValue) {
                if ('' != $fieldValue && $rule[$fieldIndex + $i] != $fieldValue) {
                    $matched = false;

                    break;
                }
            }

            if ($matched) {
                $res = true;
            } else {
                $tmp[] = $rule;
            }
        }

        $this->items[$sec][$ptype]->policy = $tmp;

        return $res;
    }

    /**
     * gets all values for a field for all rules in a policy, duplicated values are removed.

Doc comment short description must start with a capital letter

     *
     * @param string $sec

Missing parameter comment

     * @param string $ptype

Missing parameter comment

     * @param int    $fieldIndex

Missing parameter comment

     *
     * @return array
     */
    public function getValuesForFieldInPolicy(string $sec, string $ptype, int $fieldIndex): array
    {
        $values = [];

        if (!isset($this->items[$sec][$ptype])) {
            return $values;
        }

        foreach ($this->items[$sec][$ptype]->policy as $rule) {
            $values[] = $rule[$fieldIndex];
        }

        Util::arrayRemoveDuplicates($values);

        return $values;
    }

    /**
     * gets all values for a field for all rules in a policy of all ptypes, duplicated values are removed.

Doc comment short description must start with a capital letter

     *
     * @param string $sec

Missing parameter comment

     * @param int    $fieldIndex

Missing parameter comment

     *
     * @return array
     */
    public function getValuesForFieldInPolicyAllTypes(string $sec, int $fieldIndex): array
    {
        $values = [];

        foreach ($this->items[$sec] as $key => $ptype) {
            $values = array_merge($values, $this->getValuesForFieldInPolicy($sec, $key, $fieldIndex));
        }

        Util::arrayRemoveDuplicates($values);

        return $values;
    }
}