Bdf\Prime\Relations\Util\ForeignKeyRelation

Complexity

Total Complexity

7

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Test Coverage

Coverage

66.67%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getDistantKeyValue()	0	4	1
A	setDistantKeyValue()	0	4	1
A	getLocalKeyValue()	0	15	3
A	setLocalKeyValue()	0	3	1
A	applyWhereKeys()	0	3	1

<?php

namespace Bdf\Prime\Relations\Util;

use Bdf\Prime\Query\QueryInterface;
use Bdf\Prime\Query\ReadCommandInterface;
use Bdf\Prime\Relations\AbstractRelation;
use Bdf\Prime\Relations\RelationInterface;
use Bdf\Prime\Repository\RepositoryInterface;

/**
 * Adds foreign key accessor helpers for relations based on single foreign key
 *
 * @psalm-require-extends AbstractRelation
 *
 * @template L as object
 * @template R as object
 */
trait ForeignKeyRelation
{
    /**
     * The local property for the relation
     *
     * @var string
     */
    protected $localKey;

    /**
     * The distant key
     *
     * @var string
     */
    protected $distantKey;


    /**
     * {@inheritdoc}
     *
     * @param Q $query

The type Bdf\Prime\Relations\Util\Q was not found. Maybe you did not declare it correctly or list all dependencies?

     * @param mixed $value
     * @return Q

Tag @return cannot be grouped with parameter tags in a doc comment

     * @template Q as \Bdf\Prime\Query\Contract\Whereable&ReadCommandInterface

Tag @template cannot be grouped with parameter tags in a doc comment

     * @psalm-suppress InvalidReturnType

Tag @psalm-suppress cannot be grouped with parameter tags in a doc comment

     *
     * @see AbstractRelation::applyWhereKeys()
     */
    protected function applyWhereKeys(ReadCommandInterface $query, $value): ReadCommandInterface

Expected 1 blank line before function; 2 found

    {
        return $query->where($this->distantKey, $value);

The method where() does not exist on Bdf\Prime\Query\ReadCommandInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Bdf\Prime\Query\ReadCommandInterface.

    }

    /**
     * Get the local key value from an entity
     * If an array is given, get array of key value
     *
     * @param L|L[] $entity
     *
     * @return mixed
     */
    protected function getLocalKeyValue($entity)
    {
        $mapper = $this->localRepository()->mapper();

        if (!is_array($entity)) {
            return $mapper->extractOne($entity, $this->localKey);
        }

        $keys = [];

        foreach ($entity as $e) {
            $keys[] = $mapper->extractOne($e, $this->localKey);
        }

        return $keys;
    }

    /**
     * Set the local key value on an entity
     *
     * @param L $entity

The type Bdf\Prime\Relations\Util\L was not found. Maybe you did not declare it correctly or list all dependencies?

     * @param mixed  $id
     *
     * @return void

If there is no return value for a function, there must not be a @return tag.

     */
    protected function setLocalKeyValue($entity, $id): void

Type hint "L" missing for $entity

    {
        $this->localRepository()->mapper()->hydrateOne($entity, $this->localKey, $id);
    }

    /**
     * Get the local key value from an entity
     *
     * @param R $entity

The type Bdf\Prime\Relations\Util\R was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @return mixed
     */
    protected function getDistantKeyValue($entity)

Type hint "R" missing for $entity

    {
        /** @psalm-suppress InvalidArgument */

The close comment tag must be the only content on the line

The open comment tag must be the only content on the line

Block comments must be started with /*

Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead

        return $this->relationRepository()->mapper()->extractOne($entity, $this->distantKey);
    }

    /**
     * Get the distance key value on an entity
     *
     * @param R $entity
     * @param mixed $id
     *
     * @return void

If there is no return value for a function, there must not be a @return tag.

     */
    protected function setDistantKeyValue($entity, $id): void

Type hint "R" missing for $entity

    {
        /** @psalm-suppress InvalidArgument */

The close comment tag must be the only content on the line

The open comment tag must be the only content on the line

Block comments must be started with /*

Inline doc block comments are not allowed; use "/* Comment */" or "// Comment" instead

        $this->relationRepository()->mapper()->hydrateOne($entity, $this->distantKey, $id);
    }

    /**
     * {@inheritdoc}
     *
     * @see RelationInterface::relationRepository()
     * @return RepositoryInterface<R>

Expected "RepositoryInterfaceR" but found "RepositoryInterface<R>" for function return type

     */
    abstract public function relationRepository(): RepositoryInterface;

    /**
     * {@inheritdoc}
     *
     * @see RelationInterface::localRepository()
     * @return RepositoryInterface<L>

Expected "RepositoryInterfaceL" but found "RepositoryInterface<L>" for function return type

     */
    abstract public function localRepository(): RepositoryInterface;
}