Kohana_Jam_Query_Builder_Collection

Complexity

Total Complexity

37

Size/Duplication

Total Lines	278
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

69.41%

Importance

Changes

0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	factory()	0	4	1
A	result()	0	14	3
A	load_fields()	0	5	1
A	_load_model()	0	11	2
A	as_array()	0	13	2
A	ids()	0	4	1
A	first()	0	4	1
A	first_insist()	0	8	2
A	_id()	0	11	5
A	search()	0	17	4
A	has()	0	4	1
A	count()	0	4	1
A	offsetGet()	0	8	2
A	offsetExists()	0	4	1
A	offsetSet()	0	4	1
A	offsetUnset()	0	4	1
A	rewind()	0	4	1
A	current()	0	8	2
A	key()	0	4	1
A	next()	0	4	1
A	valid()	0	4	1
A	serialize()	0	4	1
A	unserialize()	0	6	1

<?php defined('SYSPATH') OR die('No direct script access.');

/**
 * A collection of jam models from the database.
 *
 * @package    Jam
 * @category   Associations
 * @author     Ivan Kerin
 * @copyright  (c) 2011-2012 Despark Ltd.
 * @license    http://www.opensource.org/licenses/isc-license.txt
 */
abstract class Kohana_Jam_Query_Builder_Collection extends Jam_Query_Builder_Select implements Countable, ArrayAccess, Iterator, Serializable {

	/**
	 * Create object of class Jam_Query_Builder_Collection
	 * @param  string $model
	 * @return Jam_Query_Builder_Collection
	 */
	public static function factory($model)
	{
		return new Jam_Query_Builder_Collection($model);
	}

	/**
	 * The result of this colleciton
	 * @var Database_Result
	 */
	protected $_result;

	/**
	 * Result Setter / Getter
	 * @param  Database_Result $result
	 * @return Database_Result|Jam_Query_Builder_Collection
	 */
	public function result(Database_Result $result = NULL)
	{
		if ($result !== NULL)
		{
			$this->_result = $result;
		}

		if ( ! $this->_result)
		{
			$this->_result = $this->execute();
		}

		return $this->_result;
	}

	/**
	 * Load the info for the collection result, as if was loaded from the database
	 * @param  array  $fields
	 * @return Jam_Query_Builder_Collection
	 */
	public function load_fields(array $fields)
	{
		$this->_result = new Database_Result_Cached($fields, '', FALSE);
		return $this;
	}

	/**
	 * Use the Jam::build_template() to return the model for the row in the results
	 * @param  array $value
	 * @return Jam_Model
	 */
	protected function _load_model($value)
	{
		if ( ! $value)

The expression $value of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

			return NULL;


		$model = clone Jam::build_template($this->meta()->model(), $value);
		$model = $model->load_fields($value);

		return $model;
	}

	/**
	 * Return all of the models in the result as an array.
	 *
	 *     // Indexed array of all models
	 *     $rows = $result->as_array();
	 *
	 *     // Associative array of models by "id"
	 *     $rows = $result->as_array('id');
	 *
	 *     // Associative array of fields, "id" => "name"
	 *     $rows = $result->as_array('id', 'name');
	 *
	 * @param   string  column for associative keys
	 * @param   string  column for values
	 * @return  array
	 */
	public function as_array($key = NULL, $value = NULL)
	{
		$key = Jam_Query_Builder::resolve_meta_attribute($key, $this->meta());
		if ($value === NULL)
		{
			return array_map(array($this, '_load_model'), $this->result()->as_array($key));

It seems like $key defined by \Jam_Query_Builder::resolve_meta_attribute($key, $this->meta()) on line 96 can also be of type object<Jam_Meta>; however, Kohana_Database_Result::as_array() does only seem to accept string|null, maybe add an additional type check?

		}
		else
		{
			$value = Jam_Query_Builder::resolve_meta_attribute($value, $this->meta());
			return $this->result()->as_array($key, $value);

It seems like $key defined by \Jam_Query_Builder::resolve_meta_attribute($key, $this->meta()) on line 96 can also be of type object<Jam_Meta>; however, Kohana_Database_Result::as_array() does only seem to accept string|null, maybe add an additional type check?

It seems like $value defined by \Jam_Query_Builder::resolve_meta_attribute($value, $this->meta()) on line 103 can also be of type object<Jam_Meta>; however, Kohana_Database_Result::as_array() does only seem to accept string|null, maybe add an additional type check?

		}
	}

	/**
	 * Get the ids of the models in an array
	 * @return array
	 */
	public function ids()
	{
		return $this->as_array(NULL, ':primary_key');
	}

	/**
	 * Return the first model
	 * @return Jam_Model|null
	 */
	public function first()
	{
		return $this->_load_model($this->limit(1)->result()->rewind()->current());
	}

	/**
	 * Return the first model, throw Jam_Exception_Notfound if there was no result
	 * @return Jam_Model
	 * @throws Jam_Exception_Notfound
	 */
	public function first_insist()
	{
		$result = $this->first();
		if ( ! $result)
			throw new Jam_Exception_Notfound(":model not found", $this->meta()->model());

		return $result;
	}

	/**
	 * Find out the primary_key of an item of the $_content
	 * @param  mixed $value
	 * @return int
	 */
	protected function _id($value)
	{
		if ($value instanceof Jam_Model)
			return $value->id();

		if (is_numeric($value))
			return (int) $value;

		if (is_array($value) AND isset($value[$this->meta()->primary_key()]))
			return (int) $value[$this->meta()->primary_key()];
	}

	public function search($item)
	{
		$search_id = $this->_id($item);

		if ( ! $search_id)
			return NULL;

		foreach ($this as $offset => $current)
		{
			if ($this->_id($current) === $search_id)
			{
				return (int) $offset;
			}
		}

		return NULL;
	}

	public function has($item)
	{
		return $this->search($item) !== NULL;
	}

	/**
	 * Implement Countable
	 * @return int
	 */
	public function count()
	{
		return $this->result()->count();
	}

	/**
	 * Implement ArrayAccess
	 *
	 * @param  int $offset
	 * @return Jam_Model
	 */
	public function offsetGet($offset)
	{
		$value = $this->result()->offsetGet($offset);
		if ( ! $value)
			return NULL;

		return $this->_load_model($value);
	}

	/**
	 * Implement ArrayAccess
	 *
	 * @param  int $offset
	 * @return boolean
	 */
	public function offsetExists($offset)
	{
		return $this->result()->offsetExists($offset);
	}

	/**
	 * Implement ArrayAccess
	 */
	public function offsetSet($offset, $value)
	{
		throw new Kohana_Exception('Database results are read-only');
	}

	/**
	 * Implement ArrayAccess
	 */
	public function offsetUnset($offset)
	{
		throw new Kohana_Exception('Database results are read-only');
	}

	/**
	 * Implement Iterator
	 */
	public function rewind()
	{
		$this->result()->rewind();
	}

	/**
	 * Implement Iterator
	 * @return  Jam_Model
	 */
	public function current()
	{
		$value = $this->result()->current();
		if ( ! $value)
			return NULL;

		return $this->_load_model($value);
	}

	/**
	 * Implement Iterator
	 * @return  int
	 */
	public function key()
	{
		return $this->result()->key();
	}

	/**
	 * Implement Iterator
	 */
	public function next()
	{
		$this->result()->next();
	}

	/**
	 * Implement Iterator
	 * @return  bool
	 */
	public function valid()
	{
		return $this->result()->valid();
	}

	public function serialize()
	{
		return serialize(array('fields' => $this->result()->as_array(), 'meta' => $this->meta()->model()));
	}

	public function unserialize($data)
	{
		$data = unserialize($data);
		$this->_meta = Jam::meta($data['meta']);
		$this->load_fields($data['fields']);
	}
}