EntityUtils - Code Metrics - dontdrinkandroot/doctrine.php - Measure and Improve Code Quality continuously with Scrutinizer

EntityUtils A
last analyzed 2020-07-02 21:24 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
wmc	3
lcom	0
cbo	1
dl	0
loc	34
ccs	7
cts	7
cp	1
rs	10
c	0
b	0
f	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	collectIds()	0	9	2
A	isUuid()	0	4	1

<?php

namespace Dontdrinkandroot\Utils;

use Dontdrinkandroot\Entity\EntityInterface;
use Dontdrinkandroot\Entity\UuidHelper;
use Ramsey\Uuid\Uuid;

/**
 * @author Philip Washington Sorst <[email protected]>
 */
class EntityUtils
{
    /**
     * @deprecated
     */
    public const VALID_UUID_PATTERN = '^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$';

    /**
     * @param EntityInterface[] $entities
     *
     * @return array
     */
    public static function collectIds(array $entities): array
    {
        $ids = [];
        foreach ($entities as $entity) {
            $ids[] = $entity->getId();
        }

        return $ids;
    }

    /**
     * @param $id
     *
     * @return bool
     * @deprecated Use Ramsey\Uuid::isValid instead
     *
     */
    public static function isUuid($id): bool
    {
        return Uuid::isValid($id);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }
}


1		<?php
2
3		namespace Dontdrinkandroot\Utils;
4
5		use Dontdrinkandroot\Entity\EntityInterface;
6		use Dontdrinkandroot\Entity\UuidHelper;
7		use Ramsey\Uuid\Uuid;
8
9		/**
10		* @author Philip Washington Sorst <[email protected]>
11		*/
12		class EntityUtils
13		{
14		/**
15		* @deprecated
16		*/
17		public const VALID_UUID_PATTERN = '^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$';
18
19		/**
20		* @param EntityInterface[] $entities
21		*
22		* @return array
23		*/
24	2	public static function collectIds(array $entities): array
25		{
26	2	$ids = [];
27	2	foreach ($entities as $entity) {
28	2	$ids[] = $entity->getId();
29		}
30
31	2	return $ids;
32		}
33
34		/**
35		* @param $id
36		*
37		* @return bool
38		* @deprecated Use Ramsey\Uuid::isValid instead
39		*
40		*/
41	2	public static function isUuid($id): bool
42		{
43	2	return Uuid::isValid($id);
		0 ignored issues – show Bug introduced 2020-01-01 14:49 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Ramsey\Uuid\Uuid` as the method `isValid()` does only exist in the following sub-classes of `Ramsey\Uuid\Uuid`: `Ramsey\Uuid\DegradedUuid`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
44		}
45		}
46

dontdrinkandroot / doctrine.php

EntityUtils A last analyzed 2020-07-02 21:24 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

2 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like

EntityUtils A
last analyzed 2020-07-02 21:24 UTC