HasRelations::newMorphTo() - Code Metrics - Inspection of "Refactor relationship name guessing to a dedicated..." - swisnl/json-api-client - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 722753...1b1263 )

by Jasper
created 2021-07-01 07:51 UTC
HasRelations::newMorphTo() A

↳ Parent: HasRelations
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	1
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
<?php

namespace Swis\JsonApi\Client\Concerns;

use Swis\JsonApi\Client\Collection;
use Swis\JsonApi\Client\Interfaces\DataInterface;
use Swis\JsonApi\Client\Interfaces\ManyRelationInterface;
use Swis\JsonApi\Client\Interfaces\OneRelationInterface;
use Swis\JsonApi\Client\Links;
use Swis\JsonApi\Client\Meta;
use Swis\JsonApi\Client\Relations\HasManyRelation;
use Swis\JsonApi\Client\Relations\HasOneRelation;
use Swis\JsonApi\Client\Relations\MorphToManyRelation;
use Swis\JsonApi\Client\Relations\MorphToRelation;
use Swis\JsonApi\Client\Util;

trait HasRelations
{
    /**
     * @var \Swis\JsonApi\Client\Interfaces\OneRelationInterface[]|\Swis\JsonApi\Client\Interfaces\ManyRelationInterface[]
     */
    protected $relations = [];

    /**
     * Create a singular relation to another item.
     *
     * @param string      $itemClass
     * @param string|null $name
     *
     * @return \Swis\JsonApi\Client\Relations\HasOneRelation
     */
    public function hasOne(string $itemClass, string $name = null): OneRelationInterface
    {
        $name = $name ?: $this->guessRelationName();

        if (!array_key_exists($name, $this->relations)) {
            $this->relations[$name] = $this->newHasOne((new $itemClass())->getType());
        }

        return $this->relations[$name];
    }

    protected function newHasOne(string $type): OneRelationInterface
    {
        return new HasOneRelation($type);
    }

    /**
     * Create a plural relation to another item.
     *
     * @param string      $itemClass
     * @param string|null $name
     *
     * @return \Swis\JsonApi\Client\Relations\HasManyRelation
     */
    public function hasMany(string $itemClass, string $name = null): ManyRelationInterface
    {
        $name = $name ?: $this->guessRelationName();

        if (!array_key_exists($name, $this->relations)) {
            $this->relations[$name] = $this->newHasMany((new $itemClass())->getType());
        }

        return $this->relations[$name];
    }

    protected function newHasMany(string $type): ManyRelationInterface
    {
        return new HasManyRelation($type);
    }

    /**
     * Create a singular relation.
     *
     * @param string|null $name
     *
     * @return \Swis\JsonApi\Client\Relations\MorphToRelation
     */
    public function morphTo(string $name = null): OneRelationInterface
    {
        $name = $name ?: $this->guessRelationName();

        if (!array_key_exists($name, $this->relations)) {
            $this->relations[$name] = $this->newMorphTo();
        }

        return $this->relations[$name];
    }

    protected function newMorphTo(): OneRelationInterface
    {
        return new MorphToRelation();
    }

    /**
     * Create a plural relation.
     *
     * @param string|null $name
     *
     * @return \Swis\JsonApi\Client\Relations\MorphToManyRelation
     */
    public function morphToMany(string $name = null): ManyRelationInterface
    {
        $name = $name ?: $this->guessRelationName();

        if (!array_key_exists($name, $this->relations)) {
            $this->relations[$name] = $this->newMorphToMany();
        }

        return $this->relations[$name];
    }

    protected function newMorphToMany(): ManyRelationInterface
    {
        return new MorphToManyRelation();
    }

    /**
     * Guess the relationship name.
     *
     * @return string
     */
    protected function guessRelationName(): string
    {
        [$one, $two, $caller] = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 3);

        return Util::stringSnake($caller['function']);
    }

    /**
     * @return \Swis\JsonApi\Client\Interfaces\OneRelationInterface[]|\Swis\JsonApi\Client\Interfaces\ManyRelationInterface[]
     */
    public function getRelations(): array
    {
        return $this->relations;
    }

    /**
     * @param string $name
     *
     * @return \Swis\JsonApi\Client\Interfaces\OneRelationInterface|\Swis\JsonApi\Client\Interfaces\ManyRelationInterface|null
     */
    public function getRelation(string $name)
    {
        return $this->relations[$name] ?? null;
    }

    /**
     * Get the relationship data (included).
     *
     * @param string $name
     *
     * @return \Swis\JsonApi\Client\Interfaces\DataInterface|null
     */
    public function getRelationValue(string $name): ?DataInterface
    {
        // If the "attribute" exists as a method on the model, we will just assume
        // it is a relationship and will load and return the included items in the relationship
        $method = Util::stringCamel($name);
        if (method_exists($this, $method)) {
            return $this->$method()->getIncluded();
        }

        // If the "attribute" exists as a relationship on the model, we will return
        // the included items in the relationship
        if ($this->hasRelation($name)) {
            return $this->getRelation($name)->getIncluded();
        }

        return null;
    }

    /**
     * Set the specific relationship on the model.
     *
     * @param string                                                   $name
     * @param \Swis\JsonApi\Client\Interfaces\DataInterface|false|null $data
     * @param \Swis\JsonApi\Client\Links|null                          $links
     * @param \Swis\JsonApi\Client\Meta|null                           $meta
     *
     * @return static
     */
    public function setRelation(string $name, $data = false, Links $links = null, Meta $meta = null)
    {
        $method = Util::stringCamel($name);
        if (method_exists($this, $method)) {
            /** @var \Swis\JsonApi\Client\Interfaces\OneRelationInterface|\Swis\JsonApi\Client\Interfaces\ManyRelationInterface $relationObject */
            $relationObject = $this->$method();
        } elseif ($data instanceof Collection) {
            $relationObject = $this->morphToMany($name);
        } else {
            $relationObject = $this->morphTo($name);
        }

        if ($data !== false) {
            $relationObject->dissociate();
            if ($data !== null) {
                $relationObject->associate($data);
                $relationObject->associate(/** @scrutinizer ignore-type */ $data);
            }
        }
        $relationObject->setLinks($links);
        $relationObject->setMeta($meta);

        return $this;
    }

    /**
     * @param string $name
     *
     * @return bool
     */
    public function hasRelation(string $name): bool
    {
        return array_key_exists($name, $this->relations);
    }

    /**
     * @param string $name
     *
     * @return static
     */
    public function unsetRelation(string $name)
    {
        unset($this->relations[$name]);

        return $this;
    }
}

swisnl / json-api-client

Push — master ( 722753...1b1263 )

HasRelations::newMorphTo() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
