Nip\Records\Traits\TableStructure\TableStructureRecordsTrait

Complexity

Total Complexity

9

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Test Coverage

Coverage

73.91%

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getTableStructure()	0	7	2
A	initTableStructure()	0	3	1
A	initFields()	0	4	1
A	checkFieldsIsInitiated()	0	4	2
A	setTableStructure()	0	3	1
A	getFields()	0	5	1
A	hasField()	0	4	1

<?php

namespace Nip\Records\Traits\TableStructure;

/**
 * Trait TableStructureRecordsTrait
 * @package Nip\Records\Traits\TableStructure
 */
trait TableStructureRecordsTrait
{
    protected $tableStructure = null;

    /**
     * @var null|array
     */
    protected $fields = null;

    /**
     * @return null
     */
    public function getFields()
    {
        $this->checkFieldsIsInitiated();

        return $this->fields;

The expression return $this->fields returns the type array which is incompatible with the documented return type null.

    }

    protected function checkFieldsIsInitiated()
    {
        if ($this->fields === null) {
            $this->initFields();
        }
    }

    public function initFields()
    {
        $structure = $this->getTableStructure();
        $this->fields = array_keys($structure['fields']);
    }

    /**
     * @param string $name
     * @return bool
     */
    public function hasField(string $name)
    {
        $this->checkFieldsIsInitiated();
        return isset($this->fields[$name]);
    }

    /**
     * @return mixed
     */
    protected function getTableStructure()
    {
        if ($this->tableStructure == null) {
            $this->initTableStructure();
        }

        return $this->tableStructure;
    }

    /**
     * @param null $tableStructure

Are you sure the doc-type for parameter $tableStructure is correct as it would always require null to be passed?

     */
    public function setTableStructure($tableStructure)
    {
        $this->tableStructure = $tableStructure;
    }

    protected function initTableStructure()
    {
        $this->setTableStructure($this->getDB()->getMetadata()->describeTable($this->getTable()));

The method getTable() does not exist on Nip\Records\Traits\TableStructure\TableStructureRecordsTrait. Did you maybe mean getTableStructure()?

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

    }
}