Policy::addPolicies() - Code Metrics - Inspection of "Merge pull request #47 from yk17310320725/iss41" - php-casbin/php-casbin - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 127f02...ecc5eb )

by Lee
created 2020-07-18 04:39 UTC
Policy::addPolicies() A

↳ Parent: Policy
Complexity

Conditions	2
Paths	2
Size

Total Lines	7
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	4
CRAP Score	2
Importance

Changes
Metric	Value
eloc	3
c	0
b	0
f	0
dl	0
loc	7
ccs	4
cts	4
cp	1
rs	10
cc	2
nc	2
nop	3
crap	2
<?php


declare(strict_types=1);

namespace Casbin\Model;

use Casbin\Exceptions\BatchOperationException;
use Casbin\Exceptions\CasbinException;
use Casbin\Log\Log;
use Casbin\Rbac\RoleManager;
use Casbin\Util\Util;

/**
 * Trait Policy.
 *
 * @author [email protected]

 */

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

     *
     * @param RoleManager $rm

     */

    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.

     */

    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.

     */

    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.

     *
     * @param string $sec

     * @param string $ptype

     *
     * @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.

     *
     * @param string $sec

     * @param string $ptype

     * @param int    $fieldIndex

     * @param string ...$fieldValues

     *
     * @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.

     *
     * @param string $sec

     * @param string $ptype

     * @param array  $rule

     *
     * @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);
    }

    /**
     * determines whether a model has any of the specified policies. If one is found we return false.

     *
     * @param string $sec

     * @param string $ptype

     * @param array  $rules

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

        foreach ($rules as $rule) {
            if (!in_array($rule, $this->items[$sec][$ptype]->policy, true)) {
                return false;
            }
        }

        return true;
    }

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

     *
     * @param string $sec

     * @param string $ptype

     * @param array  $rule

     */

    public function addPolicy(string $sec, string $ptype, array $rule): void
    {
        $this->items[$sec][$ptype]->policy[] = $rule;
    }

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

     *
     * @param string $sec

     * @param string $ptype

     * @param array  $rules

     *
     * @throws CasbinException
     */

    public function addPolicies(string $sec, string $ptype, array $rules): void
    {
        if (count(array_unique($rules, SORT_REGULAR), COUNT_RECURSIVE) !== count($rules, COUNT_RECURSIVE)) {
            throw new BatchOperationException('addPolicies error: $rules elements can not be duplicated.');
        }

        $this->items[$sec][$ptype]->policy = array_merge($this->items[$sec][$ptype]->policy, $rules);
    }

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

     *
     * @param string $sec

     * @param string $ptype

     * @param array  $rule

     *
     * @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);
        array_splice($this->items[$sec][$ptype]->policy, /** @scrutinizer ignore-type */ $offset, 1);

        return true;
    }

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

     *
     * @param string $sec

     * @param string $ptype

     * @param array  $rules

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

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

        foreach ($rules as $rule) {
            $offset = array_search($rule, $policy, true);

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

            array_splice($policy, $offset, 1);
            array_splice($policy, /** @scrutinizer ignore-type */ $offset, 1);
        }

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

        return true;
    }

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

     *
     * @param string $sec

     * @param string $ptype

     * @param int    $fieldIndex

     * @param string ...$fieldValues

     *
     * @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.

     *
     * @param string $sec

     * @param string $ptype

     * @param int    $fieldIndex

     *
     * @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.

     *
     * @param string $sec

     * @param int    $fieldIndex

     *
     * @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;
    }
}

php-casbin / php-casbin

Push — master ( 127f02...ecc5eb )

Policy::addPolicies() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
