Complex classes like Kohana_Jam_Model often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Kohana_Jam_Model, and based on these observations, apply Extract Interface, too.
1 | <?php defined('SYSPATH') OR die('No direct script access.'); |
||
14 | abstract class Kohana_Jam_Model extends Jam_Validated { |
||
15 | |||
16 | /** |
||
17 | * @var boolean Whether or not the model is loaded |
||
18 | */ |
||
19 | protected $_loaded = FALSE; |
||
20 | |||
21 | /** |
||
22 | * @var boolean Whether or not the model is saved |
||
23 | */ |
||
24 | protected $_saved = FALSE; |
||
25 | |||
26 | /** |
||
27 | * @var boolean Whether or not the model is saving |
||
28 | */ |
||
29 | protected $_is_saving = FALSE; |
||
30 | |||
31 | /** |
||
32 | * @var Boolean A flag that indicates a record has been deleted from the database |
||
33 | */ |
||
34 | protected $_deleted = FALSE; |
||
35 | |||
36 | /** |
||
37 | * Constructor. |
||
38 | * |
||
39 | * A key can be passed to automatically load a model by its |
||
40 | * unique key. |
||
41 | * |
||
42 | * @param mixed|null $key |
||
|
|||
43 | */ |
||
44 | 441 | public function __construct($meta_name = NULL) |
|
55 | |||
56 | /** |
||
57 | * Gets the value for a field. |
||
58 | * |
||
59 | * @param string $name The field's name |
||
60 | * @return array|mixed |
||
61 | */ |
||
62 | 216 | public function get($name) |
|
73 | |||
74 | public function __isset($name) |
||
78 | |||
79 | /** |
||
80 | * Sets the value of a field. |
||
81 | * |
||
82 | * You can pass an array of key => value pairs |
||
83 | * to set multiple fields at the same time: |
||
84 | * |
||
85 | * $model->set(array( |
||
86 | * 'field1' => 'value', |
||
87 | * 'field2' => 'value', |
||
88 | * .... |
||
89 | * )); |
||
90 | * |
||
91 | * @param array|string $values |
||
92 | * @param mixed|null $value |
||
93 | * @return $this |
||
94 | */ |
||
95 | 93 | public function set($values, $value = NULL) |
|
126 | |||
127 | /** |
||
128 | * Clears the object and loads an array of values into the object. |
||
129 | * |
||
130 | * This should only be used for setting from database results |
||
131 | * since the model declares itself as saved and loaded after. |
||
132 | * |
||
133 | * @param Jam_Model|array $values |
||
134 | * @return $this |
||
135 | */ |
||
136 | 196 | public function load_fields($values) |
|
188 | |||
189 | /** |
||
190 | * Validates the current model's data |
||
191 | * |
||
192 | * @throws Jam_Exception_Validation |
||
193 | * @param Validation|null $extra_validation |
||
194 | * @return bool |
||
195 | */ |
||
196 | 19 | public function check($force = FALSE) |
|
202 | |||
203 | 754 | protected function _move_retrieved_to_changed() |
|
213 | |||
214 | public function update_fields($values, $value = NULL) |
||
233 | |||
234 | /** |
||
235 | * Creates or updates the current record. |
||
236 | * |
||
237 | * @param bool|null $validate |
||
238 | * @return $this |
||
239 | * @throws Kohana_Exception |
||
240 | * @throws Jam_Exception_Validation |
||
241 | */ |
||
242 | 18 | public function save($validate = NULL) |
|
243 | { |
||
244 | 18 | if ($this->_is_saving) |
|
245 | throw new Kohana_Exception("Cannot save a model that is already in the process of saving"); |
||
246 | |||
247 | |||
248 | 18 | $key = $this->_original[$this->meta()->primary_key()]; |
|
249 | |||
250 | // Run validation |
||
251 | 18 | if ($validate !== FALSE && !$this->check()) |
|
252 | { |
||
253 | throw new Jam_Exception_Validation('There was an error validating the :model: :errors', $this); |
||
254 | } |
||
255 | |||
256 | 18 | $this->_is_saving = TRUE; |
|
257 | |||
258 | // These will be processed later |
||
259 | 18 | $values = $defaults = array(); |
|
260 | |||
261 | 18 | if ($this->meta()->events()->trigger('model.before_save', $this, array($this->_changed)) === FALSE) |
|
262 | { |
||
263 | return $this; |
||
264 | } |
||
265 | |||
266 | // Trigger callbacks and ensure we should proceed |
||
267 | 18 | $event_type = $key ? 'update' : 'create'; |
|
268 | |||
269 | 18 | if ($this->meta()->events()->trigger('model.before_'.$event_type, $this, array($this->_changed)) === FALSE) |
|
270 | { |
||
271 | return $this; |
||
272 | } |
||
273 | |||
274 | 18 | $this->_move_retrieved_to_changed(); |
|
275 | |||
276 | // Iterate through all fields in original in case any unchanged fields |
||
277 | // have convert() behavior like timestamp updating... |
||
278 | // |
||
279 | 18 | foreach (array_merge($this->_original, $this->_changed) as $column => $value) |
|
280 | { |
||
281 | 18 | if ($field = $this->meta()->field($column)) |
|
282 | { |
||
283 | // Only save in_db values |
||
284 | 18 | if ($field->in_db) |
|
285 | { |
||
286 | // See if field wants to alter the value on save() |
||
287 | 18 | $value = $field->convert($this, $value, $key); |
|
288 | |||
289 | // Only set the value to be saved if it's changed from the original |
||
290 | 18 | if ($value !== $this->_original[$column]) |
|
291 | { |
||
292 | 15 | $values[$field->column] = $value; |
|
293 | } |
||
294 | // Or if we're INSERTing and we need to set the defaults for the first time |
||
295 | 18 | elseif ( ! $key AND ( ! $this->changed($field->name) OR $field->default === $value) AND ! $field->primary) |
|
296 | { |
||
297 | 18 | $defaults[$field->column] = $field->default; |
|
298 | } |
||
299 | } |
||
300 | } |
||
301 | } |
||
302 | |||
303 | // If we have a key, we're updating |
||
304 | 18 | if ($key) |
|
305 | { |
||
306 | // Do we even have to update anything in the row? |
||
307 | 3 | if ($values) |
|
308 | { |
||
309 | 2 | Jam::update($this) |
|
310 | 2 | ->where_key($key) |
|
311 | 2 | ->set($values) |
|
312 | 3 | ->execute(); |
|
313 | } |
||
314 | } |
||
315 | else |
||
316 | { |
||
317 | 16 | $insert_values = array_merge($defaults, $values); |
|
318 | 16 | list($id) = Jam::insert($this) |
|
319 | 16 | ->columns(array_keys($insert_values)) |
|
320 | 16 | ->values(array_values($insert_values)) |
|
321 | 16 | ->execute(); |
|
322 | |||
323 | // Gotta make sure to set this |
||
324 | 16 | $key = $values[$this->meta()->primary_key()] = $id; |
|
325 | } |
||
326 | |||
327 | // Re-set any saved values; they may have changed |
||
328 | 18 | $this->set($values); |
|
329 | |||
330 | 18 | $this->_loaded = $this->_saved = TRUE; |
|
331 | |||
332 | 18 | $this->meta()->events()->trigger('model.after_save', $this, array($this->_changed, $event_type)); |
|
333 | |||
334 | 18 | $this->meta()->events()->trigger('model.after_'.$event_type, $this, array($this->_changed)); |
|
335 | |||
336 | // Set the changed data back as original |
||
337 | 18 | $this->_original = array_merge($this->_original, $this->_changed); |
|
338 | |||
339 | 18 | $this->_changed = array(); |
|
340 | |||
341 | 18 | foreach ($this->_retrieved as $name => $retrieved) |
|
342 | { |
||
343 | 15 | if (($association = $this->meta()->association($name))) |
|
344 | { |
||
345 | 1 | if ($association instanceof Jam_Association_Collection) |
|
346 | { |
||
347 | 1 | $retrieved->clear_changed(); |
|
348 | } |
||
349 | } |
||
350 | 15 | elseif (($field = $this->meta()->field($name)) AND $field->in_db) |
|
351 | { |
||
352 | 15 | unset($this->_retrieved[$name]); |
|
353 | } |
||
354 | } |
||
355 | |||
356 | 18 | $this->_is_saving = FALSE; |
|
357 | |||
358 | 18 | return $this; |
|
359 | } |
||
360 | |||
361 | /** |
||
362 | * Deletes a single record. |
||
363 | * |
||
364 | * @return boolean |
||
365 | **/ |
||
366 | 9 | public function delete() |
|
392 | |||
393 | /** |
||
394 | * Removes any changes made to a model. |
||
395 | * |
||
396 | * This method only works on loaded models. |
||
397 | * |
||
398 | * @return $this |
||
399 | */ |
||
400 | public function revert() |
||
412 | |||
413 | /** |
||
414 | * Sets a model to its original state, as if freshly instantiated |
||
415 | * |
||
416 | * @return $this |
||
417 | */ |
||
418 | 196 | public function clear() |
|
427 | |||
428 | 1 | public function get_insist($attribute_name) |
|
440 | |||
441 | 1 | public function build($association_name, array $attributes = array()) |
|
457 | |||
458 | /** |
||
459 | * Returns whether or not the model is loaded |
||
460 | * |
||
461 | * @return boolean |
||
462 | */ |
||
463 | 91 | public function loaded() |
|
467 | |||
468 | public function loaded_insist() |
||
475 | |||
476 | /** |
||
477 | * Whether or not the model is saved |
||
478 | * |
||
479 | * @return boolean |
||
480 | */ |
||
481 | 10 | public function saved() |
|
485 | |||
486 | /** |
||
487 | * Whether or not the model is in the process of being saved |
||
488 | * |
||
489 | * @return boolean |
||
490 | */ |
||
491 | 3 | public function is_saving() |
|
495 | |||
496 | /** |
||
497 | * Whether or not the model is deleted |
||
498 | * |
||
499 | * @return boolean |
||
500 | */ |
||
501 | public function deleted() |
||
505 | |||
506 | /** |
||
507 | * Build a new model object based on the current one, but without an ID, so it can be saved as a new object |
||
508 | * @return Jam_Model |
||
509 | */ |
||
510 | 1 | public function duplicate() |
|
518 | |||
519 | /** |
||
520 | * Returns a string representation of the model in the |
||
521 | * form of `Model_Name (id)` or `Model_Name (NULL)` if |
||
522 | * the model is not loaded. |
||
523 | * |
||
524 | * This is designed to be useful for debugging. |
||
525 | * |
||
526 | * @return string |
||
527 | */ |
||
528 | 4 | public function __toString() |
|
532 | |||
533 | 754 | public function serialize() |
|
546 | |||
547 | 754 | public function unserialize($data) |
|
568 | } |
||
569 |
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.
Consider the following example. The parameter
$italy
is not defined by the methodfinale(...)
.The most likely cause is that the parameter was removed, but the annotation was not.