UserGroups::getRecordDefinition() - Code Metrics - Inspection of "Refactor for Craft3" - nerds-and-company/schematic - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#114)

by Bart

created 2018-04-04 10:18 UTC

UserGroups::getRecordDefinition() A

↳ Parent: UserGroups

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
ccs	0
cts	0
cp	0
cc	1
eloc	4
nc	1
nop	1
crap	2

<?php

namespace NerdsAndCompany\Schematic\Services;

use Craft;
use craft\base\Model;
use craft\models\UserGroup;

/**
 * Schematic User Groups Service.
 *
 * Sync Craft Setups.
 *
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015-2018, Nerds & Company
 * @license   MIT
 *
 * @see      http://www.nerds.company
 */
class UserGroups extends Base
{
    /** @var string[] */
    private $mappedPermissions = [];

    //==============================================================================================================
    //================================================  EXPORT  ====================================================
    //==============================================================================================================

    /**
     * Get all section records
     *
     * @return UserGroup[]
     */
    protected function getRecords()
    {
        $this->mappedPermissions = $this->getAllMappedPermissions();

        return Craft::$app->userGroups->getAllGroups();
    }

    /**
     * Get group definition.
     *
     * @param UserGroupModel $group
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return array
     */
    protected function getRecordDefinition(Model $record)
    {
        $attributes = parent::getRecordDefinition($record);
        $attributes['permissions'] = $this->getGroupPermissionDefinitions($record);
        return $attributes;
    }

    /**
     * Get group permissions.
     *
     * @param $group
     *
     * @return array|string
     */
    private function getGroupPermissionDefinitions($group)
    {
        $permissionDefinitions = [];
        $groupPermissions = Craft::$app->userPermissions->getPermissionsByGroupId($group->id);

        foreach ($groupPermissions as $permission) {
            if (array_key_exists($permission, $this->mappedPermissions)) {
                $permission = $this->mappedPermissions[$permission];
                $permissionDefinitions[] = $this->getSource(false, $permission, 'id', 'handle');
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            }
        }
        sort($permissionDefinitions);

        return $permissionDefinitions;
    }

    /**
     * Get a mapping of all permissions from lowercase to camelcase
     * savePermissions only accepts camelcase.
     *
     * @return array
     */
    private function getAllMappedPermissions()
    {
        $mappedPermissions = [];
        foreach (Craft::$app->userPermissions->getAllPermissions() as $permissions) {
            $mappedPermissions = array_merge($mappedPermissions, $this->getMappedPermissions($permissions));
        }

        return $mappedPermissions;
    }

    /**
     * @param array $permissions
     *
     * @return array
     */
    private function getMappedPermissions(array $permissions)
    {
        $mappedPermissions = [];
        foreach ($permissions as $permission => $options) {
            $mappedPermissions[strtolower($permission)] = $permission;
            if (array_key_exists('nested', $options)) {
                $mappedPermissions = array_merge($mappedPermissions, $this->getMappedPermissions($options['nested']));
            }
        }

        return $mappedPermissions;
    }

    //==============================================================================================================
    //================================================  IMPORT  ====================================================
    //==============================================================================================================

    /**
     * Save a record
     *
     * @param Model $record
     * @param array $definition
     * @return boolean
     */
    protected function saveRecord(Model $record, array $definition)
    {
        $record->setAttributes($definition['attributes']);
        return Craft::$app->userGroups->saveGroup($record);
    }

    /**
     * Delete a record
     *
     * @param Model $record
     * @return boolean
     */
    protected function deleteRecord(Model $record)
    {
        return Craft::$app->userGroups->deleteGroup($record);
    }
}


1		<?php
2
3		namespace NerdsAndCompany\Schematic\Services;
4
5		use Craft;
6		use craft\base\Model;
7		use craft\models\UserGroup;
8
9		/**
10		* Schematic User Groups Service.
11		*
12		* Sync Craft Setups.
13		*
14		* @author Nerds & Company
15		* @copyright Copyright (c) 2015-2018, Nerds & Company
16		* @license MIT
17		*
18		* @see http://www.nerds.company
19		*/
20		class UserGroups extends Base
21		{
22		/** @var string[] */
23		private $mappedPermissions = [];
24
25		//==============================================================================================================
26		//================================================ EXPORT ====================================================
27		//==============================================================================================================
28
29		/**
30		* Get all section records
31		*
32		* @return UserGroup[]
33		*/
34		protected function getRecords()
35	4	{
36		$this->mappedPermissions = $this->getAllMappedPermissions();
37	4
38		return Craft::$app->userGroups->getAllGroups();
39	4	}
40
41	4	/**
42		* Get group definition.
43	4	*
44	3	* @param UserGroupModel $group
		0 ignored issues – show Bug introduced 2018-04-03 09:15 UTC by Report Bug Copy Issue Report There is no parameter named `$group`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
45	4	*
46		* @return array
47	4	*/
48		protected function getRecordDefinition(Model $record)
49		{
50		$attributes = parent::getRecordDefinition($record);
51		$attributes['permissions'] = $this->getGroupPermissionDefinitions($record);
52		return $attributes;
53		}
54
55		/**
56		* Get group permissions.
57	3	*
58		* @param $group
59		*
60	3	* @return array\|string
61	3	*/
62	3	private function getGroupPermissionDefinitions($group)
63		{
64		$permissionDefinitions = [];
65		$groupPermissions = Craft::$app->userPermissions->getPermissionsByGroupId($group->id);
66
67		foreach ($groupPermissions as $permission) {
68		if (array_key_exists($permission, $this->mappedPermissions)) {
69		$permission = $this->mappedPermissions[$permission];
70		$permissionDefinitions[] = $this->getSource(false, $permission, 'id', 'handle');
		0 ignored issues – show Documentation Bug introduced 2018-04-03 09:26 UTC by Report Bug Copy Issue Report The method `getSource` does not exist on `object<NerdsAndCompany\S...ic\Services\UserGroups>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
71		}
72	3	}
73		sort($permissionDefinitions);
74	3
75	3	return $permissionDefinitions;
76		}
77	3
78	1	/**
79	1	* Get a mapping of all permissions from lowercase to camelcase
80	1	* savePermissions only accepts camelcase.
81	1	*
82	3	* @return array
83	3	*/
84		private function getAllMappedPermissions()
85	3	{
86		$mappedPermissions = [];
87		foreach (Craft::$app->userPermissions->getAllPermissions() as $permissions) {
88		$mappedPermissions = array_merge($mappedPermissions, $this->getMappedPermissions($permissions));
89		}
90
91		return $mappedPermissions;
92		}
93
94	4	/**
95		* @param array $permissions
96	4	*
97	4	* @return array
98	4	*/
99	4	private function getMappedPermissions(array $permissions)
100		{
101	4	$mappedPermissions = [];
102		foreach ($permissions as $permission => $options) {
103		$mappedPermissions[strtolower($permission)] = $permission;
104		if (array_key_exists('nested', $options)) {
105		$mappedPermissions = array_merge($mappedPermissions, $this->getMappedPermissions($options['nested']));
106		}
107		}
108
109	4	return $mappedPermissions;
110		}
111	4
112	4	//==============================================================================================================
113	4	//================================================ IMPORT ====================================================
114	4	//==============================================================================================================
115	4
116	4	/**
117	4	* Save a record
118		*
119	4	* @param Model $record
120		* @param array $definition
121		* @return boolean
122		*/
123		protected function saveRecord(Model $record, array $definition)
124		{
125		$record->setAttributes($definition['attributes']);
126		return Craft::$app->userGroups->saveGroup($record);
127		}
128
129		/**
130		* Delete a record
131		*
132		* @param Model $record
133		* @return boolean
134	9	*/
135		protected function deleteRecord(Model $record)
136	9	{
137		return Craft::$app->userGroups->deleteGroup($record);
138	9	}
139		}
140

nerds-and-company / schematic

Pull Request — master (#114)

UserGroups::getRecordDefinition() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like