Spiral\ORM\Entities\Relations\Traits\LookupTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	50
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
	key()	0	1	?
	primaryColumnOf()	0	1	?
A	lookupKey()	0	22	4

<?php
/**
 * Spiral, Core Components
 *
 * @author Wolfy-J
 */

namespace Spiral\ORM\Entities\Relations\Traits;

use Spiral\ORM\ContextualCommandInterface;
use Spiral\ORM\RecordInterface;

/**
 * Looks for key values in command context AND in outer field if possible.
 */
trait LookupTrait
{
    /**
     * @param int                        $key
     * @param RecordInterface            $record
     * @param ContextualCommandInterface $command
     *
     * @return mixed|null
     */
    protected function lookupKey(
        int $key,
        RecordInterface $record,
        ContextualCommandInterface $command = null
    ) {
        $key = $this->key($key);

        if (!empty($command)) {
            $context = $command->getContext();
            if (!empty($context[$key])) {
                //Key value found in a context
                return $context[$key];
            }

            if ($key == $this->primaryColumnOf($record)) {
                return $command->primaryKey();
            }
        }

        //Fallback lookup in a record
        return $record->getField($key, null);
    }

    /**
     * Key name.
     *
     * @param int $key
     *
     * @return string|null
     */
    abstract protected function key(int $key);

    /**
     * Get primary key column
     *
     * @param RecordInterface $record
     *
     * @return string
     */
    abstract protected function primaryColumnOf(RecordInterface $record): string;
}