ManagementEnforcer::addGroupingPolicies() - Code Metrics - php-casbin/php-casbin - Measure and Improve Code Quality continuously with Scrutinizer

ManagementEnforcer::addGroupingPolicies() A
last analyzed 2024-09-04 15:24 UTC

↳ Parent: ManagementEnforcer

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10

<?php


declare(strict_types=1);

namespace Casbin;

use Casbin\Constant\Constants;
use Closure;

/**
 * ManagementEnforcer = InternalEnforcer + Management API.
 *
 * @author [email protected]

 */

class ManagementEnforcer extends InternalEnforcer
{
    /**
     * Gets the list of subjects that show up in the current policy.
     *
     * @return array
     */
    public function getAllSubjects(): array
    {
        return $this->model->getValuesForFieldInPolicyAllTypesByName('p', Constants::SUBJECT_INDEX);
    }

    /**
     * Gets the list of subjects that show up in the current named policy.
     *
     * @param string $ptype

     *
     * @return array
     */
    public function getAllNamedSubjects(string $ptype): array
    {
        $fieldIndex = $this->model->getFieldIndex('p', Constants::SUBJECT_INDEX);
        return $this->model->getValuesForFieldInPolicy('p', $ptype, $fieldIndex);
    }

    /**
     * Gets the list of objects that show up in the current policy.
     *
     * @return array
     */
    public function getAllObjects(): array
    {
        return $this->model->getValuesForFieldInPolicyAllTypesByName('p', Constants::OBJECT_INDEX);
    }

    /**
     * Gets the list of objects that show up in the current named policy.
     *
     * @param string $ptype

     *
     * @return array
     */
    public function getAllNamedObjects(string $ptype): array
    {
        $fieldIndex = $this->model->getFieldIndex('p', Constants::OBJECT_INDEX);
        return $this->model->getValuesForFieldInPolicy('p', $ptype, $fieldIndex);
    }

    /**
     * Gets the list of actions that show up in the current policy.
     *
     * @return array
     */
    public function getAllActions(): array
    {
        return $this->model->getValuesForFieldInPolicyAllTypesByName('p', Constants::ACTION_INDEX);
    }

    /**
     * Gets the list of actions that show up in the current named policy.
     *
     * @param string $ptype

     *
     * @return array
     */
    public function getAllNamedActions(string $ptype): array
    {
        $fieldIndex = $this->model->getFieldIndex('p', Constants::ACTION_INDEX);
        return $this->model->getValuesForFieldInPolicy('p', $ptype, $fieldIndex);
    }

    /**
     * Gets the list of roles that show up in the current policy.
     *
     * @return array
     */
    public function getAllRoles(): array
    {
        return $this->model->getValuesForFieldInPolicyAllTypes('g', 1);
    }

    /**
     * Gets the list of roles that show up in the current named policy.
     *
     * @param string $ptype

     *
     * @return array
     */
    public function getAllNamedRoles(string $ptype): array
    {
        return $this->model->getValuesForFieldInPolicy('g', $ptype, 1);
    }

    /**
     * Gets all the authorization rules in the policy.
     *
     * @return array
     */
    public function getPolicy(): array
    {
        return $this->getNamedPolicy('p');
    }

    /**
     * Gets all the authorization rules in the policy, field filters can be specified.
     *
     * @param int $fieldIndex

     * @param string ...$fieldValues

     *
     * @return array
     */
    public function getFilteredPolicy(int $fieldIndex, string ...$fieldValues): array
    {
        return $this->getFilteredNamedPolicy('p', $fieldIndex, ...$fieldValues);
    }

    /**
     * Gets all the authorization rules in the named policy.
     *
     * @param string $ptype

     *
     * @return array
     */
    public function getNamedPolicy(string $ptype): array
    {
        return $this->model->getPolicy('p', $ptype);
    }

    /**
     * Gets all the authorization rules in the named policy, field filters can be specified.
     *
     * @param string $ptype

     * @param int $fieldIndex

     * @param string ...$fieldValues

     *
     * @return array
     */
    public function getFilteredNamedPolicy(string $ptype, int $fieldIndex, string ...$fieldValues): array
    {
        return $this->model->getFilteredPolicy('p', $ptype, $fieldIndex, ...$fieldValues);
    }

    /**
     * Gets all the role inheritance rules in the policy.
     *
     * @return array
     */
    public function getGroupingPolicy(): array
    {
        return $this->getNamedGroupingPolicy('g');
    }

    /**
     * Gets all the role inheritance rules in the policy, field filters can be specified.
     *
     * @param int $fieldIndex

     * @param string ...$fieldValues

     *
     * @return array
     */
    public function getFilteredGroupingPolicy(int $fieldIndex, string ...$fieldValues): array
    {
        return $this->getFilteredNamedGroupingPolicy('g', $fieldIndex, ...$fieldValues);
    }

    /**
     * Gets all the role inheritance rules in the policy.
     *
     * @param string $ptype

     *
     * @return array
     */
    public function getNamedGroupingPolicy(string $ptype): array
    {
        return $this->model->getPolicy('g', $ptype);
    }

    /**
     * Gets all the role inheritance rules in the policy, field filters can be specified.
     *
     * @param string $ptype

     * @param int $fieldIndex

     * @param string ...$fieldValues

     *
     * @return array
     */
    public function getFilteredNamedGroupingPolicy(string $ptype, int $fieldIndex, string ...$fieldValues): array
    {
        return $this->model->getFilteredPolicy('g', $ptype, $fieldIndex, ...$fieldValues);
    }

    /**
     * Determines whether an authorization rule exists.
     *
     * @param mixed ...$params

     *
     * @return bool
     */
    public function hasPolicy(...$params): bool
    {
        return $this->hasNamedPolicy('p', ...$params);
    }

    /**
     * Determines whether a named authorization rule exists.
     *
     * @param string $ptype

     * @param mixed ...$params

     *
     * @return bool
     */
    public function hasNamedPolicy(string $ptype, ...$params): bool
    {
        if (1 == count($params) && is_array($params[0])) {
            $params = $params[0];
        }

        return $this->model->hasPolicy('p', $ptype, $params);
    }

    /**
     * AddPolicy adds an authorization rule to the current policy.
     * If the rule already exists, the function returns false and the rule will not be added.
     * Otherwise the function returns true by adding the new rule.
     *
     * @param mixed ...$params

     *
     * @return bool
     */
    public function addPolicy(...$params): bool
    {
        return $this->addNamedPolicy('p', ...$params);
    }

    /**
     * AddPolicies adds authorization rules to the current policy.
     * If the rule already exists, the function returns false for the corresponding rule and the rule will not be added.
     * Otherwise the function returns true for the corresponding rule by adding the new rule.
     *
     * @param string[][] $rules

     *
     * @return bool
     * @throws Exceptions\CasbinException
     */
    public function addPolicies(array $rules): bool
    {
        return $this->addNamedPolicies('p', $rules);
    }

    /**
     * AddPoliciesEx adds authorization rules to the current policy.
     * If the rule already exists, the rule will not be added.
     * But unlike AddPolicies, other non-existent rules are added instead of returning false directly.
     * 
     * @param string[][] $rules

     * 
     * @return bool
     */
    public function addPoliciesEx(array $rules): bool
    {
        return $this->addNamedPoliciesEx('p', $rules);
    }

    /**
     * AddNamedPolicy adds an authorization rule to the current named policy.
     * If the rule already exists, the function returns false and the rule will not be added.
     * Otherwise the function returns true by adding the new rule.
     *
     * @param string $ptype

     * @param mixed ...$params

     *
     * @return bool
     */
    public function addNamedPolicy(string $ptype, ...$params): bool
    {
        if (1 == count($params) && is_array($params[0])) {
            $params = $params[0];
        }

        return $this->addPolicyInternal('p', $ptype, $params);
    }

    /**
     * AddNamedPolicies adds authorization rules to the current named policy.
     * If the rule already exists, the function returns false for the corresponding rule and the rule will not be added.
     * Otherwise the function returns true for the corresponding by adding the new rule.
     *
     * @param string $ptype

     * @param string[][] $rules

     *
     * @return bool
     * @throws Exceptions\CasbinException
     */
    public function addNamedPolicies(string $ptype, array $rules): bool
    {
        return $this->addPoliciesInternal('p', $ptype, $rules, false);
    }

    /**
     * AddNamedPoliciesEx adds authorization rules to the current named policy.
     * If the rule already exists, the rule will not be added.
     * But unlike AddNamedPolicies, other non-existent rules are added instead of returning false directly.
     * 
     * @param string $ptype

     * @param string[][] $rules

     * 
     * @return bool
     */
    public function addNamedPoliciesEx(string $ptype, array $rules): bool
    {
        return $this->addPoliciesInternal('p', $ptype, $rules, true);
    }

    /**
     * Removes an authorization rule from the current policy.
     *
     * @param mixed ...$params

     *
     * @return bool
     */
    public function removePolicy(...$params): bool
    {
        return $this->removeNamedPolicy('p', ...$params);
    }

    /**
     * Removes an authorization rules from the current policy.
     *
     * @param array $rules

     *
     * @return bool
     */
    public function removePolicies(array $rules): bool
    {
        return $this->removeNamedPolicies('p', $rules);
    }

    /**
     * Removes an authorization rule from the current policy.
     *
     * @param string[] $oldRule

     * @param string[] $newRule

     *
     * @return bool
     */
    public function updatePolicy(array $oldRule, array $newRule): bool
    {
        return $this->updateNamedPolicy("p", $oldRule, $newRule);
    }

    /**
     * Updates an authorization rule from the current policy.
     *
     * @param string $ptype

     * @param string[] $oldRule

     * @param string[] $newRule

     *
     * @return bool
     */
    public function updateNamedPolicy(string $ptype, array $oldRule, array $newRule): bool
    {
        return $this->updatePolicyInternal("p", $ptype, $oldRule, $newRule);
    }

    /**
     * UpdatePolicies updates authorization rules from the current policies.
     *
     * @param string[][] $oldPolices

     * @param string[][] $newPolicies

     * @return boolean

     */
    public function updatePolicies(array $oldPolices, array $newPolicies): bool
    {
        return $this->updateNamedPolicies("p", $oldPolices, $newPolicies);
    }

    /**
     * Updates authorization rules from the current policy.
     *
     * @param string $ptype

     * @param string[][] $oldPolices

     * @param string[][] $newPolicies

     * @return boolean

     */
    public function updateNamedPolicies(string $ptype, array $oldPolices, array $newPolicies): bool
    {
        return $this->updatePoliciesInternal("p", $ptype, $oldPolices, $newPolicies);
    }

    public function updateFilteredPolicies(array $newPolicies, int $fieldIndex, string ...$fieldValues): bool

    {
        return $this->updateFilteredNamedPolicies("p", $newPolicies, $fieldIndex, ...$fieldValues);
    }

    /**
     * Undocumented function
     *
     * @param string $ptype

     * @param array $newPolicies

     * @param integer $fieldIndex

     * @param string ...$fieldValues

     * @return boolean

     */
    public function updateFilteredNamedPolicies(string $ptype, array $newPolicies, int $fieldIndex, string ...$fieldValues): bool
    {
        return $this->updateFilteredPoliciesInternal("p", $ptype, $newPolicies, $fieldIndex, ...$fieldValues);
    }

    /**
     * Removes an authorization rule from the current policy, field filters can be specified.
     *
     * @param int $fieldIndex

     * @param string ...$fieldValues

     *
     * @return bool
     */
    public function removeFilteredPolicy(int $fieldIndex, string ...$fieldValues): bool
    {
        return $this->removeFilteredNamedPolicy('p', $fieldIndex, ...$fieldValues);
    }

    /**
     * Removes an authorization rule from the current named policy.
     *
     * @param string $ptype

     * @param mixed ...$params

     *
     * @return bool
     */
    public function removeNamedPolicy(string $ptype, ...$params): bool
    {
        if (1 == count($params) && is_array($params[0])) {
            $params = $params[0];
        }

        return $this->removePolicyInternal('p', $ptype, $params);
    }

    /**
     * Removes an authorization rules from the current named policy.
     *
     * @param string $ptype

     * @param array $rules

     *
     * @return bool
     */
    public function removeNamedPolicies(string $ptype, array $rules): bool
    {
        return $this->removePoliciesInternal('p', $ptype, $rules);
    }

    /**
     * Removes an authorization rule from the current named policy, field filters can be specified.
     *
     * @param string $ptype

     * @param int $fieldIndex

     * @param string ...$fieldValues

     *
     * @return bool
     */
    public function removeFilteredNamedPolicy(string $ptype, int $fieldIndex, string ...$fieldValues): bool
    {
        return $this->removeFilteredPolicyInternal('p', $ptype, $fieldIndex, ...$fieldValues);
    }

    /**
     * Determines whether a role inheritance rule exists.
     *
     * @param mixed ...$params

     *
     * @return bool
     */
    public function hasGroupingPolicy(...$params): bool
    {
        return $this->hasNamedGroupingPolicy('g', ...$params);
    }

    /**
     * Determines whether a named role inheritance rule exists.
     *
     * @param string $ptype

     * @param mixed ...$params

     *
     * @return bool
     */
    public function hasNamedGroupingPolicy(string $ptype, ...$params): bool
    {
        if (1 == count($params) && is_array($params[0])) {
            $params = $params[0];
        }

        return $this->model->hasPolicy('g', $ptype, $params);
    }

    /**
     * AddGroupingPolicy adds a role inheritance rule to the current policy.
     * If the rule already exists, the function returns false and the rule will not be added.
     * Otherwise the function returns true by adding the new rule.
     *
     * @param mixed ...$params

     *
     * @return bool
     */
    public function addGroupingPolicy(...$params): bool
    {
        return $this->addNamedGroupingPolicy('g', ...$params);
    }

    /**
     * AddGroupingPolicy adds a role inheritance rules to the current policy.
     * If the rule already exists, the function returns false and the rule will not be added.
     * Otherwise the function returns true by adding the new rule.
     *
     * @param array $rules

     *
     * @return bool
     */
    public function addGroupingPolicies(array $rules): bool
    {
        return $this->addNamedGroupingPolicies('g', $rules);
    }

    /**
     * AddGroupingPolicyEx adds a role inheritance rules to the current policy.
     * If the rule already exists, the rule will not be added.
     * But unlike AddGroupingPolicy, other non-existent rules are added instead of returning false directly.
     * 
     * @param array $rules

     * 
     * @return bool
     */
    public function addGroupingPoliciesEx(array $rules): bool
    {
        return $this->addNamedGroupingPoliciesEx('g', $rules);
    }

    /**
     * AddNamedGroupingPolicy adds a named role inheritance rule to the current policy.
     * If the rule already exists, the function returns false and the rule will not be added.
     * Otherwise the function returns true by adding the new rule.
     *
     * @param string $ptype

     * @param mixed ...$params

     *
     * @return bool
     */
    public function addNamedGroupingPolicy(string $ptype, ...$params): bool
    {
        if (1 == count($params) && is_array($params[0])) {
            $params = $params[0];
        }

        $ruleAdded = $this->addPolicyInternal('g', $ptype, $params);

        return $ruleAdded;
    }

    /**
     * AddNamedGroupingPolicy adds a named role inheritance rules to the current policy.
     * If the rule already exists, the function returns false and the rule will not be added.
     * Otherwise the function returns true by adding the new rule.
     *
     * @param string $ptype

     * @param array $rules

     *
     * @return bool
     */
    public function addNamedGroupingPolicies(string $ptype, array $rules): bool
    {
        return $this->addPoliciesInternal('g', $ptype, $rules, false);
    }

    public function addNamedGroupingPoliciesEx(string $ptype, array $rules): bool

    {
        return $this->addPoliciesInternal('g', $ptype, $rules, true);
    }

    /**
     * Removes a role inheritance rule from the current policy.
     *
     * @param mixed ...$params

     *
     * @return bool
     */
    public function removeGroupingPolicy(...$params): bool
    {
        return $this->removeNamedGroupingPolicy('g', ...$params);
    }

    /**
     * Removes a role inheritance rules from the current policy.
     *
     * @param array $rules

     *
     * @return bool
     */
    public function removeGroupingPolicies(array $rules): bool
    {
        return $this->removeNamedGroupingPolicies('g', $rules);
    }

    /**
     * Removes a role inheritance rule from the current policy, field filters can be specified.
     *
     * @param int $fieldIndex

     * @param string ...$fieldValues

     *
     * @return bool
     */
    public function removeFilteredGroupingPolicy(int $fieldIndex, string ...$fieldValues): bool
    {
        return $this->removeFilteredNamedGroupingPolicy('g', $fieldIndex, ...$fieldValues);
    }

    /**
     * Removes a role inheritance rule from the current named policy.
     *
     * @param string $ptype

     * @param mixed ...$params

     *
     * @return bool
     */
    public function removeNamedGroupingPolicy(string $ptype, ...$params): bool
    {
        if (1 == count($params) && is_array($params[0])) {
            $params = $params[0];
        }

        $ruleRemoved = $this->removePolicyInternal('g', $ptype, $params);

        if ($this->autoBuildRoleLinks) {
            $this->buildRoleLinks();
        }

        return $ruleRemoved;
    }

    /**
     * Removes a role inheritance rules from the current named policy.
     *
     * @param string $ptype

     * @param array $rules

     *
     * @return bool
     */
    public function removeNamedGroupingPolicies(string $ptype, array $rules): bool
    {
        $ruleRemoved = $this->removePoliciesInternal('g', $ptype, $rules);

        if ($this->autoBuildRoleLinks) {
            $this->buildRoleLinks();
        }

        return $ruleRemoved;
    }

    /**
     * Removes a role inheritance rule from the current named policy, field filters can be specified.
     *
     * @param string $ptype

     * @param int $fieldIndex

     * @param string ...$fieldValues

     *
     * @return bool
     */
    public function removeFilteredNamedGroupingPolicy(string $ptype, int $fieldIndex, string ...$fieldValues): bool
    {
        $ruleRemoved = $this->removeFilteredPolicyInternal('g', $ptype, $fieldIndex, ...$fieldValues);

        if ($this->autoBuildRoleLinks) {
            $this->buildRoleLinks();
        }

        return $ruleRemoved;
    }

    /**
     * Adds a customized function.
     *
     * @param string $name

     * @param Closure $func

     */

    public function addFunction(string $name, Closure $func): void
    {
        $this->fm->addFunction($name, $func);
    }

    /**
     * Adds authorization rule to the current policy.
     * If the rule already exists, the function returns false and the rule will not be added.
     * Otherwise the function returns true by adding the new rule.
     * 
     * @param string $sec

     * @param string $ptype

     * @param string[] $params

     * 
     * @return void
     */
    public function selfAddPolicy(string $sec, string $ptype, array $params): void
    {
        $this->addPolicyWithoutNotifyInternal($sec, $ptype, $params);
    }

    /**
     * Adds authorization rules to the current policy.
     * If the rule already exists, the function returns false for the corresponding rule and the rule will not be added.
     * Otherwise the function returns true for the corresponding rule by adding the new rule.
     * 
     * @param string $sec

     * @param string $ptype

     * @param string[][] $params

     * 
     * @return bool
     */
    public function selfAddPolices(string $sec, string $ptype, array $params): bool
    {
        return $this->addPoliciesWithoutNotifyInternal($sec, $ptype, $params, false);
    }

    /**
     * Adds authorization rules to the current named policy with autoNotifyWatcher disabled.
     * If the rule already exists, the rule will not be added.
     * But unlike SelfAddPolicies, other non-existent rules are added instead of returning false directly
     * 
     * @param string $sec

     * @param string $ptype

     * @param string[][] $params

     * 
     * @return bool
     */
    public function selfAddPolicesEx(string $sec, string $ptype, array $params): bool
    {
        return $this->addPoliciesWithoutNotifyInternal($sec, $ptype, $params, true);
    }

    /**
     * Gets the index for a given ptype and field.
     *
     * @param string $ptype

     * @param string $field

     * 
     * @return int $fieldIndex
     * @throws Exceptions\CasbinException
     */
    public function getFieldIndex(string $ptype, string $field): int
    {
        return $this->model->getFieldIndex($ptype, $field);
    }

    /**
     * Sets the index for a given ptype and field.
     *
     * @param string $ptype

     * @param string $field

     * @param int $index

     */

    public function setFieldIndex(string $ptype, string $field, int $index): void
    {
        $this->model->setFieldIndex($ptype, $field, $index);
    }
}


1		<?php
2
		0 ignored issues – show Coding Style introduced 2019-10-08 08:11 UTC by Report Bug Copy Issue Report Missing file doc comment Loading history...
3		declare(strict_types=1);
4
5		namespace Casbin;
6
7		use Casbin\Constant\Constants;
8		use Closure;
9
10		/**
11		* ManagementEnforcer = InternalEnforcer + Management API.
12		*
13		* @author [email protected]
		0 ignored issues – show Coding Style introduced 2020-12-22 05:56 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history...
14		*/
		0 ignored issues – show Coding Style introduced 2020-12-22 05:56 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2020-12-22 05:56 UTC by Report Bug Copy Issue Report Missing @package tag in class comment Loading history... Coding Style introduced 2020-12-22 05:56 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2020-12-22 05:56 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
15		class ManagementEnforcer extends InternalEnforcer
16		{
17		/**
18		* Gets the list of subjects that show up in the current policy.
19		*
20		* @return array
21		*/
22	9	public function getAllSubjects(): array
23		{
24	9	return $this->model->getValuesForFieldInPolicyAllTypesByName('p', Constants::SUBJECT_INDEX);
25		}
26
27		/**
28		* Gets the list of subjects that show up in the current named policy.
29		*
30		* @param string $ptype
		0 ignored issues – show Coding Style introduced 2019-10-11 02:58 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
31		*
32		* @return array
33		*/
34	3	public function getAllNamedSubjects(string $ptype): array
35		{
36	3	$fieldIndex = $this->model->getFieldIndex('p', Constants::SUBJECT_INDEX);

php-casbin / php-casbin

ManagementEnforcer::addGroupingPolicies() A last analyzed 2024-09-04 15:24 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ManagementEnforcer::addGroupingPolicies() A
last analyzed 2024-09-04 15:24 UTC