Darya\Storage\AbstractResult

Complexity

Total Complexity

7

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	snakeToCamel()	0	5	1
A	getInfo()	0	8	1
A	setInfo()	0	11	3
A	__get()	0	3	1
A	__isset()	0	3	1

<?php
namespace Darya\Storage;

/**
 * Darya's abstract storage query result.
 * 
 * TODO: Make this iterable for result data.
 * 
 * @property array  $data     Result data
 * @property object $query    Query that produced this result
 * @property int    $count    Result count
 * @property object $error    Result error
 * @property array  $fields   Field names for each result data row
 * @property int    $insertId Insert ID
 * @property int    $affected Rows affected
 * 
 * @author Chris Andrew <chris@hexus.io>
 */
abstract class AbstractResult {
	
	/**
	 * The storage query that produced this result.
	 * 
	 * @var mixed
	 */
	protected $query;
	
	/**
	 * An associative array of the result data.
	 * 
	 * @var array
	 */
	protected $data;
	
	/**
	 * The error that occurred when executing the query, if any.
	 * 
	 * @var mixed|null
	 */
	protected $error;
	
	/**
	 * The number of rows in the result data.
	 * 
	 * @var int
	 */
	protected $count = 0;
	
	/**
	 * The set of fields available for each row in the result.
	 * 
	 * @var array
	 */
	protected $fields = array();
	
	/**
	 * The number of rows affected by the query.
	 * 
	 * @var string
	 */
	protected $affected = 0;
	
	/**
	 * Auto incremented primary key of an inserted row.
	 * 
	 * @var int
	 */
	protected $insertId = 0;
	
	/**
	 * Convert a string from snake_case to camelCase.
	 * 
	 * @param string $string
	 * @return string
	 */
	protected static function snakeToCamel($string) {
		return preg_replace_callback('/_(.)/', function($matches) {
			return strtoupper($matches[1]);
		}, $string);
	}
	
	/**
	 * Get the result info.
	 * 
	 * Retrieves the affected, count, insertId and fields properties
	 * as a key-value array, with snake-case equivalent keys.
	 * 
	 * @return array
	 */
	public function getInfo() {
		return array(
			'count' => $this->count,
			'fields' => $this->fields,
			'affected' => $this->affected,
			'insert_id' => $this->insertId
		);
	}
	
	/**
	 * Set the result info.
	 * 
	 * Accepts the keys 'affected', 'count', 'insert_id' and 'fields'.
	 * 
	 * @param array $info
	 */
	protected function setInfo(array $info) {
		$keys = array_keys($this->getInfo());
		
		foreach ($keys as $key) {
			$property = static::snakeToCamel($key);
			
			if (isset($info[$key])) {
				$this->$property = $info[$key];
			}
		}
	}
	
	/**
	 * Dynamically retrieve the given property.
	 * 
	 * @param string $property
	 * @return mixed
	 */
	public function __get($property) {
		return $this->$property;
	}
	
	/**
	 * Dynamically determine whether the given property exists.
	 * 
	 * @param string $property
	 * @return bool
	 */
	public function __isset($property) {
		return isset($this->$property);
	}
}