RecordWrapper - Code Metrics - Inspection of "Properly exposing the getDriver through a single s..." - ntentan/nibii - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ced319...978c91 )

by James Ekow Abaka

created 2015-12-15 16:57 UTC

RecordWrapper C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	323
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	7

Test Coverage

Coverage

82.28%

Importance

Changes	48
Bugs	6	Features	10

Metric	Value
wmc	57
c	48
b	6
f	10
lcom	3
cbo	7
dl	0
loc	323
ccs	130
cts	158
cp	0.8228
rs	6.4331

39 Methods

Rating	Name	Size	Complexity
A	__construct()	13	2
A	getDataAdapter()	8	2
A	getDescription()	10	1
A	count()	8	2
A	retrieveItem()	9	3
A	createNew()	5	1
A	__call()	8	1
A	__callStatic()	4	1
A	__set()	5	1
A	__get()	4	1
A	getTable()	4	1
A	expandArrayValue()	7	2
A	toArray()	15	4
A	save()	6	1
A	hasMultipleData()	8	2
A	getData()	14	4
A	setData()	5	1
A	mergeData()	7	2
A	offsetExists()	4	1
A	offsetGet()	8	2
A	offsetSet()	5	1
A	offsetUnset()	4	1
A	wrap()	10	2
A	getInvalidFields()	4	1
A	getHasMany()	4	1
A	getBelongsTo()	4	1
A	current()	4	1
A	key()	4	1
A	next()	4	1
A	rewind()	4	1
A	valid()	4	1
A	fetchRelatedFields()	14	3
A	getRelationships()	8	1
A	usetField()	4	1
A	preSaveCallback()	4	1
A	postSaveCallback()	4	1
A	preUpdateCallback()	4	1
A	postUpdateCallback()	4	1
A	getBehaviours()	4	1

How to fix Complexity

<?php
/*
 * The MIT License
 *
 * Copyright 2015 ekow.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace ntentan\nibii;

use ntentan\utils\Utils;
use ntentan\kaikai\Cache;

class RecordWrapper implements \ArrayAccess, \Countable, \Iterator
{
    use \ntentan\utils\DependencyInjector;
    
    protected $hasMany = [];
    protected $belongsTo = [];
    protected $manyHaveMany = [];
    protected $behaviours = [];

    protected $table;
    private $modelData = [];
    private $invalidFields;
    private $dynamicOperations;
    private $index = 0;
    private $dataSet = false;
    private $adapter;

    public function __construct()
    {
        Utils::factory(
            $this->table,
            function() {
                return Nibii::getModelTable($this);
            }
        );
        foreach($this->behaviours as $behaviour) {
            $behaviourInstance = $this->loadDependency($behaviour);
            $behaviourInstance->setModel($this);
        }
    }

    /**
     *
     * @return \ntentan\nibii\DriverAdapter
     */
    protected function getDataAdapter()
    {
        if(!$this->adapter)
        {
            $this->adapter = DriverAdapter::getDefaultInstance();
        }
        return $this->adapter;
    }

    /**
     * 
     * @return ModelDescription
     */
    public function getDescription()
    {
        return Cache::read(
            (new \ReflectionClass($this))->getName() . '::desc',
            function() 
            {
                return new ModelDescription($this);
            }
        );
    }
    
    public function count()
    {
        if ($this->dataSet) {
            return count($this->getData());
        } else {
            return $this->__call('count', []);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

    private function retrieveItem($key)

    {
        $relationships = $this->getDescription()->getRelationships();
        if(isset($relationships[$key])) {
            return $this->fetchRelatedFields($relationships[$key]);
        } else {
            return isset($this->modelData[$key]) ? $this->modelData[$key] : null;
        }
    }

    /**
     * Create a new instance of this Model
     * @return \ntentan\nibii\RecordWrapper
     */
    public static function createNew()
    {
        $class = get_called_class();
        return new $class();
    }

    /**
     * @method
     * @param type $name
     * @param type $arguments
     * @return type
     */
    public function __call($name, $arguments)
    {
        return Utils::factory($this->dynamicOperations,
            function() {
                return new Operations($this, $this->getDataAdapter());
            }
        )->perform($name, $arguments);
    }

    public static function __callStatic($name, $arguments)
    {
        return call_user_func_array([self::createNew(), $name], $arguments);
    }

    public function __set($name, $value)
    {
        $this->dataSet = true;
        $this->modelData[$name] = $value;
    }

    public function __get($name)

    {
        return $this->retrieveItem($name);
    }

    public function getTable()

    {
        return $this->table;
    }
    
    private function expandArrayValue($array, $relationships, $depth, $index = null)

    {
        foreach($relationships as $name => $relationship) {
            $array[$name] = $this->fetchRelatedFields($relationship, $index)->toArray($depth);
        }
        return $array;
    }

    public function toArray($depth = 0)

    {
        $relationships = $this->getDescription()->getRelationships();
        $array = $this->modelData;
        if($depth > 0) {
            if($this->hasMultipleData()) {
                foreach($array as $i => $value) {
                    $array[$i] = $this->expandArrayValue($value, $relationships, $depth - 1, $i);
                }
            } else {
                $array = $this->expandArrayValue($array, $relationships, $depth - 1);
            }
        }
        return $array;
    }
    
    public function save()
    {
        $return = $this->__call('save', [$this->hasMultipleData()]);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->invalidFields = $this->dynamicOperations->getInvalidFields();
        return $return;
    }

    private function hasMultipleData()
    {
        if(count($this->modelData) > 0) {
            return is_numeric(array_keys($this->modelData)[0]);
        } else {
            return false;
        }
    }

    public function getData()
    {
        $data = [];
                
        if(count($this->modelData) == 0) {
            $data = $this->modelData;
        } else if($this->hasMultipleData()) {
            $data = $this->modelData;
        } else if(count($this->modelData) > 0) {
            $data[] = $this->modelData;
        }
        
        return $data;
    }

    public function setData($data)
    {
        $this->dataSet = true;
        $this->modelData = $data;
    }
    
    public function mergeData($data)
    {
        foreach($data as $key => $value) {
            $this->modelData[$key] = $value;
        }
        $this->dataSet = true;
    }

    public function offsetExists($offset)
    {
        return isset($this->modelData[$offset]);
    }

    public function offsetGet($offset)
    {
        if (is_numeric($offset)) {
            return $this->wrap($offset);
        } else {
            return $this->retrieveItem($offset);
        }
    }

    public function offsetSet($offset, $value)
    {
        $this->dataSet = true;
        $this->modelData[$offset] = $value;
    }

    public function offsetUnset($offset)
    {
        unset($this->modelData[$offset]);
    }

    private function wrap($offset)
    {
        if(isset($this->modelData[$offset])) {
            $newInstance = $this->createNew();
            $newInstance->setData($this->modelData[$offset]);
            return $newInstance;
        } else {
            return null;
        }
    }

    public function getInvalidFields()

    {
        return $this->invalidFields;
    }

    public function getHasMany()
    {
        return $this->hasMany;
    }

    public function getBelongsTo()
    {
        return $this->belongsTo;
    }

    public function current()
    {
        return $this->wrap($this->index);
    }

    public function key()
    {
        return $this->index;
    }

    public function next()
    {
        $this->index++;
    }

    public function rewind()
    {
        $this->index = 0;
    }

    public function valid()
    {
        return isset($this->modelData[$this->index]);
    }

    private function fetchRelatedFields($relationship, $index = null)

    {
        if($index === null) {
            $data = $this->modelData;
        } else {
            $data = $this->modelData[$index];
        }
        $model = $relationship->getModelInstance();
        if(empty($data)) {
            return $model;
        } else {
            return $model->fetch($relationship->getQuery($data));
        }
    }

    public function getRelationships()
    {
        return [
            'HasMany' => $this->hasMany,
            'BelongsTo' => $this->belongsTo,
            'ManyHaveMany' => $this->manyHaveMany
        ];
    }
    
    public function usetField($field)
    {
        unset($this->modelData[$field]);
    }
    
    public function preSaveCallback()
    {
        
    }
    
    public function postSaveCallback($id)

    {
        
    }
    
    public function preUpdateCallback()
    {
        
    }
    
    public function postUpdateCallback()
    {
        
    }
    
    public function getBehaviours()
    {
        return $this->loadedDependencies;
    }
}


1		<?php
2		/*
3		* The MIT License
4		*
5		* Copyright 2015 ekow.
6		*
7		* Permission is hereby granted, free of charge, to any person obtaining a copy
8		* of this software and associated documentation files (the "Software"), to deal
9		* in the Software without restriction, including without limitation the rights
10		* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11		* copies of the Software, and to permit persons to whom the Software is
12		* furnished to do so, subject to the following conditions:
13		*
14		* The above copyright notice and this permission notice shall be included in
15		* all copies or substantial portions of the Software.
16		*
17		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19		* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20		* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21		* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22		* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23		* THE SOFTWARE.
24		*/
25
26		namespace ntentan\nibii;
27
28		use ntentan\utils\Utils;
29		use ntentan\kaikai\Cache;
30
31		class RecordWrapper implements \ArrayAccess, \Countable, \Iterator
32		{
33		use \ntentan\utils\DependencyInjector;
34
35		protected $hasMany = [];
36		protected $belongsTo = [];
37		protected $manyHaveMany = [];
38		protected $behaviours = [];
39
40		protected $table;
41		private $modelData = [];
42		private $invalidFields;
43		private $dynamicOperations;
44		private $index = 0;
45		private $dataSet = false;
46		private $adapter;
47
48	36	public function __construct()
49		{
50	36	Utils::factory(
51	36	$this->table,
52		function() {
53	36	return Nibii::getModelTable($this);
54		}
55	36	);
56	36	foreach($this->behaviours as $behaviour) {
57		$behaviourInstance = $this->loadDependency($behaviour);
58		$behaviourInstance->setModel($this);
59	36	}
60	36	}
61
62		/**
63		*
64		* @return \ntentan\nibii\DriverAdapter
65		*/
66	34	protected function getDataAdapter()
67		{
68	34	if(!$this->adapter)
69	34	{
70	34	$this->adapter = DriverAdapter::getDefaultInstance();
71	34	}
72	34	return $this->adapter;
73		}
74
75		/**
76		*
77		* @return ModelDescription
78		*/
79	28	public function getDescription()
80		{
81	28	return Cache::read(
82	28	(new \ReflectionClass($this))->getName() . '::desc',
83		function()
84		{
85	8	return new ModelDescription($this);
86		}
87	28	);
88		}
89
90	10	public function count()
91		{
92	10	if ($this->dataSet) {
93	10	return count($this->getData());
94		} else {
95		return $this->__call('count', []);
		0 ignored issues – show Documentation introduced 2015-11-24 20:03 UTC by Report Bug Copy Issue Report `'count'` is of type `string`, but the function expects a `object<ntentan\nibii\type>`. 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... Documentation introduced 2015-11-24 20:03 UTC by Report Bug Copy Issue Report `array()` is of type `array`, but the function expects a `object<ntentan\nibii\type>`. 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...
96		}
97		}
98
99	12	private function retrieveItem($key)
		0 ignored issues – show Documentation introduced 2015-11-24 20:03 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
100		{
101	12	$relationships = $this->getDescription()->getRelationships();
102	12	if(isset($relationships[$key])) {
103	8	return $this->fetchRelatedFields($relationships[$key]);
104		} else {
105	4	return isset($this->modelData[$key]) ? $this->modelData[$key] : null;
106		}
107		}
108
109		/**
110		* Create a new instance of this Model
111		* @return \ntentan\nibii\RecordWrapper
112		*/
113	34	public static function createNew()
114		{
115	34	$class = get_called_class();
116	34	return new $class();
117		}
118
119		/**
120		* @method
121		* @param type $name
122		* @param type $arguments
123		* @return type
124		*/
125	34	public function __call($name, $arguments)
126		{
127	34	return Utils::factory($this->dynamicOperations,
128	34	function() {
129	34	return new Operations($this, $this->getDataAdapter());
130		}
131	34	)->perform($name, $arguments);
132		}
133
134	26	public static function __callStatic($name, $arguments)
135		{
136	26	return call_user_func_array([self::createNew(), $name], $arguments);
137		}
138
139	8	public function __set($name, $value)
140		{
141	8	$this->dataSet = true;
142	8	$this->modelData[$name] = $value;
143	8	}
144
145	12	public function __get($name)
		0 ignored issues – show Documentation introduced 2015-11-24 20:03 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
146		{
147	12	return $this->retrieveItem($name);
148		}
149
150	32	public function getTable()
		0 ignored issues – show Documentation introduced 2015-11-24 20:03 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
151		{
152	32	return $this->table;
153	2	}
154
155	4	private function expandArrayValue($array, $relationships, $depth, $index = null)
		0 ignored issues – show Documentation introduced 2015-11-24 20:03 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
156		{
157	4	foreach($relationships as $name => $relationship) {
158	4	$array[$name] = $this->fetchRelatedFields($relationship, $index)->toArray($depth);
159	4	}
160	4	return $array;
161		}
162
163	16	public function toArray($depth = 0)
		0 ignored issues – show Documentation introduced 2015-11-24 20:03 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
164		{
165	16	$relationships = $this->getDescription()->getRelationships();
166	16	$array = $this->modelData;
167	16	if($depth > 0) {
168	4	if($this->hasMultipleData()) {
169		foreach($array as $i => $value) {
170		$array[$i] = $this->expandArrayValue($value, $relationships, $depth - 1, $i);
171		}
172		} else {
173	4	$array = $this->expandArrayValue($array, $relationships, $depth - 1);
174		}
175	4	}
176	16	return $array;
177		}
178
179	10	public function save()
180		{
181	10	$return = $this->__call('save', [$this->hasMultipleData()]);
		0 ignored issues – show Documentation introduced 2015-11-24 20:03 UTC by Report Bug Copy Issue Report `'save'` is of type `string`, but the function expects a `object<ntentan\nibii\type>`. 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... Documentation introduced 2015-11-24 20:03 UTC by Report Bug Copy Issue Report `array($this->hasMultipleData())` is of type `array<integer,boolean,{"0":"boolean"}>`, but the function expects a `object<ntentan\nibii\type>`. 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...
182	10	$this->invalidFields = $this->dynamicOperations->getInvalidFields();
183	10	return $return;
184		}
185
186	18	private function hasMultipleData()
187		{
188	18	if(count($this->modelData) > 0) {
189	16	return is_numeric(array_keys($this->modelData)[0]);
190		} else {
191	2	return false;
192		}
193		}
194
195	14	public function getData()
196		{
197	14	$data = [];
198
199	14	if(count($this->modelData) == 0) {
200	6	$data = $this->modelData;
201	14	} else if($this->hasMultipleData()) {
202	2	$data = $this->modelData;
203	12	} else if(count($this->modelData) > 0) {
204	12	$data[] = $this->modelData;
205	12	}
206
207	14	return $data;
208		}
209
210	26	public function setData($data)
211		{
212	26	$this->dataSet = true;
213	26	$this->modelData = $data;
214	26	}
215
216		public function mergeData($data)
217		{
218		foreach($data as $key => $value) {
219		$this->modelData[$key] = $value;
220		}
221		$this->dataSet = true;
222		}
223
224	2	public function offsetExists($offset)
225		{
226	2	return isset($this->modelData[$offset]);
227		}
228
229	2	public function offsetGet($offset)
230		{
231	2	if (is_numeric($offset)) {
232	2	return $this->wrap($offset);
233		} else {
234	2	return $this->retrieveItem($offset);
235		}
236		}
237
238	2	public function offsetSet($offset, $value)
239		{
240	2	$this->dataSet = true;
241	2	$this->modelData[$offset] = $value;
242	2	}
243
244		public function offsetUnset($offset)
245		{
246		unset($this->modelData[$offset]);
247		}
248
249	6	private function wrap($offset)
250		{
251	6	if(isset($this->modelData[$offset])) {
252	6	$newInstance = $this->createNew();
253	6	$newInstance->setData($this->modelData[$offset]);
254	6	return $newInstance;
255		} else {
256		return null;
257		}
258		}
259
260	4	public function getInvalidFields()
		0 ignored issues – show Documentation introduced 2015-11-24 20:03 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
261		{
262	4	return $this->invalidFields;
263		}
264
265		public function getHasMany()
266		{
267		return $this->hasMany;
268		}
269
270		public function getBelongsTo()
271		{
272		return $this->belongsTo;
273		}
274
275	4	public function current()
276		{
277	4	return $this->wrap($this->index);
278		}
279
280		public function key()
281		{
282		return $this->index;
283		}
284
285	4	public function next()
286		{
287	4	$this->index++;
288	4	}
289
290	4	public function rewind()
291		{
292	4	$this->index = 0;
293	4	}
294
295	4	public function valid()
296		{
297	4	return isset($this->modelData[$this->index]);
298		}
299
300	12	private function fetchRelatedFields($relationship, $index = null)
		0 ignored issues – show Documentation introduced 2015-11-24 20:03 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
301		{
302	12	if($index === null) {
303	12	$data = $this->modelData;
304	12	} else {
305		$data = $this->modelData[$index];
306		}
307	12	$model = $relationship->getModelInstance();
308	12	if(empty($data)) {
309		return $model;
310		} else {
311	12	return $model->fetch($relationship->getQuery($data));
312		}
313		}
314
315	8	public function getRelationships()
316		{
317		return [
318	8	'HasMany' => $this->hasMany,
319	8	'BelongsTo' => $this->belongsTo,
320	8	'ManyHaveMany' => $this->manyHaveMany
321	8	];
322		}
323
324		public function usetField($field)
325		{
326		unset($this->modelData[$field]);
327		}
328
329	8	public function preSaveCallback()
330		{
331
332	8	}
333
334	4	public function postSaveCallback($id)
		0 ignored issues – show Unused Code introduced 2015-11-24 20:03 UTC by Report Bug Copy Issue Report The parameter `$id` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
335		{
336
337	4	}
338
339	2	public function preUpdateCallback()
340		{
341
342	2	}
343
344	2	public function postUpdateCallback()
345		{
346
347	2	}
348
349	10	public function getBehaviours()
350		{
351	10	return $this->loadedDependencies;
352		}
353		}
354

ntentan / nibii

Push — master ( ced319...978c91 )

RecordWrapper C

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

39 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like