UserDrupal8::addRole() - Code Metrics - Inspection of "Entity & Field Plugins" - jhedstrom/DrupalDriver - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#157)

unknown

created 2018-06-07 22:27 UTC

UserDrupal8::addRole() A

↳ Parent: UserDrupal8

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
c	0
b	0
f	0
rs	9.6666
cc	1
eloc	6
nc	1
nop	1

<?php

namespace Drupal\Driver\Plugin\DriverEntity;

use Drupal\Driver\Plugin\DriverEntityPluginDrupal8Base;

/**
 * A driver field plugin used to test selecting an arbitrary plugin.
 *
 * @DriverEntity(
 *   id = "user8",
 *   version = 8,
 *   weight = -100,
 *   entityTypes = {
 *     "user",
 *   },
 *   labelKeys = {
 *     "name",
 *     "mail",
 *   },
 * )
 */
class UserDrupal8 extends DriverEntityPluginDrupal8Base {

  /**
   * The id of the attached user.
   *
   * @var int
   *
   * @deprecated Use id() instead.
   */
  public $uid;

  /**
   * {@inheritdoc}
   */
  public function delete() {
    user_cancel(array(), $this->id(), 'user_cancel_delete');
  }

  /**
   * {@inheritdoc}
   */
  public function load($entityId) {
    $entity = parent::load($entityId);
    $this->uid = is_null($this->entity) ? NULL : $this->id();
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    return $entity;
  }

  /**
   * {@inheritdoc}
   */
  public function save() {
    parent::save();
    $this->uid = $this->id();
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
  }

  /**
   * {@inheritdoc}
   */
  public function set($identifier, $field) {
    // Ignore the role key passed by Drupal extension.
    if ($identifier !== 'role') {
      parent::set($identifier, $field);
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function getNewEntity() {
    $entity = parent::getNewEntity();
    $entity->set('status', 1);
    return $entity;
  }

  /**
   * Add a role by human-friendly identifier.
   *
   * @param string $roleIdentifier
   *   A human-friendly string identifying a role.
   */
  public function addRole($roleIdentifier) {
    // Use a driver field to convert identifier to id.
    $driverField = $this->getNewDriverField('roles', $roleIdentifier);
    $roleId = $driverField->getProcessedValues()[0]['target_id'];

    $roles = $this->getEntity()->getRoles(TRUE);
    $roles[] = $roleId;
    $this->getEntity()->set('roles', array_unique($roles));
  }

}


1			<?php
2
3			namespace Drupal\Driver\Plugin\DriverEntity;
4
5			use Drupal\Driver\Plugin\DriverEntityPluginDrupal8Base;
6
7			/**
8			* A driver field plugin used to test selecting an arbitrary plugin.
9			*
10			* @DriverEntity(
11			* id = "user8",
12			* version = 8,
13			* weight = -100,
14			* entityTypes = {
15			* "user",
16			* },
17			* labelKeys = {
18			* "name",
19			* "mail",
20			* },
21			* )
22			*/
23			class UserDrupal8 extends DriverEntityPluginDrupal8Base {
24
25			/**
26			* The id of the attached user.
27			*
28			* @var int
29			*
30			* @deprecated Use id() instead.
31			*/
32			public $uid;
33
34			/**
35			* {@inheritdoc}
36			*/
37			public function delete() {
38			user_cancel(array(), $this->id(), 'user_cancel_delete');
39			}
40
41			/**
42			* {@inheritdoc}
43			*/
44			public function load($entityId) {
45			$entity = parent::load($entityId);
46			$this->uid = is_null($this->entity) ? NULL : $this->id();
			0 ignored issues – show Documentation Bug introduced 2018-06-02 13:27 UTC by Report Bug Copy Issue Report It seems like `is_null($this->entity) ? NULL : $this->id()` can also be of type `string`. However, the property `$uid` is declared as type `integer`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history... Deprecated Code introduced 2018-01-14 13:09 UTC by Report Bug Copy Issue Report The property `Drupal\Driver\Plugin\Dri...ntity\UserDrupal8::$uid` has been deprecated with message: Use id() instead. This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
47			return $entity;
48			}
49
50			/**
51			* {@inheritdoc}
52			*/
53			public function save() {
54			parent::save();
55			$this->uid = $this->id();
			0 ignored issues – show Documentation Bug introduced 2018-06-02 13:27 UTC by Report Bug Copy Issue Report It seems like `$this->id()` can also be of type `string`. However, the property `$uid` is declared as type `integer`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history... Deprecated Code introduced 2018-01-14 13:09 UTC by Report Bug Copy Issue Report The property `Drupal\Driver\Plugin\Dri...ntity\UserDrupal8::$uid` has been deprecated with message: Use id() instead. This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
56			}
57
58			/**
59			* {@inheritdoc}
60			*/
61			public function set($identifier, $field) {
62			// Ignore the role key passed by Drupal extension.
63			if ($identifier !== 'role') {
64			parent::set($identifier, $field);
65			}
66			}
67
68			/**
69			* {@inheritdoc}
70			*/
71			protected function getNewEntity() {
72			$entity = parent::getNewEntity();
73			$entity->set('status', 1);
74			return $entity;
75			}
76
77			/**
78			* Add a role by human-friendly identifier.
79			*
80			* @param string $roleIdentifier
81			* A human-friendly string identifying a role.
82			*/
83			public function addRole($roleIdentifier) {
84			// Use a driver field to convert identifier to id.
85			$driverField = $this->getNewDriverField('roles', $roleIdentifier);
86			$roleId = $driverField->getProcessedValues()[0]['target_id'];
87
88			$roles = $this->getEntity()->getRoles(TRUE);
89			$roles[] = $roleId;
90			$this->getEntity()->set('roles', array_unique($roles));
91			}
92
93			}
94

jhedstrom / DrupalDriver

Pull Request — master (#157)

UserDrupal8::addRole() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like