tuyakhov\jsonapi\ResourceTrait

Complexity

Total Complexity

25

Size/Duplication

Total Lines	120
Duplicated Lines	5 %

Coupling/Cohesion

Components	0
Dependencies	5

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getId()	0	7	2
A	getType()	0	6	1
A	getResourceAttributes()	3	15	4
A	getResourceRelationships()	3	13	4
A	setResourceRelationship()	0	11	4
B	getRelationshipLinks()	0	18	5
B	resolveFields()	0	15	5

<?php
/**
 * @author Anton Tuyakhov <atuyakhov@gmail.com>
 */

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);

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

        $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));

Equals sign not aligned with surrounding assignments; expected 13 spaces but found 1 space

            $fieldDefinitions = array_combine($vars, $vars);
        }

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

This code seems to be duplicated across your project.

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

    /**
     * @return array
     */
    public function getResourceRelationships()
    {
        $relationships = [];
        $fields = [];

Equals sign not aligned with surrounding assignments; expected 8 spaces but found 1 space

        if ($this instanceof Arrayable) {
            $fields = $this->extraFields();
        }

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

This code seems to be duplicated across your project.

            $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);

It seems like link() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            }
        }
    }

    /**
     * @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) {

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.

            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;
    }
}

As per coding style, files should not end with a newline character.