Kohana_Jam_Association_Collection::clear() - Code Metrics - Inspection of "Fixed hasmany association behaviour" - OpenBuildings/jam - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — association-fixes ( e74f25 )

by Danail

created 2016-05-20 11:25 UTC

Kohana_Jam_Association_Collection::clear() A

↳ Parent: Kohana_Jam_Association_Collection

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	3

Metric	Value
dl	0
loc	11
ccs	9
cts	9
cp	1
rs	9.4285
cc	3
eloc	5
nc	3
nop	2
crap	3

<?php defined('SYSPATH') OR die('No direct script access.');
/**
 * Common association for has-many and many-to-many relationships
 *
 * @package    Jam
 * @category   Associations
 * @author     Ivan Kerin
 * @copyright  (c) 2012 Despark Ltd.
 * @license    http://www.opensource.org/licenses/isc-license.txt
 */
abstract class Kohana_Jam_Association_Collection extends Jam_Association {

	/**
	 * Find the join table based on the two model names pluralized,
	 * sorted alphabetically and with an underscore separating them
	 *
	 * @param  string $model1
	 * @param  string $model2
	 * @return string
	 */
	static public function guess_through_table($model1, $model2)
	{
		$through = array(
			Inflector::plural($model1),
			Inflector::plural($model2)
		);

		sort($through);
		return implode('_', $through);
	}

	/**
	 * Assign default forein_model to singular association name
	 * @param  Jam_Meta $meta
	 * @param  string   $name
	 */
	public function initialize(Jam_Meta $meta, $name)
	{
		if ( ! $this->foreign_model)
		{
			$this->foreign_model = Inflector::singular($name);
		}

		parent::initialize($meta, $name);
	}

	/**
	 * Load associated models (from database or after deserialization)
	 * @param  Jam_Validated $model
	 * @param  mixed         $value
	 * @return Jam_Array_Association
	 */
	public function load_fields(Jam_Validated $model, $value)
	{
		if ($value instanceof Jam_Array_Association)
		{
			$collection = $value;
		}
		else
		{
			$collection = new Jam_Array_Association();
			$collection
				->load_fields($value);
		}

		return $this->assign_internals($model, $collection);
	}

	public function assign_internals(Jam_Validated $model, Jam_Array_Association $collection)
	{
		return $collection
			->model($this->foreign_model)
			->parent($model)
			->association($this);
	}

	public function get(Jam_Validated $model, $value, $is_changed)
	{
		$array = new Jam_Array_Association();
		$array
			->model($this->foreign_model)
			->association($this)
			->parent($model);

		if ($is_changed)
		{
			$array->set($value);
		}

		return $array;
	}

	/**
	 * Perform checks on all changed items from this collection
	 * @param  Jam_Model $model
	 */
	public function model_after_check(Jam_Model $model)
	{
		if ($model->changed($this->name) AND ! $model->{$this->name}->check_changed())
		{
			$model->errors()->add($this->name, 'association_collection');

		}
	}

	/**
	 * Persist this collection in the database
	 * @param  Jam_Model $model
	 */
	public function model_after_save(Jam_Model $model)
	{
		if ($model->changed($this->name) AND $collection = $model->{$this->name} AND $collection->changed())
		{
			$collection->save_changed();

			$this->save($model, $collection);
		}
	}

	/**
	 * Use this method to perform special actions when an item is requested from the collection
	 * @param  Jam_Model $model
	 * @param  Jam_Model $item
	 */
	public function item_get(Jam_Model $model, Jam_Model $item)
	{
		// Extend
	}

	/**
	 * Use this method to perform special actions when an item is set to the collection
	 * @param  Jam_Model $model
	 * @param  Jam_Model $item
	 */
	public function item_set(Jam_Model $model, Jam_Model $item)
	{
		// Extend
	}

	/**
	 * Use this method to perform special actions when an item is removed from the collection
	 * @param  Jam_Model $model
	 * @param  Jam_Model $item
	 */
	public function item_unset(Jam_Model $model, Jam_Model $item)

	{
		// Extend
	}

	/**
	 * A database query used to remove items from the model
	 * @param  array     $ids
	 * @param  Jam_Model $model
	 * @return Database_Query
	 */
	abstract public function remove_items_query(Jam_Model $model, array $ids);

	/**
	 * A database query used to add items to the model
	 * @param  array     $ids
	 * @param  Jam_Model $model
	 * @return Database_Query
	 */
	abstract public function add_items_query(Jam_Model $model, array $ids);

	/**
	 * Get the colleciton to get the models of the association
	 * @param  Jam_Model $model
	 * @return Jam_Query_Builder_Collection
	 */
	abstract public function collection(Jam_Model $model);

	/**
	 * Execute remove_items_query and add_items_query to persist the colleciton to the datbaase
	 * @param  Jam_Model                    $model
	 * @param  Jam_Array_Association $collection
	 */
	public function save(Jam_Model $model, Jam_Array_Association $collection)
	{
		if ($old_ids = array_values(array_diff($collection->original_ids(), $collection->ids())))
		{
			$query = $this->remove_items_query($model, $old_ids);
			if ($query)
			{
				$query->execute(Jam::meta($this->model)->db());
			}
		}

		if ($new_ids = array_values(array_diff($collection->ids(), $collection->original_ids())))
		{
			$query = $this->add_items_query($model, $new_ids);
			if ($query)
			{
				$query->execute(Jam::meta($this->model)->db());
			}
		}
	}

	/**
	 * Use the remove query to remove all items from the collection
	 * @param  Jam_Validated                $model
	 * @param  Jam_Array_Association $collection
	 */
	public function clear(Jam_Validated $model, Jam_Array_Association $collection)
	{
		if ($ids = array_filter($collection->ids()))
		{
			$query = $this->remove_items_query($model, $ids);

			if ($query)
			{
				$query->execute(Jam::meta($this->model)->db());
			}
		}
	}

}


1		<?php defined('SYSPATH') OR die('No direct script access.');
2		/**
3		* Common association for has-many and many-to-many relationships
4		*
5		* @package Jam
6		* @category Associations
7		* @author Ivan Kerin
8		* @copyright (c) 2012 Despark Ltd.
9		* @license http://www.opensource.org/licenses/isc-license.txt
10		*/
11		abstract class Kohana_Jam_Association_Collection extends Jam_Association {
12
13		/**
14		* Find the join table based on the two model names pluralized,
15		* sorted alphabetically and with an underscore separating them
16		*
17		* @param string $model1
18		* @param string $model2
19		* @return string
20		*/
21	30	static public function guess_through_table($model1, $model2)
22		{
23		$through = array(
24	30	Inflector::plural($model1),
25	30	Inflector::plural($model2)
26	30	);
27
28	30	sort($through);
29	30	return implode('_', $through);
30		}
31
32		/**
33		* Assign default forein_model to singular association name
34		* @param Jam_Meta $meta
35		* @param string $name
36		*/
37	80	public function initialize(Jam_Meta $meta, $name)
38		{
39	80	if ( ! $this->foreign_model)
40	80	{
41	67	$this->foreign_model = Inflector::singular($name);
42	67	}
43
44	80	parent::initialize($meta, $name);
45	80	}
46
47		/**
48		* Load associated models (from database or after deserialization)
49		* @param Jam_Validated $model
50		* @param mixed $value
51		* @return Jam_Array_Association
52		*/
53	7	public function load_fields(Jam_Validated $model, $value)
54		{
55	7	if ($value instanceof Jam_Array_Association)
56	7	{
57		$collection = $value;
58		}
59		else
60		{
61	7	$collection = new Jam_Array_Association();
62		$collection
63	7	->load_fields($value);
64		}
65
66	7	return $this->assign_internals($model, $collection);
67		}
68
69	643	public function assign_internals(Jam_Validated $model, Jam_Array_Association $collection)
70		{
71		return $collection
72	643	->model($this->foreign_model)
73	643	->parent($model)
74	643	->association($this);
75		}
76
77	22	public function get(Jam_Validated $model, $value, $is_changed)
78		{
79	22	$array = new Jam_Array_Association();
80		$array
81	22	->model($this->foreign_model)
82	22	->association($this)
83	22	->parent($model);
84
85		if ($is_changed)
86	22	{
87	8	$array->set($value);
88	8	}
89
90	22	return $array;
91		}
92
93		/**
94		* Perform checks on all changed items from this collection
95		* @param Jam_Model $model
96		*/
97	8	public function model_after_check(Jam_Model $model)
98		{
99	8	if ($model->changed($this->name) AND ! $model->{$this->name}->check_changed())
100	8	{
101		$model->errors()->add($this->name, 'association_collection');
		0 ignored issues – show Bug introduced 2015-11-24 23:50 UTC by Report Bug Copy Issue Report The method `add` cannot be called on `$model->errors()` (of type `array\|null`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
102		}
103	8	}
104
105		/**
106		* Persist this collection in the database
107		* @param Jam_Model $model
108		*/
109	8	public function model_after_save(Jam_Model $model)
110		{
111	8	if ($model->changed($this->name) AND $collection = $model->{$this->name} AND $collection->changed())
112	8	{
113	1	$collection->save_changed();
114
115	1	$this->save($model, $collection);
116	1	}
117	8	}
118
119		/**
120		* Use this method to perform special actions when an item is requested from the collection
121		* @param Jam_Model $model
122		* @param Jam_Model $item
123		*/
124	1	public function item_get(Jam_Model $model, Jam_Model $item)
125		{
126		// Extend
127	1	}
128
129		/**
130		* Use this method to perform special actions when an item is set to the collection
131		* @param Jam_Model $model
132		* @param Jam_Model $item
133		*/
134		public function item_set(Jam_Model $model, Jam_Model $item)
135		{
136		// Extend
137		}
138
139		/**
140		* Use this method to perform special actions when an item is removed from the collection
141		* @param Jam_Model $model
142		* @param Jam_Model $item
143		*/
144		public function item_unset(Jam_Model $model, Jam_Model $item)
		0 ignored issues – show Unused Code introduced 2015-11-24 23:50 UTC by Report Bug Copy Issue Report The parameter `$model` 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...
145		{
146		// Extend
147		}
148
149		/**
150		* A database query used to remove items from the model
151		* @param array $ids
152		* @param Jam_Model $model
153		* @return Database_Query
154		*/
155		abstract public function remove_items_query(Jam_Model $model, array $ids);
156
157		/**
158		* A database query used to add items to the model
159		* @param array $ids
160		* @param Jam_Model $model
161		* @return Database_Query
162		*/
163		abstract public function add_items_query(Jam_Model $model, array $ids);
164
165		/**
166		* Get the colleciton to get the models of the association
167		* @param Jam_Model $model
168		* @return Jam_Query_Builder_Collection
169		*/
170		abstract public function collection(Jam_Model $model);
171
172		/**
173		* Execute remove_items_query and add_items_query to persist the colleciton to the datbaase
174		* @param Jam_Model $model
175		* @param Jam_Array_Association $collection
176		*/
177	2	public function save(Jam_Model $model, Jam_Array_Association $collection)
178		{
179	2	if ($old_ids = array_values(array_diff($collection->original_ids(), $collection->ids())))
180	2	{
181	1	$query = $this->remove_items_query($model, $old_ids);
182		if ($query)
183	1	{
184	1	$query->execute(Jam::meta($this->model)->db());
185	1	}
186	1	}
187
188	2	if ($new_ids = array_values(array_diff($collection->ids(), $collection->original_ids())))
189	2	{
190	2	$query = $this->add_items_query($model, $new_ids);
191		if ($query)
192	2	{
193	2	$query->execute(Jam::meta($this->model)->db());
194	2	}
195	2	}
196	2	}
197
198		/**
199		* Use the remove query to remove all items from the collection
200		* @param Jam_Validated $model
201		* @param Jam_Array_Association $collection
202		*/
203	1	public function clear(Jam_Validated $model, Jam_Array_Association $collection)
204		{
205	1	if ($ids = array_filter($collection->ids()))
206	1	{
207	1	$query = $this->remove_items_query($model, $ids);
		0 ignored issues – show Compatibility introduced 2015-11-24 23:50 UTC by Report Bug Copy Issue Report `$model` of type `object<Jam_Validated>` is not a sub-type of `object<Jam_Model>`. It seems like you assume a child class of the class `Jam_Validated` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
208		if ($query)
209	1	{
210	1	$query->execute(Jam::meta($this->model)->db());
211	1	}
212	1	}
213	1	}
214
215		}
216

OpenBuildings / jam

Push — association-fixes ( e74f25 )

Kohana_Jam_Association_Collection::clear() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like