HierarchyTransformerTrait - Code Metrics - Inspection of "Merge branch 'develop'" - ddimaria/Laravel-REST-CMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 08af9f...ec8f81 )

by David

created 2016-01-22 00:08 UTC

HierarchyTransformerTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	33
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	2
Bugs	0	Features	1

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

2 Methods

Rating	Name	Duplication	Size	Complexity
A	setupHierarchy()	0	5	1
A	includeParent()	0	4	1

<?php namespace App\LaravelRestCms;

use App\LaravelRestCms\BaseTransformer;

trait HierarchyTransformerTrait {

    /**
     * The transformer of the parent (usually itself)
     * 
     * @var string
     */
    protected $parentTransformer;

    /**
     * Sets instance vars and adds includes
     * 
     * @param  string $parentTransformer 
     * @param  string $method            
     */
    protected function setupHierarchy($parentTransformer, $method = 'parent')
    {
        $this->parentTransformer = $parentTransformer;
        parent::addToIncludes($method);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Include Parent
     * 
     * @param \App\LaravelRestCms\BaseModel
     * @return \League\Fractal\ItemResource
     */
    public function includeParent(BaseModel $model)
    {
        return $this->collection($model->parent, new $this->parentTransformer);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }
    
}

1			<?php namespace App\LaravelRestCms;
2
3			use App\LaravelRestCms\BaseTransformer;
4
5			trait HierarchyTransformerTrait {
6
7			/**
8			* The transformer of the parent (usually itself)
9			*
10			* @var string
11			*/
12			protected $parentTransformer;
13
14			/**
15			* Sets instance vars and adds includes
16			*
17			* @param string $parentTransformer
18			* @param string $method
19			*/
20			protected function setupHierarchy($parentTransformer, $method = 'parent')
21			{
22			$this->parentTransformer = $parentTransformer;
23			parent::addToIncludes($method);
			0 ignored issues – show Comprehensibility Bug introduced 2016-01-22 00:20 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`addToIncludes()` instead of `setupHierarchy()`). Are you sure this is correct? If so, you might want to change this to `$this->addToIncludes()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
24			}
25
26			/**
27			* Include Parent
28			*
29			* @param \App\LaravelRestCms\BaseModel
30			* @return \League\Fractal\ItemResource
31			*/
32			public function includeParent(BaseModel $model)
33			{
34			return $this->collection($model->parent, new $this->parentTransformer);
			0 ignored issues – show Documentation introduced 2016-01-19 13:45 UTC by Report Bug Copy Issue Report The property `parent` does not exist on `object<App\LaravelRestCms\BaseModel>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Bug introduced 2016-01-19 13:45 UTC by Report Bug Copy Issue Report It seems like `collection()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
35			}
36
37			}

ddimaria / Laravel-REST-CMS

Push — master ( 08af9f...ec8f81 )

HierarchyTransformerTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Duplication Side-by-Side

Filter issues like