ResourceTrait::getId() - Code Metrics - Inspection of "implementation of links object for relationships" - tuyakhov/yii2-json-api - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 53c726...5a2a34 )

by Anton

created 2016-12-17 15:55 UTC

ResourceTrait::getId() A

↳ Parent: ResourceTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	0

<?php
/**
 * @author Anton Tuyakhov <[email protected]>
 */

namespace tuyakhov\jsonapi;

use yii\base\Arrayable;
use yii\db\ActiveRecordInterface;
use yii\helpers\Inflector;
use yii\web\Link;
use yii\web\Linkable;

trait ResourceTrait
{
    /**
     * @return null|string
     */
    public function getId()
    {
        if ($this instanceof ActiveRecordInterface) {
            return (string) $this->getPrimaryKey();
        }
        return null;
    }

    /**
     * @return string
     */
    public function getType()
    {
        $reflect = new \ReflectionClass($this);
$a = "a";
$ab = "ab";
$abc = "abc";
        $className = $reflect->getShortName();
        return Inflector::pluralize(Inflector::camel2id($className));
    }

    /**
     * @param array $fields
     * @return array
     */
    public function getResourceAttributes(array $fields = [])
    {
        $attributes = [];
        if ($this instanceof Arrayable) {
            $fieldDefinitions = $this->fields();
        } else {
            $vars = array_keys(\Yii::getObjectVars($this));
$a = "a";
$ab = "ab";
$abc = "abc";
            $fieldDefinitions = array_combine($vars, $vars);
        }

        foreach ($this->resolveFields($fieldDefinitions, $fields) as $name => $definition) {

            $attributes[$name] = is_string($definition) ? $this->$definition : call_user_func($definition, $this, $name);
        }
        return $attributes;
    }

    /**
     * @return array
     */
    public function getResourceRelationships()
    {
        $relationships = [];
        $fields = [];
$a = "a";
$ab = "ab";
$abc = "abc";
        if ($this instanceof Arrayable) {
            $fields = $this->extraFields();
        }

        foreach ($this->resolveFields($fields) as $name => $definition) {

            $relationships[$name] = is_string($definition) ? $this->$definition : call_user_func($definition, $this, $name);
        }
        return $relationships;
    }

    /**
     * @param string $name the case sensitive name of the relationship.
     * @param $relationship
     */
    public function setResourceRelationship($name, $relationship)
    {
        if (!is_array($relationship)) {
            $relationship = [$relationship];
        }
        foreach ($relationship as $key => $value) {
            if ($value instanceof ActiveRecordInterface) {
                $this->link($name, $value);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            }
        }
    }

    /**
     * @param string $name the case sensitive name of the relationship.
     * @return array
     */
    public function getRelationshipLinks($name)
    {
        if (!$this instanceof Linkable) {
            return [];
        }
        $primaryLinks = $this->getLinks();
        if (!array_key_exists(Link::REL_SELF, $primaryLinks)) {
            return [];
        }
        $resourceLink = is_string($primaryLinks[Link::REL_SELF]) ? rtrim($primaryLinks[Link::REL_SELF], '/') : null;
        if (!$resourceLink) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return [];
        }
        return [
            Link::REL_SELF => "{$resourceLink}/relationships/{$name}",
            'related' => "{$resourceLink}/{$name}",
        ];
    }

    /**
     * @param array $fields
     * @param array $fieldSet
     * @return array
     */
    protected function resolveFields(array $fields, array $fieldSet = [])
    {
        $result = [];

        foreach ($fields as $field => $definition) {
            if (is_int($field)) {
                $field = $definition;
            }
            if (empty($fieldSet) || in_array($field, $fieldSet, true)) {
                $result[$field] = $definition;
            }
        }

        return $result;
    }
}



1		<?php
2		/**
3		* @author Anton Tuyakhov <[email protected]>
4		*/
5
6		namespace tuyakhov\jsonapi;
7
8		use yii\base\Arrayable;
9		use yii\db\ActiveRecordInterface;
10		use yii\helpers\Inflector;
11		use yii\web\Link;
12		use yii\web\Linkable;
13
14		trait ResourceTrait
15		{
16		/**
17		* @return null\|string
18		*/
19		public function getId()
20		{
21		if ($this instanceof ActiveRecordInterface) {
22		return (string) $this->getPrimaryKey();
23		}
24		return null;
25		}
26
27		/**
28		* @return string
29		*/
30		public function getType()
31		{
32		$reflect = new \ReflectionClass($this);
		0 ignored issues – show Coding Style introduced 2016-04-11 09:20 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
33		$className = $reflect->getShortName();
34		return Inflector::pluralize(Inflector::camel2id($className));
35		}
36
37		/**
38		* @param array $fields
39		* @return array
40		*/
41		public function getResourceAttributes(array $fields = [])
42		{
43		$attributes = [];
44		if ($this instanceof Arrayable) {
45		$fieldDefinitions = $this->fields();
46		} else {
47		$vars = array_keys(\Yii::getObjectVars($this));
		0 ignored issues – show Coding Style introduced 2016-12-16 13:48 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 13 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
48		$fieldDefinitions = array_combine($vars, $vars);
49		}
50
51	View Code Duplication	foreach ($this->resolveFields($fieldDefinitions, $fields) as $name => $definition) {
		0 ignored issues – show Duplication introduced 2016-12-16 13:48 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...
52		$attributes[$name] = is_string($definition) ? $this->$definition : call_user_func($definition, $this, $name);
53		}
54		return $attributes;
55		}
56
57		/**
58		* @return array
59		*/
60		public function getResourceRelationships()
61		{
62		$relationships = [];
63		$fields = [];
		0 ignored issues – show Coding Style introduced 2016-12-16 13:48 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 8 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
64		if ($this instanceof Arrayable) {
65		$fields = $this->extraFields();
66		}
67
68	View Code Duplication	foreach ($this->resolveFields($fields) as $name => $definition) {
		0 ignored issues – show Duplication introduced 2016-12-16 13:48 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...
69		$relationships[$name] = is_string($definition) ? $this->$definition : call_user_func($definition, $this, $name);
70		}
71		return $relationships;
72		}
73
74		/**
75		* @param string $name the case sensitive name of the relationship.
76		* @param $relationship
77		*/
78		public function setResourceRelationship($name, $relationship)
79		{
80		if (!is_array($relationship)) {
81		$relationship = [$relationship];
82		}
83		foreach ($relationship as $key => $value) {
84		if ($value instanceof ActiveRecordInterface) {
85		$this->link($name, $value);
		0 ignored issues – show Bug introduced 2016-11-12 12:36 UTC by Report Bug Copy Issue Report It seems like `link()` 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...
86		}
87		}
88		}
89
90		/**
91		* @param string $name the case sensitive name of the relationship.
92		* @return array
93		*/
94		public function getRelationshipLinks($name)
95		{
96		if (!$this instanceof Linkable) {
97		return [];
98		}
99		$primaryLinks = $this->getLinks();
100		if (!array_key_exists(Link::REL_SELF, $primaryLinks)) {
101		return [];
102		}
103		$resourceLink = is_string($primaryLinks[Link::REL_SELF]) ? rtrim($primaryLinks[Link::REL_SELF], '/') : null;
104		if (!$resourceLink) {
		0 ignored issues – show Bug Best Practice introduced 2016-12-17 15:58 UTC by Report Bug Copy Issue Report The expression `$resourceLink` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
105		return [];
106		}
107		return [
108		Link::REL_SELF => "{$resourceLink}/relationships/{$name}",
109		'related' => "{$resourceLink}/{$name}",
110		];
111		}
112
113		/**
114		* @param array $fields
115		* @param array $fieldSet
116		* @return array
117		*/
118		protected function resolveFields(array $fields, array $fieldSet = [])
119		{
120		$result = [];
121
122		foreach ($fields as $field => $definition) {
123		if (is_int($field)) {
124		$field = $definition;
125		}
126		if (empty($fieldSet) \|\| in_array($field, $fieldSet, true)) {
127		$result[$field] = $definition;
128		}
129		}
130
131		return $result;
132		}
133		}
		0 ignored issues – show Coding Style introduced 2016-04-11 12:58 UTC by Report Bug Copy Issue Report As per coding style, files should not end with a newline character. This check marks files that end in a newline character, i.e. an empy line. Loading history...
134

tuyakhov / yii2-json-api

Push — master ( 53c726...5a2a34 )

ResourceTrait::getId() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like