UserManager::setReferences() - Code Metrics - Inspection of "more flexibility with tags; allow to set array ref..." - kaliop-uk/ezmigrationbundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 09cee1...75eab4 )

by Gaetano

created 2018-05-12 16:39 UTC

UserManager::setReferences() D

↳ Parent: Project

Complexity

Conditions	9
Paths	13

Size

Total Lines	38
Code Lines	27

Duplication

Lines	38
Ratio	100 %

Code Coverage

Tests	0
CRAP Score	90

Importance

Changes

Metric	Value
dl	38
loc	38
ccs	0
cts	33
cp	0
rs	4.909
c	0
b	0
f	0
cc	9
eloc	27
nc	13
nop	2
crap	90

<?php

namespace Kaliop\eZMigrationBundle\Core\Executor;

use eZ\Publish\API\Repository\Values\User\User;
use Kaliop\eZMigrationBundle\API\Collection\UserCollection;
use Kaliop\eZMigrationBundle\Core\Matcher\UserGroupMatcher;
use Kaliop\eZMigrationBundle\Core\Matcher\UserMatcher;

/**
 * Handles user migrations.
 */
class UserManager extends RepositoryExecutor
{
    protected $supportedStepTypes = array('user');

    protected $userMatcher;

    protected $userGroupMatcher;

    public function __construct(UserMatcher $userMatcher, UserGroupMatcher $userGroupMatcher)
    {
        $this->userMatcher = $userMatcher;
        $this->userGroupMatcher = $userGroupMatcher;
    }

    /**
     * Creates a user based on the DSL instructions.
     *
     * @todo allow setting extra profile attributes!
     */
    protected function create($step)
    {
        if (!isset($step->dsl['groups'])) {
            throw new \Exception('No user groups set to create user in.');
        }

        if (!is_array($step->dsl['groups'])) {
            $step->dsl['groups'] = array($step->dsl['groups']);
        }

        $userService = $this->repository->getUserService();
        $contentTypeService = $this->repository->getContentTypeService();

        $userGroups = array();
        foreach ($step->dsl['groups'] as $groupId) {

            $groupId = $this->referenceResolver->resolveReference($groupId);
            $userGroup = $this->userGroupMatcher->matchOneByKey($groupId);

            // q: in which case can we have no group? And should we throw an exception?
            //if ($userGroup) {

                $userGroups[] = $userGroup;
            //}
        }

        // FIXME: Hard coding content type to user for now
        $userContentType = $contentTypeService->loadContentTypeByIdentifier($this->getUserContentType($step));

        $userCreateStruct = $userService->newUserCreateStruct(
            $step->dsl['username'],
            $step->dsl['email'],
            $step->dsl['password'],
            $this->getLanguageCode($step),
            $userContentType
        );
        $userCreateStruct->setField('first_name', $step->dsl['first_name']);
        $userCreateStruct->setField('last_name', $step->dsl['last_name']);

        // Create the user
        $user = $userService->createUser($userCreateStruct, $userGroups);

        $this->setReferences($user, $step);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $user;
    }

    /**
     * Method to handle the update operation of the migration instructions
     *
     * @todo allow setting extra profile attributes!
     */
    protected function update($step)
    {
        $userCollection = $this->matchUsers('user', $step);

        if (count($userCollection) > 1 && isset($step->dsl['references'])) {
            throw new \Exception("Can not execute User update because multiple user match, and a references section is specified in the dsl. References can be set when only 1 user matches");
        }

        if (count($userCollection) > 1 && isset($step->dsl['email'])) {
            throw new \Exception("Can not execute User update because multiple user match, and an email section is specified in the dsl.");
        }

        $userService = $this->repository->getUserService();

        foreach ($userCollection as $key => $user) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }

            $userUpdateStruct = $userService->newUserUpdateStruct();

            if (isset($step->dsl['email'])) {
                $userUpdateStruct->email = $step->dsl['email'];
            }
            if (isset($step->dsl['password'])) {
                $userUpdateStruct->password = (string)$step->dsl['password'];
            }
            if (isset($step->dsl['enabled'])) {
                $userUpdateStruct->enabled = $step->dsl['enabled'];
            }

            $user = $userService->updateUser($user, $userUpdateStruct);

            if (isset($step->dsl['groups'])) {
                $groups = $step->dsl['groups'];

                if (!is_array($groups)) {
                    $groups = array($groups);
                }

                $assignedGroups = $userService->loadUserGroupsOfUser($user);

                $targetGroupIds = [];
                // Assigning new groups to the user
                foreach ($groups as $groupToAssignId) {
                    $groupId = $this->referenceResolver->resolveReference($groupToAssignId);
                    $groupToAssign = $this->userGroupMatcher->matchOneByKey($groupId);
                    $targetGroupIds[] = $groupToAssign->id;

                    $present = false;
                    foreach ($assignedGroups as $assignedGroup) {
                        // Make sure we assign the user only to groups he isn't already assigned to
                        if ($assignedGroup->id == $groupToAssign->id) {
                            $present = true;
                            break;
                        }
                    }
                    if (!$present) {
                        $userService->assignUserToUserGroup($user, $groupToAssign);
                    }
                }

                // Unassigning groups that are not in the list in the migration
                foreach ($assignedGroups as $assignedGroup) {
                    if (!in_array($assignedGroup->id, $targetGroupIds)) {
                        $userService->unAssignUserFromUserGroup($user, $assignedGroup);
                    }
                }
            }

            $userCollection[$key] = $user;
        }

        $this->setReferences($userCollection, $step);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $userCollection;
    }

    /**
     * Method to handle the delete operation of the migration instructions
     */
    protected function delete($step)

    {
        $userCollection = $this->matchUsers('delete', $step);

        $this->setReferences($userCollection, $step);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $userService = $this->repository->getUserService();

        foreach ($userCollection as $user) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $userService->deleteUser($user);
        }

        return $userCollection;
    }

    /**
     * @param string $action
     * @return UserCollection
     * @throws \Exception
     */
    protected function matchUsers($action, $step)
    {
        if (!isset($step->dsl['id']) && !isset($step->dsl['user_id']) && !isset($step->dsl['email']) && !isset($step->dsl['username']) && !isset($step->dsl['match'])) {
            throw new \Exception("The id, email or username of a user or a match condition is required to $action it");
        }

        // Backwards compat
        if (isset($step->dsl['match'])) {
            $match = $step->dsl['match'];
        } else {
            $conds = array();
            if (isset($step->dsl['id'])) {
                $conds['id'] = $step->dsl['id'];
            }
            if (isset($step->dsl['user_id'])) {
                $conds['id'] = $step->dsl['user_id'];
            }
            if (isset($step->dsl['email'])) {
                $conds['email'] = $step->dsl['email'];
            }
            if (isset($step->dsl['username'])) {
                $conds['login'] = $step->dsl['username'];
            }
            $match = $conds;
        }

        // convert the references passed in the match
        $match = $this->resolveReferencesRecursively($match);

        return $this->userMatcher->match($match);
    }

    /**
     * @param User $user
     * @param array $references the definitions of the references to set
     * @throws \InvalidArgumentException When trying to assign a reference to an unsupported attribute
     * @return array key: the reference names, values: the reference values
     */
    protected function getReferencesValues(User $user, array $references)
    {
        foreach ($references as $reference) {


            switch ($reference['attribute']) {
                case 'user_id':
                case 'id':
                    $value = $user->id;
                    break;
                case 'email':
                    $value = $user->email;
                    break;
                case 'enabled':
                    $value = $user->enabled;
                    break;
                case 'login':
                    $value = $user->login;
                    break;
                default:
                    throw new \InvalidArgumentException('User Manager does not support setting references for attribute ' . $reference['attribute']);
            }

            $refs[$reference['identifier']] = $value;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        }

        return $refs;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }
}


1		<?php
2
3		namespace Kaliop\eZMigrationBundle\Core\Executor;
4
5		use eZ\Publish\API\Repository\Values\User\User;
6		use Kaliop\eZMigrationBundle\API\Collection\UserCollection;
7		use Kaliop\eZMigrationBundle\Core\Matcher\UserGroupMatcher;
8		use Kaliop\eZMigrationBundle\Core\Matcher\UserMatcher;
9
10		/**
11		* Handles user migrations.
12		*/
13		class UserManager extends RepositoryExecutor
14		{
15		protected $supportedStepTypes = array('user');
16
17		protected $userMatcher;
18
19		protected $userGroupMatcher;
20
21		public function __construct(UserMatcher $userMatcher, UserGroupMatcher $userGroupMatcher)
22		{
23		$this->userMatcher = $userMatcher;
24		$this->userGroupMatcher = $userGroupMatcher;
25		}
26
27		/**
28		* Creates a user based on the DSL instructions.
29		*
30		* @todo allow setting extra profile attributes!
31		*/
32		protected function create($step)
33		{
34		if (!isset($step->dsl['groups'])) {
35		throw new \Exception('No user groups set to create user in.');
36		}
37
38		if (!is_array($step->dsl['groups'])) {
39		$step->dsl['groups'] = array($step->dsl['groups']);
40		}
41
42		$userService = $this->repository->getUserService();
43		$contentTypeService = $this->repository->getContentTypeService();
44
45		$userGroups = array();
46	View Code Duplication	foreach ($step->dsl['groups'] as $groupId) {
		0 ignored issues – show Duplication introduced 2017-02-25 15:40 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
47		$groupId = $this->referenceResolver->resolveReference($groupId);
48		$userGroup = $this->userGroupMatcher->matchOneByKey($groupId);
49
50		// q: in which case can we have no group? And should we throw an exception?
51		//if ($userGroup) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-10-06 08:36 UTC by Report Bug Copy Issue Report `72%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
52		$userGroups[] = $userGroup;
53		//}
54		}
55
56		// FIXME: Hard coding content type to user for now
57		$userContentType = $contentTypeService->loadContentTypeByIdentifier($this->getUserContentType($step));
58
59		$userCreateStruct = $userService->newUserCreateStruct(
60		$step->dsl['username'],
61		$step->dsl['email'],
62		$step->dsl['password'],
63		$this->getLanguageCode($step),
64		$userContentType
65		);
66		$userCreateStruct->setField('first_name', $step->dsl['first_name']);
67		$userCreateStruct->setField('last_name', $step->dsl['last_name']);
68
69		// Create the user
70		$user = $userService->createUser($userCreateStruct, $userGroups);
71
72		$this->setReferences($user, $step);
		0 ignored issues – show Documentation introduced 2018-05-12 16:46 UTC by Report Bug Copy Issue Report `$user` is of type `object<eZ\Publish\API\Re...itory\Values\User\User>`, but the function expects a `object<Object>\|object<Ka...ctCollectionCollection>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
73
74		return $user;
75		}
76
77		/**
78		* Method to handle the update operation of the migration instructions
79		*
80		* @todo allow setting extra profile attributes!
81		*/
82		protected function update($step)
83		{
84		$userCollection = $this->matchUsers('user', $step);
85
86		if (count($userCollection) > 1 && isset($step->dsl['references'])) {
87		throw new \Exception("Can not execute User update because multiple user match, and a references section is specified in the dsl. References can be set when only 1 user matches");
88		}
89
90		if (count($userCollection) > 1 && isset($step->dsl['email'])) {
91		throw new \Exception("Can not execute User update because multiple user match, and an email section is specified in the dsl.");
92		}
93
94		$userService = $this->repository->getUserService();
95
96		foreach ($userCollection as $key => $user) {
		0 ignored issues – show Bug introduced 2016-09-25 01:10 UTC by Report Bug Copy Issue Report The expression `$userCollection` of type `object<Kaliop\eZMigratio...on\UserCollection>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
97
98		$userUpdateStruct = $userService->newUserUpdateStruct();
99
100		if (isset($step->dsl['email'])) {
101		$userUpdateStruct->email = $step->dsl['email'];
102		}
103		if (isset($step->dsl['password'])) {
104		$userUpdateStruct->password = (string)$step->dsl['password'];
105		}
106		if (isset($step->dsl['enabled'])) {
107		$userUpdateStruct->enabled = $step->dsl['enabled'];
108		}
109
110		$user = $userService->updateUser($user, $userUpdateStruct);
111
112		if (isset($step->dsl['groups'])) {
113		$groups = $step->dsl['groups'];
114
115		if (!is_array($groups)) {
116		$groups = array($groups);
117		}
118
119		$assignedGroups = $userService->loadUserGroupsOfUser($user);
120
121		$targetGroupIds = [];
122		// Assigning new groups to the user
123		foreach ($groups as $groupToAssignId) {
124		$groupId = $this->referenceResolver->resolveReference($groupToAssignId);
125		$groupToAssign = $this->userGroupMatcher->matchOneByKey($groupId);
126		$targetGroupIds[] = $groupToAssign->id;
127
128		$present = false;
129		foreach ($assignedGroups as $assignedGroup) {
130		// Make sure we assign the user only to groups he isn't already assigned to
131		if ($assignedGroup->id == $groupToAssign->id) {
132		$present = true;
133		break;
134		}
135		}
136		if (!$present) {
137		$userService->assignUserToUserGroup($user, $groupToAssign);
138		}
139		}
140
141		// Unassigning groups that are not in the list in the migration
142		foreach ($assignedGroups as $assignedGroup) {
143		if (!in_array($assignedGroup->id, $targetGroupIds)) {
144		$userService->unAssignUserFromUserGroup($user, $assignedGroup);
145		}
146		}
147		}
148
149		$userCollection[$key] = $user;
150		}
151
152		$this->setReferences($userCollection, $step);
		0 ignored issues – show Documentation introduced 2018-05-12 16:46 UTC by Report Bug Copy Issue Report `$userCollection` is of type `object<Kaliop\eZMigratio...on\UserCollection>\|null`, but the function expects a `object<Object>\|object<Ka...ctCollectionCollection>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
153
154		return $userCollection;
155		}
156
157		/**
158		* Method to handle the delete operation of the migration instructions
159		*/
160	View Code Duplication	protected function delete($step)
		0 ignored issues – show Duplication introduced 2017-08-29 17:16 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
161		{
162		$userCollection = $this->matchUsers('delete', $step);
163
164		$this->setReferences($userCollection, $step);
		0 ignored issues – show Documentation introduced 2018-05-12 16:46 UTC by Report Bug Copy Issue Report `$userCollection` is of type `object<Kaliop\eZMigratio...on\UserCollection>\|null`, but the function expects a `object<Object>\|object<Ka...ctCollectionCollection>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
165
166		$userService = $this->repository->getUserService();
167
168		foreach ($userCollection as $user) {
		0 ignored issues – show Bug introduced 2016-09-25 01:10 UTC by Report Bug Copy Issue Report The expression `$userCollection` of type `object<Kaliop\eZMigratio...on\UserCollection>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
169		$userService->deleteUser($user);
170		}
171
172		return $userCollection;
173		}
174
175		/**
176		* @param string $action
177		* @return UserCollection
178		* @throws \Exception
179		*/
180		protected function matchUsers($action, $step)
181		{
182		if (!isset($step->dsl['id']) && !isset($step->dsl['user_id']) && !isset($step->dsl['email']) && !isset($step->dsl['username']) && !isset($step->dsl['match'])) {
183		throw new \Exception("The id, email or username of a user or a match condition is required to $action it");
184		}
185
186		// Backwards compat
187		if (isset($step->dsl['match'])) {
188		$match = $step->dsl['match'];
189		} else {
190		$conds = array();
191		if (isset($step->dsl['id'])) {
192		$conds['id'] = $step->dsl['id'];
193		}
194		if (isset($step->dsl['user_id'])) {
195		$conds['id'] = $step->dsl['user_id'];
196		}
197		if (isset($step->dsl['email'])) {
198		$conds['email'] = $step->dsl['email'];
199		}
200		if (isset($step->dsl['username'])) {
201		$conds['login'] = $step->dsl['username'];
202		}
203		$match = $conds;
204		}
205
206		// convert the references passed in the match
207		$match = $this->resolveReferencesRecursively($match);
208
209		return $this->userMatcher->match($match);
210		}
211
212		/**
213		* @param User $user
214		* @param array $references the definitions of the references to set
215		* @throws \InvalidArgumentException When trying to assign a reference to an unsupported attribute
216		* @return array key: the reference names, values: the reference values
217		*/
218		protected function getReferencesValues(User $user, array $references)
219		{
220	View Code Duplication	foreach ($references as $reference) {
		0 ignored issues – show Duplication introduced 2018-05-12 16:46 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
221
222		switch ($reference['attribute']) {
223		case 'user_id':
224		case 'id':
225		$value = $user->id;
226		break;
227		case 'email':
228		$value = $user->email;
229		break;
230		case 'enabled':
231		$value = $user->enabled;
232		break;
233		case 'login':
234		$value = $user->login;
235		break;
236		default:
237		throw new \InvalidArgumentException('User Manager does not support setting references for attribute ' . $reference['attribute']);
238		}
239
240		$refs[$reference['identifier']] = $value;
		0 ignored issues – show Coding Style Comprehensibility introduced 2018-05-12 16:46 UTC by Report Bug Copy Issue Report `$refs` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$refs = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
241		}
242
243		return $refs;
		0 ignored issues – show Bug introduced 2018-05-12 16:46 UTC by Report Bug Copy Issue Report The variable `$refs` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
244		}
245		}
246

kaliop-uk / ezmigrationbundle

Push — master ( 09cee1...75eab4 )

UserManager::setReferences() D

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like