Spiral\ORM\Entities\Nodes\Traits\DuplicateTrait

Complexity

Total Complexity

3

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	deduplicate()	0	17	2
A	duplicateCriteria()	0	4	1

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

namespace Spiral\ORM\Entities\Nodes\Traits;

/**
 * Trait provides ability for Node to ensure that given data is unique in selection.
 */
trait DuplicateTrait
{
    /**
     * @var string
     */
    private $primaryKey = '';

    /**
     * Aggregated duplicate data.
     *
     * @invisible
     * @var array
     */
    private $duplicates = [];

    /**
     * In many cases (for example if you have inload of HAS_MANY relation) record data can be
     * replicated by many result rows (duplicated). To prevent wrong data linking we have to
     * deduplicate such records. This is only internal loader functionality and required due data
     * tree are built using php references.
     *
     * Method will return true if data is unique handled before and false in opposite case.
     * Provided data array will be automatically linked with it's unique state using references.
     *
     * @param array $data Reference to parsed record data, reference will be pointed to valid and
     *                    existed data segment if such data was already parsed.
     *
     * @return bool
     */
    protected function deduplicate(array &$data): bool
    {
        $criteria = $this->duplicateCriteria($data);

        if (isset($this->duplicates[$criteria])) {
            //Duplicate is presented, let's reduplicate
            $data = $this->duplicates[$criteria];

            //Duplicate is presented
            return false;
        }

        //Remember record to prevent future duplicates
        $this->duplicates[$criteria] = &$data;

        return true;
    }

    /**
     * Calculate duplication criteria.
     *
     * @param array $data
     *
     * @return string
     */
    protected function duplicateCriteria(array &$data): string
    {
        return (string)$data[$this->primaryKey];
    }
}