ObjectTrait::createObject() - Code Metrics - Inspection of "Deprecate long method names" - rougin/wildfire - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ed61e9...497a60 )

by Rougin

created 2018-04-27 08:27 UTC

ObjectTrait::createObject() A

↳ Parent: ObjectTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	2
crap	1

<?php

namespace Rougin\Wildfire\Traits;

use Rougin\Describe\Column;

use Rougin\Wildfire\CodeigniterModel;
use Rougin\Wildfire\Helpers\ModelHelper;
use Rougin\Wildfire\Helpers\TableHelper;

/**
 * Object Trait
 *
 * @package Wildfire
 * @author  Rougin Royce Gutib <[email protected]>
 *
 * @property \Rougin\Describe\Describe $describe
 * @property string                    $table
 */
trait ObjectTrait
{
    /**
     * Creates an object from the specified table and row.
     * NOTE: To be removed in v1.0.0. Use $this->make instead.
     *
     * @param  string|\Rougin\Wildfire\CodeigniterModel $table
     * @param  object                                   $row
     * @return array
     */
    protected function createObject($table, $row)
    {
        return $this->make($table, $row);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Creates an object from the specified table and row.
     *
     * @param  \Rougin\Wildfire\CodeigniterModel\string $table
     * @param  object                                   $row
     * @return array
     */
    protected function make($table, $row)
    {
        list($table, $model) = ModelHelper::make($table);

        $properties = array('belongs_to' => array());

        $properties['hidden'] = array();

        $properties['columns'] = array();

        if ($model instanceof CodeigniterModel === true) {
            $properties = $model->properties();

            $properties = $model->relationships($properties);
        }

        $columns = $this->describe->columns($table);

        $this->setModelFields($model, $row, $properties, $columns);

        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
     * @return object|boolean
     */
    abstract protected function find($table, $delimiters = []);

    /**
     * Checks if the field is not a column or intended to be hidden.
     *
     * @param  string  $key
     * @param  array   $properties
     * @return boolean
     */
    protected function notColumnOrIsHidden($key, array $properties)
    {
        $isColumn = in_array($key, $properties['columns']);
        $isHidden = in_array($key, $properties['hidden']);

        return (! empty($properties['columns']) && ! $isColumn) || $isHidden;
    }

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

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

        if (in_array($foreignTable, $properties['belongs_to'])) {
            $delimiters = [ $foreignColumn => $model->$columnName ];
            $foreign    = $this->find($foreignTable, $delimiters);

            if (is_object($foreign)) {
                $tableName  = TableHelper::getNameFromModel($foreign);

                $model->$tableName = $foreign;
            }
        }
    }

    /**
     * Sets the model values based on the result row.
     *
     * @param  \CI_Model &$model
     * @param  object    $row
     * @param  array     $properties
     * @param  array     $tableInformation
     * @return void
     */
    protected function setModelFields(&$model, $row, array $properties, $tableInformation)
    {
        foreach ($tableInformation as $column) {
            $key = $column->getField();

            if ($this->notColumnOrIsHidden($key, $properties)) {
                continue;
            }

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

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


1		<?php
2
3		namespace Rougin\Wildfire\Traits;
4
5		use Rougin\Describe\Column;
6
7		use Rougin\Wildfire\CodeigniterModel;
8		use Rougin\Wildfire\Helpers\ModelHelper;
9		use Rougin\Wildfire\Helpers\TableHelper;
10
11		/**
12		* Object Trait
13		*
14		* @package Wildfire
15		* @author Rougin Royce Gutib <[email protected]>
16		*
17		* @property \Rougin\Describe\Describe $describe
18		* @property string $table
19		*/
20		trait ObjectTrait
21		{
22		/**
23		* Creates an object from the specified table and row.
24		* NOTE: To be removed in v1.0.0. Use $this->make instead.
25		*
26		* @param string\|\Rougin\Wildfire\CodeigniterModel $table
27		* @param object $row
28		* @return array
29		*/
30	36	protected function createObject($table, $row)
31		{
32	36	return $this->make($table, $row);
		0 ignored issues – show Documentation introduced 2018-04-27 08:32 UTC by Report Bug Copy Issue Report `$table` is of type `string\|object<Rougin\Wildfire\CodeigniterModel>`, but the function expects a `object<Rougin\Wildfire\CodeigniterModel\string>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
33		}
34
35		/**
36		* Creates an object from the specified table and row.
37		*
38		* @param \Rougin\Wildfire\CodeigniterModel\string $table
39		* @param object $row
40		* @return array
41		*/
42	36	protected function make($table, $row)
43		{
44	36	list($table, $model) = ModelHelper::make($table);
45
46	36	$properties = array('belongs_to' => array());
47
48	36	$properties['hidden'] = array();
49
50	36	$properties['columns'] = array();
51
52	36	if ($model instanceof CodeigniterModel === true) {
53	36	$properties = $model->properties();
54
55	36	$properties = $model->relationships($properties);
56	36	}
57
58	36	$columns = $this->describe->columns($table);
59
60	36	$this->setModelFields($model, $row, $properties, $columns);
61
62	36	return $model;
63		}
64
65		/**
66		* Finds the row from the specified ID or with the list of delimiters from
67		* the specified table.
68		*
69		* @param string $table
70		* @param array\|integer $delimiters
71		* @return object\|boolean
72		*/
73		abstract protected function find($table, $delimiters = []);
74
75		/**
76		* Checks if the field is not a column or intended to be hidden.
77		*
78		* @param string $key
79		* @param array $properties
80		* @return boolean
81		*/
82	36	protected function notColumnOrIsHidden($key, array $properties)
83		{
84	36	$isColumn = in_array($key, $properties['columns']);
85	36	$isHidden = in_array($key, $properties['hidden']);
86
87	36	return (! empty($properties['columns']) && ! $isColumn) \|\| $isHidden;
88		}
89
90		/**
91		* Sets the foreign field of the column, if any.
92		*
93		* @param \CI_Model $model
94		* @param \Rougin\Describe\Column $column
95		* @param array $properties
96		* @return void
97		*/
98	36	protected function setForeignField(\CI_Model $model, Column $column, array $properties)
99		{
100	36	$columnName = $column->getField();
101
102	36	$foreignColumn = $column->getReferencedField();
103	36	$foreignTable = $column->getReferencedTable();
104
105	36	if (in_array($foreignTable, $properties['belongs_to'])) {
106	6	$delimiters = [ $foreignColumn => $model->$columnName ];
107	6	$foreign = $this->find($foreignTable, $delimiters);
108
109	6	if (is_object($foreign)) {
110	6	$tableName = TableHelper::getNameFromModel($foreign);
111
112	6	$model->$tableName = $foreign;
113	6	}
114	6	}
115	36	}
116
117		/**
118		* Sets the model values based on the result row.
119		*
120		* @param \CI_Model &$model
121		* @param object $row
122		* @param array $properties
123		* @param array $tableInformation
124		* @return void
125		*/
126	36	protected function setModelFields(&$model, $row, array $properties, $tableInformation)
127		{
128	36	foreach ($tableInformation as $column) {
129	36	$key = $column->getField();
130
131	36	if ($this->notColumnOrIsHidden($key, $properties)) {
132	36	continue;
133		}
134
135	36	$model->$key = $row->$key;
136
137	36	$this->setForeignField($model, $column, $properties);
138	36	}
139	36	}
140		}
141

rougin / wildfire

Push — master ( ed61e9...497a60 )

ObjectTrait::createObject() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like