AttachableEntityManager - Code Metrics - Inspection of "Merge pull request #311: Allow attaching external..." - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( b72595...6a420f )

unknown

created 2016-11-14 09:49 UTC

AttachableEntityManager A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
dl	0
loc	103
c	0
b	0
f	0
wmc	10
lcom	1
cbo	1
rs	10

5 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	setReferences()	6	1
B	addAttachedEntity()	25	3
A	getAttachedEntity()	17	3
A	removeAttachedEntity()	9	2

<?php
/**
 * YAWIK
 *
 * @filesource
 * @copyright (c) 2013 - 2016 Cross Solution (http://cross-solution.de)
 * @license   MIT
 * @author Miroslav Fedeleš <[email protected]>
 * @since 0.28
 */
namespace Core\Entity;

use Core\Repository\RepositoryService;

class AttachableEntityManager
{

    /**
     * @var RepositoryService
     */
    protected $repositories;

    /**
     * @var array
     */
    protected $references = [];

    /**
     * @param RepositoryService $repositories
     */
    public function __construct(RepositoryService $repositories)
    {
        $this->repositories = $repositories;
    }
    
    /**
     * @param array $references
     * @return AttachableEntityManager
     */
    public function setReferences(array & $references)
    {
        $this->references = & $references;
        
        return $this;
    }

    /**
     * Adds an $entity using an optional $key.
     * If $key is not provided then $entity's FQCN will be used as a key
     * Any existing $entity with the same $key will be replaced.
     *
     * @param IdentifiableEntityInterface $entity
     * @param string $key

     * @return AttachableEntityManager
     */
    public function addAttachedEntity(IdentifiableEntityInterface $entity, $key = null)
    {
        $className = get_class($entity);
        
        if (! isset($key)) {
            $key = $className;
        }
        
        $reference = [
            'repository' => $className
        ];
        $entityId = $entity->getId();
        
        // check if entity is not persisted
        if (! $entityId) {
            // persist entity & retrieve its ID
            $this->repositories->getRepository($className)->store($entity);
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 { }
            $entityId = $entity->getId();
        }
        
        $reference['id'] = $entityId;
        $this->references[$key] = $reference;
        
        return $this;
    }

    /**
     * @param string $key
     * @return IdentifiableEntityInterface|null
     */
    public function getAttachedEntity($key)
    {
        if (! isset($this->references[$key])) {
            return;
        }
        
        $reference = $this->references[$key];
        $entity = $this->repositories->getRepository($reference['repository'])
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 { }
            ->find($reference['id']);
        
        if (! $entity) {
            // remove reference if entity does not exists
            unset($this->references[$key]);
        }
        
        return $entity;
    }

    /**
     * @param string $key
     * @return bool Whether entity with given $key existed
     */
    public function removeAttachedEntity($key)

    {
        if (isset($this->references[$key])) {
            unset($this->references[$key]);
            return true;
        }
        
        return false;
    }
}


1			<?php
2			/**
3			* YAWIK
4			*
5			* @filesource
6			* @copyright (c) 2013 - 2016 Cross Solution (http://cross-solution.de)
7			* @license MIT
8			* @author Miroslav Fedeleš <[email protected]>
9			* @since 0.28
10			*/
11			namespace Core\Entity;
12
13			use Core\Repository\RepositoryService;
14
15			class AttachableEntityManager
16			{
17
18			/**
19			* @var RepositoryService
20			*/
21			protected $repositories;
22
23			/**
24			* @var array
25			*/
26			protected $references = [];
27
28			/**
29			* @param RepositoryService $repositories
30			*/
31			public function __construct(RepositoryService $repositories)
32			{
33			$this->repositories = $repositories;
34			}
35
36			/**
37			* @param array $references
38			* @return AttachableEntityManager
39			*/
40			public function setReferences(array & $references)
41			{
42			$this->references = & $references;
43
44			return $this;
45			}
46
47			/**
48			* Adds an $entity using an optional $key.
49			* If $key is not provided then $entity's FQCN will be used as a key
50			* Any existing $entity with the same $key will be replaced.
51			*
52			* @param IdentifiableEntityInterface $entity
53			* @param string $key
			0 ignored issues – show Documentation introduced 2016-11-09 11:53 UTC by Report Bug Copy Issue Report Should the type for parameter `$key` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
54			* @return AttachableEntityManager
55			*/
56			public function addAttachedEntity(IdentifiableEntityInterface $entity, $key = null)
57			{
58			$className = get_class($entity);
59
60			if (! isset($key)) {
61			$key = $className;
62			}
63
64			$reference = [
65			'repository' => $className
66			];
67			$entityId = $entity->getId();
68
69			// check if entity is not persisted
70			if (! $entityId) {
71			// persist entity & retrieve its ID
72			$this->repositories->getRepository($className)->store($entity);
			0 ignored issues – show Documentation Bug introduced 2016-11-09 11:53 UTC by Report Bug Copy Issue Report The method `getRepository` does not exist on `object<Core\Repository\RepositoryService>`? 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...
73			$entityId = $entity->getId();
74			}
75
76			$reference['id'] = $entityId;
77			$this->references[$key] = $reference;
78
79			return $this;
80			}
81
82			/**
83			* @param string $key
84			* @return IdentifiableEntityInterface\|null
85			*/
86			public function getAttachedEntity($key)
87			{
88			if (! isset($this->references[$key])) {
89			return;
90			}
91
92			$reference = $this->references[$key];
93			$entity = $this->repositories->getRepository($reference['repository'])
			0 ignored issues – show Documentation Bug introduced 2016-11-09 11:53 UTC by Report Bug Copy Issue Report The method `getRepository` does not exist on `object<Core\Repository\RepositoryService>`? 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...
94			->find($reference['id']);
95
96			if (! $entity) {
97			// remove reference if entity does not exists
98			unset($this->references[$key]);
99			}
100
101			return $entity;
102			}
103
104			/**
105			* @param string $key
106			* @return bool Whether entity with given $key existed
107			*/
108			public function removeAttachedEntity($key)
			0 ignored issues – show Coding Style introduced 2016-11-09 11:53 UTC by Report Bug Copy Issue Report `function removeAttachedEntity()` does not seem to conform to the naming convention (`^(?:is\|has\|should\|may\|supports)`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
109			{
110			if (isset($this->references[$key])) {
111			unset($this->references[$key]);
112			return true;
113			}
114
115			return false;
116			}
117			}
118

cross-solution / YAWIK

Push — develop ( b72595...6a420f )

AttachableEntityManager A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Duplication Side-by-Side

Filter issues like