Rougin\Wildfire\Traits\ObjectTrait

Complexity

Total Complexity

17

Size/Duplication

Total Lines	130
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

91.84%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
D	createObject()	0	44	10
	find()	0	1	?
A	setForeignField()	0	16	2
B	getModel()	0	18	5
	getTableName()	0	1	?

<?php

namespace Rougin\Wildfire\Traits;

use CI_Model;
use Rougin\Describe\Column;

/**
 * Object Trait
 *
 * @package Wildfire
 * @author  Rougin Royce Gutib <rougingutib@gmail.com>
 *
 * @property \Rougin\Describe\Describe $describe
 */
trait ObjectTrait
{
    /**
     * @var array
     */
    protected $tables = [];

    /**
     * Creates an object from the specified table and row.
     *
     * @param  string  $table
     * @param  object  $row
     * @param  boolean $isForeignKey
     * @return array
     */
    protected function createObject($table, $row, $isForeignKey = false)
    {
        list($model, $newTable) = $this->getModel($table, $isForeignKey);

        if (! array_key_exists($newTable, $this->tables)) {
            $tableInfo = $this->describe->getTable($newTable);

            $this->tables[$newTable] = $tableInfo;
        } else {
            $tableInfo = $this->tables[$newTable];
        }

        $columns = [];
        $hidden  = [];

        if (method_exists($model, 'getColumns')) {
            $columns = $model->getColumns();
        } elseif (property_exists($model, 'columns')) {
            // NOTE: To be removed in v1.0.0
            $columns = $model->columns;
        }

        // NOTE: To be removed in v1.0.0 (if condition only)
        if (method_exists($model, 'getHiddenColumns')) {
            $hidden = $model->getHiddenColumns();
        }

        foreach ($tableInfo as $column) {
            $key = $column->getField();

            $inHiddenColumns = ! empty($hidden) && in_array($key, $hidden);
            $inColumns       = ! empty($columns) && ! in_array($key, $columns);

            if ($inColumns || $inHiddenColumns) {
                continue;
            }

            $model->$key = $row->$key;

            $this->setForeignField($model, $column);
        }

        return $model;
    }

    /**
     * Finds the row from the specified ID or with the list of delimiters from
     * the specified table.
     *
     * @param  string         $table
     * @param  array|integer  $delimiters
     * @param  boolean        $isForeignKey
     * @return object|boolean
     */
    abstract protected function find($table, $delimiters = [], $isForeignKey = false);

    /**
     * Sets the foreign field of the column, if any.
     *
     * @param  \CI_Model               $model
     * @param  \Rougin\Describe\Column $column
     * @return void
     */
    protected function setForeignField(CI_Model $model, Column $column)
    {
        if (! $column->isForeignKey()) {
            return;
        }

        $columnName    = $column->getField();
        $foreignColumn = $column->getReferencedField();
        $foreignTable  = $column->getReferencedTable();

        $delimiters  = [ $foreignColumn => $model->$columnName ];
        $foreignData = $this->find($foreignTable, $delimiters, true);
        $newColumn   = $this->getTableName($foreignTable, true);

        $model->$newColumn = $foreignData;
    }

    /**
     * Gets the model class of the said table.
     *
     * @param  string|null $table
     * @param  boolean     $isForeignKey
     * @return array
     */
    protected function getModel($table = null, $isForeignKey = false)
    {
        if ($table == null && $this->table == null) {

The property table does not seem to exist. Did you mean tables?

It seems like you are loosely comparing $table of type string|null against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            return [ null, '' ];
        }

        $newTable = $this->getTableName($table, $isForeignKey);
        $model = new $newTable;

        if (method_exists($model, 'getTableName')) {
            $newTable = $model->getTableName();
        } elseif (property_exists($model, 'table')) {
            // NOTE: To be removed in v1.0.0
            $newTable = $model->table;
        }

        return [ $model, strtolower($newTable) ];
    }

    /**
     * Parses the table name from Describe class.
     *
     * @param  string  $table
     * @param  boolean $isForeignKey
     * @return string
     */
    abstract protected function getTableName($table, $isForeignKey = false);
}