Nip\Records\Traits\Unique\RecordsTrait

Complexity

Total Complexity

17

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Test Coverage

Coverage

93.18%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getUniqueFields()	0	7	2
A	generateExistsParams()	0	16	3
A	initUniqueFields()	0	11	4
A	generateUniqueConditions()	0	8	2
A	generateUniqueCondition()	0	7	2
A	exists()	0	20	4

<?php

namespace Nip\Records\Traits\Unique;

use Nip\Records\AbstractModels\Record;

/**
 * Class RecordsTrait
 * @package Nip\Records\Traits\Unique
 */
trait RecordsTrait
{
    protected $uniqueFields = null;

    /**
     * @param Record $item
     * @return bool|false|Record
     */
    public function exists(Record $item)
    {
        $params = $this->generateExistsParams($item);

        if (!$params) {

The expression $params of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

$params is a non-empty array, thus ! $params is always false.

            return false;
        }

        $where = $params['where'];
        $uniqueWhere = [];
        foreach ($where as $key => $value) {
            if (strpos($key, 'UNQ') !== false) {
                $uniqueWhere[] = $value;
                unset($params['where'][$key]);
            }
        }

        $params['where'][] = implode(' OR ', $uniqueWhere);

        return $this->findOneByParams($params);

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

    }

    /**
     * @param Record $item
     * @return array|bool
     */
    public function generateExistsParams(Record $item)
    {
        $conditions = $this->generateUniqueConditions($item);

        if (count($conditions) < 1) {
            return false;
        }

        $params = [];
        $params['where'] = $conditions;

        $pk = $this->getPrimaryKey();

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

        if ($item->getPrimaryKey()) {
            $params['where'][] = ["$pk != ?", $item->getPrimaryKey()];
        }
        return $params;
    }

    /**
     * @param Record $item
     * @return array|bool
     */
    public function generateUniqueConditions(Record $item)
    {
        $uniqueFields = $this->getUniqueFields();

Are you sure the assignment to $uniqueFields is correct as $this->getUniqueFields() targeting Nip\Records\Traits\Unique\RecordsTrait::getUniqueFields() seems to always return null.

        $conditions = [];
        foreach ($uniqueFields as $uniqueName => $fields) {

The expression $uniqueFields of type null is not traversable.

            $conditions[$uniqueName . '-UNQ'] = $this->generateUniqueCondition($item, $fields);
        }
        return $conditions;
    }

    /**
     * @param Record $item
     * @param $fields
     * @return string
     */
    protected function generateUniqueCondition(Record $item, $fields)
    {
        $conditions = [];
        foreach ($fields as $field) {
            $conditions[] = "`$field` = '{$item->{$field}}'";
        }
        return implode(' AND ', $conditions);
    }

    /**
     * @return null
     */
    public function getUniqueFields()
    {
        if ($this->uniqueFields === null) {
            $this->initUniqueFields();
        }

        return $this->uniqueFields;
    }

    /**
     * @return array|null
     */
    public function initUniqueFields()
    {
        $this->uniqueFields = [];
        $structure = $this->getTableStructure();

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

        foreach ($structure['indexes'] as $name => $index) {
            if ($index['unique'] && $name != 'PRIMARY') {
                $this->uniqueFields[$name] = $index['fields'];
            }
        }

        return $this->uniqueFields;
    }
}