Darya\Storage\Query\Builder::execute()

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	Builder::raw()	0	4	1

<?php
namespace Darya\Storage\Query;

use Darya\Storage\Query;
use Darya\Storage\Queryable;
use Darya\Storage\Result;

/**
 * Darya's storage query builder.
 * 
 * Forwards method calls to a storage query and executes it on the given
 * queryable storage interface once the query has been built.
 * 
 * TODO: Implement event dispatcher awareness.
 * 
 * @property-read Query     $query
 * @property-read Queryable $storage
 * @property-read callable  $callback
 * 
 * @author Chris Andrew <chris@hexus.io>
 */
class Builder
{
	/**
	 * The query to execute.
	 * 
	 * @var Query
	 */
	protected $query;
	
	/**
	 * The storage interface to query.
	 * 
	 * @var Queryable
	 */
	protected $storage;
	
	/**
	 * A callback that processes results.
	 * 
	 * @var callback
	 */
	protected $callback;
	
	/**
	 * Query methods that should trigger query execution.
	 * 
	 * @var array
	 */
	protected static $executors = array(
		'all', 'read', 'select', 'unique', 'distinct', 'delete'
	);
	
	/**
	 * Instantiate a new query builder for the given query and storage.
	 * 
	 * @param Query     $query
	 * @param Queryable $storage
	 */
	public function __construct(Query $query, Queryable $storage)
	{
		$this->query = $query;
		$this->storage = $storage;
	}
	
	/**
	 * Dynamically invoke methods to fluently build a query.
	 * 
	 * If the method is an execute method, the query is executed and the result
	 * returned.
	 * 
	 * @param string $method
	 * @param array  $arguments
	 * @return $this|Result
	 */
	public function __call($method, $arguments)
	{
		call_user_func_array(array($this->query, $method), $arguments);
		
		if (in_array($method, static::$executors)) {
			return $this->run();
		}
		
		return $this;
	}
	
	/**
	 * Dynamically retrieve a property.
	 * 
	 * @param string $property
	 * @return mixed
	 */
	public function __get($property)
	{
		return $this->$property;
	}
	
	/**
	 * Set a callback to run on results before returning them from execute
	 * methods.
	 * 
	 * Callbacks should accept one parameter: the query result.
	 * 
	 * @param callback $callback
	 */
	public function callback($callback)
	{
		$this->callback = $callback;
	}
	
	/**
	 * Run the query through the storage interface.
	 *
	 * Always returns a Result object, ignoring the callback.
	 *
	 * @return Result
	 */
	public function raw()
	{
		return $this->storage->run($this->query);
	}
	
	/**
	 * Run the query through the storage interface.
	 *
	 * Returns the result of the callback, if one is set.
	 *
	 * @return mixed
	 */
	public function run()
	{
		$result = $this->storage->run($this->query);
		
		if (!is_callable($this->callback)) {
			return $result;
		}
		
		return call_user_func($this->callback, $result);
	}
	
	/**
	 * Alias for the run() method.
	 * 
	 * @return mixed
	 */
	public function cheers()
	{
		return $this->run();
	}
}