miBadger / miBadger.ActiveRecord

src/ActiveRecordInterface.php

Indentation +60 added lines, -60 removed lines

@@ -19,72 +19,72 @@
 interface ActiveRecordInterface
 {
 
-	public function __construct(\PDO $pdo);
+    public function __construct(\PDO $pdo);
 	
-	/**
-	 * Returns this active record after creating an entry with the records attributes.
-	 *
-	 * @return $this
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function create();
+    /**
+     * Returns this active record after creating an entry with the records attributes.
+     *
+     * @return $this
+     * @throws ActiveRecordException on failure.
+     */
+    public function create();
 
-	/**
-	 * Returns this active record after reading the attributes from the entry with the given identifier.
-	 *
-	 * @param mixed $id
-	 * @return $this
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function read($id);
+    /**
+     * Returns this active record after reading the attributes from the entry with the given identifier.
+     *
+     * @param mixed $id
+     * @return $this
+     * @throws ActiveRecordException on failure.
+     */
+    public function read($id);
 
-	/**
-	 * Returns this active record after updating the attributes to the corresponding entry.
-	 *
-	 * @return $this
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function update();
+    /**
+     * Returns this active record after updating the attributes to the corresponding entry.
+     *
+     * @return $this
+     * @throws ActiveRecordException on failure.
+     */
+    public function update();
 
-	/**
-	 * Returns this record after deleting the corresponding entry.
-	 *
-	 * @return $this
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function delete();
+    /**
+     * Returns this record after deleting the corresponding entry.
+     *
+     * @return $this
+     * @throws ActiveRecordException on failure.
+     */
+    public function delete();
 
-	/**
-	 * Returns this record after synchronizing it with the corresponding entry.
-	 * A new entry is created if this active record does not have a corresponding entry.
-	 *
-	 * @return $this
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function sync();
+    /**
+     * Returns this record after synchronizing it with the corresponding entry.
+     * A new entry is created if this active record does not have a corresponding entry.
+     *
+     * @return $this
+     * @throws ActiveRecordException on failure.
+     */
+    public function sync();
 
-	/**
-	 * Returns true if this active record has a corresponding entry.
-	 *
-	 * @return bool true if this active record has a corresponding entry.
-	 */
-	public function exists();
+    /**
+     * Returns true if this active record has a corresponding entry.
+     *
+     * @return bool true if this active record has a corresponding entry.
+     */
+    public function exists();
 
-	/**
-	 * Returns this record after filling it with the given attributes.
-	 *
-	 * @param array $attributes = []
-	 * @return $this
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function fill(array $attributes);
+    /**
+     * Returns this record after filling it with the given attributes.
+     *
+     * @param array $attributes = []
+     * @return $this
+     * @throws ActiveRecordException on failure.
+     */
+    public function fill(array $attributes);
 
-	/**
-	 * Returns the records with the given where, order by, limit and offset clauses.
-	 *
-	 * @param array $excludedTraits
-	 * @return ActiveRecordQuery the query representing the current search.
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function search(Array $excludedTraits);
+    /**
+     * Returns the records with the given where, order by, limit and offset clauses.
+     *
+     * @param array $excludedTraits
+     * @return ActiveRecordQuery the query representing the current search.
+     * @throws ActiveRecordException on failure.
+     */
+    public function search(Array $excludedTraits);
 }

src/Traits/ManyToManyRelation.php

Indentation +109 added lines, -109 removed lines

@@ -8,115 +8,115 @@
 
 Trait ManyToManyRelation
 {
-	// These variables are relevant for internal bookkeeping (constraint generation etc)
-
-	/** @var string The name of the left column of the relation. */
-	private $_leftColumnName;
-
-	/** @var string The name of the right column of the relation. */
-	private $_rightColumnName;
-
-	/** @var string The name of the left table of the relation. */
-	private $_leftEntityTable;
-
-	/** @var string The name of the right table of the relation. */
-	private $_rightEntityTable;
-
-	/** @var \PDO The PDO object. */
-	protected $pdo;
-	/**
-	 * Initializes the the ManyToManyRelation trait on the included object
-	 * 
-	 * @param AbstractActiveRecord $leftEntity The left entity of the relation
-	 * @param int $leftVariable The reference to the variable where the id for the left entity will be stored
-	 * @param AbstractActiveRecord $rightEntity The left entity of the relation
-	 * @param int $leftVariable The reference to the variable where the id for the right entity will be stored
-	 * @return void
-	 */
-	protected function initManyToManyRelation(AbstractActiveRecord $leftEntity, &$leftVariable, AbstractActiveRecord $rightEntity, &$rightVariable)
-	{
-		$this->_leftEntityTable = $leftEntity->getTableName();
-		$this->_rightEntityTable = $rightEntity->getTableName();
-
-		if (get_class($leftEntity) === get_class($rightEntity)) {
-			$this->_leftColumnName = sprintf("id_%s_left", $leftEntity->getTableName());
-			$this->_rightColumnName = sprintf("id_%s_right", $rightEntity->getTableName());
-		} else {
-			$this->_leftColumnName = sprintf("id_%s", $leftEntity->getTableName());
-			$this->_rightColumnName = sprintf("id_%s", $rightEntity->getTableName());
-		}
-
-		$this->extendTableDefinition($this->_leftColumnName, [
-			'value' => &$leftVariable,
-			'validate' => null,
-			'type' => AbstractActiveRecord::COLUMN_TYPE_ID,
-			'properties' => ColumnProperty::NOT_NULL
-		]);
-
-		$this->extendTableDefinition($this->_rightColumnName, [
-			'value' => &$rightVariable,
-			'validate' => null,
-			'type' => AbstractActiveRecord::COLUMN_TYPE_ID,
-			'properties' => ColumnProperty::NOT_NULL
-		]);
-	}
-
-	/**
-	 * Build the constraints for the many-to-many relation table
-	 * @return void
-	 */
-	public function createTableConstraints()
-	{
-		$childTable = $this->getTableName();
-
-		$leftParentTable = $this->_leftEntityTable;
-		$rightParentTable = $this->_rightEntityTable;
-
-		$leftConstraint = $this->buildConstraint($leftParentTable, 'id', $childTable, $this->_leftColumnName);
-		$rightConstraint = $this->buildConstraint($rightParentTable, 'id', $childTable, $this->_rightColumnName);
-
-		$this->pdo->query($leftConstraint);
-		$this->pdo->query($rightConstraint);
-	}
-
-	/**
-	 * @return void
-	 */	
-	abstract protected function getTableName();
-
-	/**
-	 * @return void
-	 */
-	abstract protected function buildConstraint($parentTable, $parentColumn, $childTable, $childColumn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function extendTableDefinition($columnName, $definition);
+    // These variables are relevant for internal bookkeeping (constraint generation etc)
+
+    /** @var string The name of the left column of the relation. */
+    private $_leftColumnName;
+
+    /** @var string The name of the right column of the relation. */
+    private $_rightColumnName;
+
+    /** @var string The name of the left table of the relation. */
+    private $_leftEntityTable;
+
+    /** @var string The name of the right table of the relation. */
+    private $_rightEntityTable;
+
+    /** @var \PDO The PDO object. */
+    protected $pdo;
+    /**
+     * Initializes the the ManyToManyRelation trait on the included object
+     * 
+     * @param AbstractActiveRecord $leftEntity The left entity of the relation
+     * @param int $leftVariable The reference to the variable where the id for the left entity will be stored
+     * @param AbstractActiveRecord $rightEntity The left entity of the relation
+     * @param int $leftVariable The reference to the variable where the id for the right entity will be stored
+     * @return void
+     */
+    protected function initManyToManyRelation(AbstractActiveRecord $leftEntity, &$leftVariable, AbstractActiveRecord $rightEntity, &$rightVariable)
+    {
+        $this->_leftEntityTable = $leftEntity->getTableName();
+        $this->_rightEntityTable = $rightEntity->getTableName();
+
+        if (get_class($leftEntity) === get_class($rightEntity)) {
+            $this->_leftColumnName = sprintf("id_%s_left", $leftEntity->getTableName());
+            $this->_rightColumnName = sprintf("id_%s_right", $rightEntity->getTableName());
+        } else {
+            $this->_leftColumnName = sprintf("id_%s", $leftEntity->getTableName());
+            $this->_rightColumnName = sprintf("id_%s", $rightEntity->getTableName());
+        }
+
+        $this->extendTableDefinition($this->_leftColumnName, [
+            'value' => &$leftVariable,
+            'validate' => null,
+            'type' => AbstractActiveRecord::COLUMN_TYPE_ID,
+            'properties' => ColumnProperty::NOT_NULL
+        ]);
+
+        $this->extendTableDefinition($this->_rightColumnName, [
+            'value' => &$rightVariable,
+            'validate' => null,
+            'type' => AbstractActiveRecord::COLUMN_TYPE_ID,
+            'properties' => ColumnProperty::NOT_NULL
+        ]);
+    }
+
+    /**
+     * Build the constraints for the many-to-many relation table
+     * @return void
+     */
+    public function createTableConstraints()
+    {
+        $childTable = $this->getTableName();
+
+        $leftParentTable = $this->_leftEntityTable;
+        $rightParentTable = $this->_rightEntityTable;
+
+        $leftConstraint = $this->buildConstraint($leftParentTable, 'id', $childTable, $this->_leftColumnName);
+        $rightConstraint = $this->buildConstraint($rightParentTable, 'id', $childTable, $this->_rightColumnName);
+
+        $this->pdo->query($leftConstraint);
+        $this->pdo->query($rightConstraint);
+    }
+
+    /**
+     * @return void
+     */	
+    abstract protected function getTableName();
+
+    /**
+     * @return void
+     */
+    abstract protected function buildConstraint($parentTable, $parentColumn, $childTable, $childColumn);
+
+    /**
+     * @return void
+     */
+    abstract protected function extendTableDefinition($columnName, $definition);
 	
-	/**
-	 * @return void
-	 */
-	abstract protected function registerSearchHook($columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerDeleteHook($columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerUpdateHook($columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerReadHook($columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerCreateHook($columnName, $fn);
+    /**
+     * @return void
+     */
+    abstract protected function registerSearchHook($columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerDeleteHook($columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerUpdateHook($columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerReadHook($columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerCreateHook($columnName, $fn);
 
 }

src/Traits/AutoApi.php

Indentation +333 added lines, -333 removed lines

@@ -8,351 +8,351 @@
 
 trait AutoApi
 {
-	/* =======================================================================
+    /* =======================================================================
 	 * ===================== Automatic API Support ===========================
 	 * ======================================================================= */
 
-	/** @var array A map of column name to functions that hook the insert function */
-	protected $registeredCreateHooks;
+    /** @var array A map of column name to functions that hook the insert function */
+    protected $registeredCreateHooks;
 
-	/** @var array A map of column name to functions that hook the read function */
-	protected $registeredReadHooks;
+    /** @var array A map of column name to functions that hook the read function */
+    protected $registeredReadHooks;
 
-	/** @var array A map of column name to functions that hook the update function */
-	protected $registeredUpdateHooks;
+    /** @var array A map of column name to functions that hook the update function */
+    protected $registeredUpdateHooks;
 
-	/** @var array A map of column name to functions that hook the update function */
-	protected $registeredDeleteHooks;	
+    /** @var array A map of column name to functions that hook the update function */
+    protected $registeredDeleteHooks;	
 
-	/** @var array A map of column name to functions that hook the search function */
-	protected $registeredSearchHooks;
+    /** @var array A map of column name to functions that hook the search function */
+    protected $registeredSearchHooks;
 
-	/** @var array A list of table column definitions */
-	protected $tableDefinition;
+    /** @var array A list of table column definitions */
+    protected $tableDefinition;
 
-	public function apiSearch(Array $queryparams, Array $fieldWhitelist)
-	{
-		// @TODO: Would it be better to not include the ignored_traits?
-		$ignoredTraits = $queryparams['ignored_traits'] ?? [];
-		$query = $this->search($ignoredTraits);
+    public function apiSearch(Array $queryparams, Array $fieldWhitelist)
+    {
+        // @TODO: Would it be better to not include the ignored_traits?
+        $ignoredTraits = $queryparams['ignored_traits'] ?? [];
+        $query = $this->search($ignoredTraits);
 
-		$orderColumn = $queryparams['order_by'] ?? null;
-		$orderDirection = $queryparams['order_direction'] ?? null;
-		if ($orderColumn !== null) {
-			$query->orderBy($orderColumn, $orderDirection);
-		}
+        $orderColumn = $queryparams['order_by'] ?? null;
+        $orderDirection = $queryparams['order_direction'] ?? null;
+        if ($orderColumn !== null) {
+            $query->orderBy($orderColumn, $orderDirection);
+        }
 		
-		$limit = $queryparams['limit'] ?? null;
-		if ($limit !== null) {
-			$query->limit($limit);
-		}
-
-		$offset = $queryparams['offset'] ?? null;
-		if ($offset !== null) {
-			$query->offset($offset);
-		}
-
-		$results = $query->fetchAll();
-
-		$resultsArray = [];
-		foreach ($results as $result) {
-			$resultsArray[] = $result->toArray($fieldWhitelist);
-		}
-
-		return $resultsArray;
-	}
-
-	public function toArray($fieldWhitelist)
-	{
-		$output = [];
-		foreach ($this->tableDefinition as $colName => $definition) {
-			if (in_array($colName, $fieldWhitelist)) {
-				$output[$colName] = $definition['value'];
-			}
-		}
-
-		return $output;
-	}
-
-	public function apiRead($id, Array $fieldWhitelist)
-	{
-		$this->read($id);
-		return $this->toArray($fieldWhitelist);
-	}
-
-	/* =============================================================
+        $limit = $queryparams['limit'] ?? null;
+        if ($limit !== null) {
+            $query->limit($limit);
+        }
+
+        $offset = $queryparams['offset'] ?? null;
+        if ($offset !== null) {
+            $query->offset($offset);
+        }
+
+        $results = $query->fetchAll();
+
+        $resultsArray = [];
+        foreach ($results as $result) {
+            $resultsArray[] = $result->toArray($fieldWhitelist);
+        }
+
+        return $resultsArray;
+    }
+
+    public function toArray($fieldWhitelist)
+    {
+        $output = [];
+        foreach ($this->tableDefinition as $colName => $definition) {
+            if (in_array($colName, $fieldWhitelist)) {
+                $output[$colName] = $definition['value'];
+            }
+        }
+
+        return $output;
+    }
+
+    public function apiRead($id, Array $fieldWhitelist)
+    {
+        $this->read($id);
+        return $this->toArray($fieldWhitelist);
+    }
+
+    /* =============================================================
 	 * ===================== Constraint validation =================
 	 * ============================================================= */
 
-	/**
-	 * Copy all table variables between two instances
-	 */
-	private function syncInstances($to, $from)
-	{
-		foreach ($to->tableDefinition as $colName => $definition) {
-			$definition['value'] = $from->tableDefinition[$colName]['value'];
-		}
-	}
-
-	private function filterInputColumns($input, $whitelist)
-	{
-		$filteredInput = $input;
-		foreach ($input as $colName => $value) {
-			if (!in_array($colName, $whitelist)) {
-				unset($filteredInput[$colName]);
-			}
-		}
-		return $filteredInput;
-	}
-
-	private function validateExcessKeys($input)
-	{
-		$errors = [];
-		foreach ($input as $colName => $value) {
-			if (!array_key_exists($colName, $this->tableDefinition)) {
-				$errors[$colName] = "Unknown input field";
-				continue;
-			}
-		}
-		return $errors;
-	}
-
-	private function validateImmutableColumns($input)
-	{
-		$errors = [];
-		foreach ($this->tableDefinition as $colName => $definition) {
-			$property = $definition['properties'] ?? null;
-			if (array_key_exists($colName, $input)
-				&& $property & ColumnProperty::IMMUTABLE) {
-				$errors[$colName] = "Field cannot be changed";
-			}
-		}
-		return $errors;
-	}
-
-	private function validateInputValues($input)
-	{
-		$errors = [];
-		foreach ($this->tableDefinition as $colName => $definition) {
-			// Validation check 1: If validate function is present
-			if (array_key_exists($colName, $input) 
-				&& is_callable($definition['validate'] ?? null)) {
-				$inputValue = $input[$colName];
-
-				// If validation function fails
-				[$status, $message] = $definition['validate']($inputValue);
-				if (!$status) {
-					$errors[$colName] = $message;
-				}	
-			}
-
-			// Validation check 2: If relation column, check whether entity exists
-			$properties = $definition['properties'] ?? null;
-			if (isset($definition['relation'])
-				&& ($properties & ColumnProperty::NOT_NULL)) {
-				$instance = clone $definition['relation'];
-				try {
-					$instance->read($input[$colName] ?? null);
-				} catch (ActiveRecordException $e) {
-					$errors[$colName] = "Entity for this value doesn't exist";
-				}
-			}
-		}
-		return $errors;
-	}
-
-	/**
-	 * This function is only used for API Update calls (direct getter/setter functions are unconstrained)
-	 */
-	private function validateMissingKeys()
-	{
-		$errors = [];
-
-		foreach ($this->tableDefinition as $colName => $colDefinition) {
-			$default = $colDefinition['default'] ?? null;
-			$properties = $colDefinition['properties'] ?? null;
-			$value = $colDefinition['value'];
-
-			// If nullable and default not set => null
-			// If nullable and default null => default (null)
-			// If nullable and default set => default (value)
-
-			// if not nullable and default not set => error
-			// if not nullable and default null => error
-			// if not nullable and default st => default (value)
-			// => if not nullable and default null and value not set => error message in this method
-			if ($properties & ColumnProperty::NOT_NULL
-				&& $default === null
-				&& !($properties & ColumnProperty::AUTO_INCREMENT)
-				// && !array_key_exists($colName, $input)
-				&& $value === null) {
-				$errors[$colName] = sprintf("The required field \"%s\" is missing", $colName);
-			}
-		}
-
-		return $errors;
-	}
-
-	/**
-	 * Copies the values for entries in the input with matching variable names in the record definition
-	 * @param Array $input The input data to be loaded into $this record
-	 */
-	private function loadData($input)
-	{
-		foreach ($this->tableDefinition as $colName => $definition) {
-			if (array_key_exists($colName, $input)) {
-				$definition['value'] = $input[$colName];
-			}
-		}
-	}
-
-	/**
-	 * @param Array $input Associative array of input values
-	 * @param Array $fieldWhitelist array of column names that are allowed to be filled by the input array 
-	 * @return Array Array containing the set of optional errors (associative array) and an optional array representation (associative)
-	 * 					of the modified data.
-	 */
-	public function apiCreate($input, Array $fieldWhitelist)
-	{
-		// Clone $this to new instance (for restoring if validation goes wrong)
-		$transaction = $this->newInstance();
-		$errors = [];
-
-		// Filter out all non-whitelisted input values
-		$input = $this->filterInputColumns($input, $fieldWhitelist);
-
-		// Validate excess keys
-		$errors += $transaction->validateExcessKeys($input);
-
-		// Validate input values (using validation function)
-		$errors += $transaction->validateInputValues($input);
-
-		// "Copy" data into transaction
-		$transaction->loadData($input);
-
-		// Run create hooks
-		foreach ($this->registeredCreateHooks as $colName => $fn) {
-			$fn();
-		}
-
-		// Validate missing keys
-		$errors += $transaction->validateMissingKeys();
-
-		// If no errors, commit the pending data
-		if (empty($errors)) {
-			$this->syncInstances($this, $transaction);
-
-			try {
-				(new Query($this->getPdo(), $this->getTableName()))
-					->insert($this->getActiveRecordColumns())
-					->execute();
-
-				$this->setId(intval($this->getPdo()->lastInsertId()));
-			} catch (\PDOException $e) {
-				// @TODO: Potentially filter and store mysql messages (where possible) in error messages
-				throw new ActiveRecordException($e->getMessage(), 0, $e);
-			}
-
-			return [null, $this->toArray($fieldWhitelist)];
-		} else {
-			return [$errors, null];
-		}
-	}
-
-	/**
-	 * @param Array $input Associative array of input values
-	 * @param Array $fieldWhitelist array of column names that are allowed to be filled by the input array 
-	 * @return Array Array containing the set of optional errors (associative array) and an optional array representation (associative)
-	 * 					of the modified data.
-	 */
-	public function apiUpdate($input, Array $fieldWhitelist)
-	{
-		$transaction = $this->newInstance();
-		$errors = [];
-
-		// Filter out all non-whitelisted input values
-		$input = $this->filterInputColumns($input, $fieldWhitelist);
-
-		// Check for excess keys
-		$errors += $transaction->validateExcessKeys($input);
-
-		// Check for immutable keys
-		$errors += $transaction->validateImmutableColumns($input);
-
-		// Validate input values (using validation function)
-		$errors += $transaction->validateInputValues($input);
-
-		// "Copy" data into transaction
-		$transaction->loadData($input);
-
-		// Run create hooks
-		foreach ($this->registeredUpdateHooks as $colName => $fn) {
-			$fn();
-		}
-
-		// Validate missing keys
-		$errors += $transaction->validateMissingKeys();
-
-		// Update database
-		if (empty($errors)) {
-			$this->syncInstances($this, $transaction);
-
-			try {
-				(new Query($this->getPdo(), $this->getTableName()))
-					->update($this->getActiveRecordColumns())
-					->where(Query::Equal('id', $this->getId()))
-					->execute();
-			} catch (\PDOException $e) {
-				throw new ActiveRecordException($e->getMessage(), 0, $e);
-			}
-
-			return [null, $this->toArray($fieldWhitelist)];
-		} else {
-			return [$errors, null];
-		}
-	}
-
-	/**
-	 * Returns this active record after reading the attributes from the entry with the given identifier.
-	 *
-	 * @param mixed $id
-	 * @return $this
-	 * @throws ActiveRecordException on failure.
-	 */
-	abstract public function read($id);
-
-	/**
-	 * Returns the PDO.
-	 *
-	 * @return \PDO the PDO.
-	 */
-	abstract public function getPdo();
-
-	/**
-	 * Set the ID.
-	 *
-	 * @param int $id
-	 * @return $this
-	 */
-	abstract protected function setId($id);
-
-	/**
-	 * Returns the ID.
-	 *
-	 * @return null|int The ID.
-	 */
-	abstract protected function getId();
-
-	/**
-	 * Returns the active record table.
-	 *
-	 * @return string the active record table name.
-	 */
-	abstract protected function getTableName();
-
-	/**
-	 * Returns the name -> variable mapping for the table definition.
-	 * @return Array The mapping
-	 */
-	abstract protected function getActiveRecordColumns();
+    /**
+     * Copy all table variables between two instances
+     */
+    private function syncInstances($to, $from)
+    {
+        foreach ($to->tableDefinition as $colName => $definition) {
+            $definition['value'] = $from->tableDefinition[$colName]['value'];
+        }
+    }
+
+    private function filterInputColumns($input, $whitelist)
+    {
+        $filteredInput = $input;
+        foreach ($input as $colName => $value) {
+            if (!in_array($colName, $whitelist)) {
+                unset($filteredInput[$colName]);
+            }
+        }
+        return $filteredInput;
+    }
+
+    private function validateExcessKeys($input)
+    {
+        $errors = [];
+        foreach ($input as $colName => $value) {
+            if (!array_key_exists($colName, $this->tableDefinition)) {
+                $errors[$colName] = "Unknown input field";
+                continue;
+            }
+        }
+        return $errors;
+    }
+
+    private function validateImmutableColumns($input)
+    {
+        $errors = [];
+        foreach ($this->tableDefinition as $colName => $definition) {
+            $property = $definition['properties'] ?? null;
+            if (array_key_exists($colName, $input)
+                && $property & ColumnProperty::IMMUTABLE) {
+                $errors[$colName] = "Field cannot be changed";
+            }
+        }
+        return $errors;
+    }
+
+    private function validateInputValues($input)
+    {
+        $errors = [];
+        foreach ($this->tableDefinition as $colName => $definition) {
+            // Validation check 1: If validate function is present
+            if (array_key_exists($colName, $input) 
+                && is_callable($definition['validate'] ?? null)) {
+                $inputValue = $input[$colName];
+
+                // If validation function fails
+                [$status, $message] = $definition['validate']($inputValue);
+                if (!$status) {
+                    $errors[$colName] = $message;
+                }	
+            }
+
+            // Validation check 2: If relation column, check whether entity exists
+            $properties = $definition['properties'] ?? null;
+            if (isset($definition['relation'])
+                && ($properties & ColumnProperty::NOT_NULL)) {
+                $instance = clone $definition['relation'];
+                try {
+                    $instance->read($input[$colName] ?? null);
+                } catch (ActiveRecordException $e) {
+                    $errors[$colName] = "Entity for this value doesn't exist";
+                }
+            }
+        }
+        return $errors;
+    }
+
+    /**
+     * This function is only used for API Update calls (direct getter/setter functions are unconstrained)
+     */
+    private function validateMissingKeys()
+    {
+        $errors = [];
+
+        foreach ($this->tableDefinition as $colName => $colDefinition) {
+            $default = $colDefinition['default'] ?? null;
+            $properties = $colDefinition['properties'] ?? null;
+            $value = $colDefinition['value'];
+
+            // If nullable and default not set => null
+            // If nullable and default null => default (null)
+            // If nullable and default set => default (value)
+
+            // if not nullable and default not set => error
+            // if not nullable and default null => error
+            // if not nullable and default st => default (value)
+            // => if not nullable and default null and value not set => error message in this method
+            if ($properties & ColumnProperty::NOT_NULL
+                && $default === null
+                && !($properties & ColumnProperty::AUTO_INCREMENT)
+                // && !array_key_exists($colName, $input)
+                && $value === null) {
+                $errors[$colName] = sprintf("The required field \"%s\" is missing", $colName);
+            }
+        }
+
+        return $errors;
+    }
+
+    /**
+     * Copies the values for entries in the input with matching variable names in the record definition
+     * @param Array $input The input data to be loaded into $this record
+     */
+    private function loadData($input)
+    {
+        foreach ($this->tableDefinition as $colName => $definition) {
+            if (array_key_exists($colName, $input)) {
+                $definition['value'] = $input[$colName];
+            }
+        }
+    }
+
+    /**
+     * @param Array $input Associative array of input values
+     * @param Array $fieldWhitelist array of column names that are allowed to be filled by the input array 
+     * @return Array Array containing the set of optional errors (associative array) and an optional array representation (associative)
+     * 					of the modified data.
+     */
+    public function apiCreate($input, Array $fieldWhitelist)
+    {
+        // Clone $this to new instance (for restoring if validation goes wrong)
+        $transaction = $this->newInstance();
+        $errors = [];
+
+        // Filter out all non-whitelisted input values
+        $input = $this->filterInputColumns($input, $fieldWhitelist);
+
+        // Validate excess keys
+        $errors += $transaction->validateExcessKeys($input);
+
+        // Validate input values (using validation function)
+        $errors += $transaction->validateInputValues($input);
+
+        // "Copy" data into transaction
+        $transaction->loadData($input);
+
+        // Run create hooks
+        foreach ($this->registeredCreateHooks as $colName => $fn) {
+            $fn();
+        }
+
+        // Validate missing keys
+        $errors += $transaction->validateMissingKeys();
+
+        // If no errors, commit the pending data
+        if (empty($errors)) {
+            $this->syncInstances($this, $transaction);
+
+            try {
+                (new Query($this->getPdo(), $this->getTableName()))
+                    ->insert($this->getActiveRecordColumns())
+                    ->execute();
+
+                $this->setId(intval($this->getPdo()->lastInsertId()));
+            } catch (\PDOException $e) {
+                // @TODO: Potentially filter and store mysql messages (where possible) in error messages
+                throw new ActiveRecordException($e->getMessage(), 0, $e);
+            }
+
+            return [null, $this->toArray($fieldWhitelist)];
+        } else {
+            return [$errors, null];
+        }
+    }
+
+    /**
+     * @param Array $input Associative array of input values
+     * @param Array $fieldWhitelist array of column names that are allowed to be filled by the input array 
+     * @return Array Array containing the set of optional errors (associative array) and an optional array representation (associative)
+     * 					of the modified data.
+     */
+    public function apiUpdate($input, Array $fieldWhitelist)
+    {
+        $transaction = $this->newInstance();
+        $errors = [];
+
+        // Filter out all non-whitelisted input values
+        $input = $this->filterInputColumns($input, $fieldWhitelist);
+
+        // Check for excess keys
+        $errors += $transaction->validateExcessKeys($input);
+
+        // Check for immutable keys
+        $errors += $transaction->validateImmutableColumns($input);
+
+        // Validate input values (using validation function)
+        $errors += $transaction->validateInputValues($input);
+
+        // "Copy" data into transaction
+        $transaction->loadData($input);
+
+        // Run create hooks
+        foreach ($this->registeredUpdateHooks as $colName => $fn) {
+            $fn();
+        }
+
+        // Validate missing keys
+        $errors += $transaction->validateMissingKeys();
+
+        // Update database
+        if (empty($errors)) {
+            $this->syncInstances($this, $transaction);
+
+            try {
+                (new Query($this->getPdo(), $this->getTableName()))
+                    ->update($this->getActiveRecordColumns())
+                    ->where(Query::Equal('id', $this->getId()))
+                    ->execute();
+            } catch (\PDOException $e) {
+                throw new ActiveRecordException($e->getMessage(), 0, $e);
+            }
+
+            return [null, $this->toArray($fieldWhitelist)];
+        } else {
+            return [$errors, null];
+        }
+    }
+
+    /**
+     * Returns this active record after reading the attributes from the entry with the given identifier.
+     *
+     * @param mixed $id
+     * @return $this
+     * @throws ActiveRecordException on failure.
+     */
+    abstract public function read($id);
+
+    /**
+     * Returns the PDO.
+     *
+     * @return \PDO the PDO.
+     */
+    abstract public function getPdo();
+
+    /**
+     * Set the ID.
+     *
+     * @param int $id
+     * @return $this
+     */
+    abstract protected function setId($id);
+
+    /**
+     * Returns the ID.
+     *
+     * @return null|int The ID.
+     */
+    abstract protected function getId();
+
+    /**
+     * Returns the active record table.
+     *
+     * @return string the active record table name.
+     */
+    abstract protected function getTableName();
+
+    /**
+     * Returns the name -> variable mapping for the table definition.
+     * @return Array The mapping
+     */
+    abstract protected function getActiveRecordColumns();
 }

src/AbstractActiveRecord.php

Indentation +599 added lines, -599 removed lines

@@ -18,610 +18,610 @@
  */
 abstract class AbstractActiveRecord implements ActiveRecordInterface
 {
-	const COLUMN_NAME_ID = 'id';
-	const COLUMN_TYPE_ID = 'INT UNSIGNED';
-
-	/** @var \PDO The PDO object. */
-	protected $pdo;
-
-	/** @var null|int The ID. */
-	private $id;
-
-	/** @var array A map of column name to functions that hook the insert function */
-	protected $registeredCreateHooks;
-
-	/** @var array A map of column name to functions that hook the read function */
-	protected $registeredReadHooks;
-
-	/** @var array A map of column name to functions that hook the update function */
-	protected $registeredUpdateHooks;
-
-	/** @var array A map of column name to functions that hook the update function */
-	protected $registeredDeleteHooks;	
-
-	/** @var array A map of column name to functions that hook the search function */
-	protected $registeredSearchHooks;
-
-	/** @var array A list of table column definitions */
-	protected $tableDefinition;
-
-	/**
-	 * Construct an abstract active record with the given PDO.
-	 *
-	 * @param \PDO $pdo
-	 */
-	public function __construct(\PDO $pdo )
-	{
-		$pdo->setAttribute(\PDO::ATTR_DEFAULT_FETCH_MODE, \PDO::FETCH_ASSOC);
-		$pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);
-
-		$this->setPdo($pdo);
-
-		$this->registeredCreateHooks = [];
-		$this->registeredReadHooks = [];
-		$this->registeredUpdateHooks = [];
-		$this->registeredDeleteHooks = [];
-		$this->registeredSearchHooks = [];
-		$this->tableDefinition = $this->getTableDefinition();
-
-		// Extend table definition with default ID field, throw exception if field already exists
-		if (array_key_exists('id', $this->tableDefinition)) {
-			$message = "Table definition in record contains a field with name \"id\"";
-			$message .= ", which is a reserved name by ActiveRecord";
-			throw new ActiveRecordException($message, 0);
-		}
-
-		$this->tableDefinition[self::COLUMN_NAME_ID] =
-		[
-			'value' => &$this->id,
-			'validate' => null,
-			'type' => self::COLUMN_TYPE_ID,
-			'properties' => ColumnProperty::NOT_NULL | ColumnProperty::IMMUTABLE | ColumnProperty::AUTO_INCREMENT | ColumnProperty::PRIMARY_KEY
-		];
-	}
-
-	private function checkHookConstraints($columnName, $hookMap)
-	{
-		// Check whether column exists
-		if (!array_key_exists($columnName, $this->tableDefinition)) 
-		{
-			throw new ActiveRecordException("Hook is trying to register on non-existing column \"$columnName\"", 0);
-		}
-
-		// Enforcing 1 hook per table column
-		if (array_key_exists($columnName, $hookMap)) {
-			$message = "Hook is trying to register on an already registered column \"$columnName\", ";
-			$message .= "do you have conflicting traits?";
-			throw new ActiveRecordException($message, 0);
-		}
-	}
-
-	/**
-	 * Register a new hook for a specific column that gets called before execution of the create() method
-	 * Only one hook per column can be registered at a time
-	 * @param string $columnName The name of the column that is registered.
-	 * @param string|callable $fn Either a callable, or the name of a method on the inheriting object.
-	 */
-	public function registerCreateHook($columnName, $fn)
-	{
-		$this->checkHookConstraints($columnName, $this->registeredCreateHooks);
-
-		if (is_string($fn) && is_callable([$this, $fn])) {
-			$this->registeredCreateHooks[$columnName] = [$this, $fn];
-		} else if (is_callable($fn)) {
-			$this->registeredCreateHooks[$columnName] = $fn;
-		} else {
-			throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0);
-		}
-	}
-
-	/**
-	 * Register a new hook for a specific column that gets called before execution of the read() method
-	 * Only one hook per column can be registered at a time
-	 * @param string $columnName The name of the column that is registered.
-	 * @param string|callable $fn Either a callable, or the name of a method on the inheriting object.
-	 */
-	public function registerReadHook($columnName, $fn)
-	{
-		$this->checkHookConstraints($columnName, $this->registeredReadHooks);
-
-		if (is_string($fn) && is_callable([$this, $fn])) {
-			$this->registeredReadHooks[$columnName] = [$this, $fn];
-		} else if (is_callable($fn)) {
-			$this->registeredReadHooks[$columnName] = $fn;
-		} else {
-			throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0);
-		}
-	}
-
-	/**
-	 * Register a new hook for a specific column that gets called before execution of the update() method
-	 * Only one hook per column can be registered at a time
-	 * @param string $columnName The name of the column that is registered.
-	 * @param string|callable $fn Either a callable, or the name of a method on the inheriting object.
-	 */
-	public function registerUpdateHook($columnName, $fn)
-	{
-		$this->checkHookConstraints($columnName, $this->registeredUpdateHooks);
-
-		if (is_string($fn) && is_callable([$this, $fn])) {
-			$this->registeredUpdateHooks[$columnName] = [$this, $fn];
-		} else if (is_callable($fn)) {
-			$this->registeredUpdateHooks[$columnName] = $fn;
-		} else {
-			throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0);
-		}
-	}
-
-	/**
-	 * Register a new hook for a specific column that gets called before execution of the delete() method
-	 * Only one hook per column can be registered at a time
-	 * @param string $columnName The name of the column that is registered.
-	 * @param string|callable $fn Either a callable, or the name of a method on the inheriting object.
-	 */
-	public function registerDeleteHook($columnName, $fn)
-	{
-		$this->checkHookConstraints($columnName, $this->registeredDeleteHooks);
-
-		if (is_string($fn) && is_callable([$this, $fn])) {
-			$this->registeredDeleteHooks[$columnName] = [$this, $fn];
-		} else if (is_callable($fn)) {
-			$this->registeredDeleteHooks[$columnName] = $fn;
-		} else {
-			throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0);
-		}
-	}
-
-	/**
-	 * Register a new hook for a specific column that gets called before execution of the search() method
-	 * Only one hook per column can be registered at a time
-	 * @param string $columnName The name of the column that is registered.
-	 * @param string|callable $fn Either a callable, or the name of a method on the inheriting object. The callable is required to take one argument: an instance of miBadger\Query\Query; 
-	 */
-	public function registerSearchHook($columnName, $fn)
-	{
-		$this->checkHookConstraints($columnName, $this->registeredSearchHooks);
-
-		if (is_string($fn) && is_callable([$this, $fn])) {
-			$this->registeredSearchHooks[$columnName] = [$this, $fn];
-		} else if (is_callable($fn)) {
-			$this->registeredSearchHooks[$columnName] = $fn;
-		} else {
-			throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0);
-		}
-	}
-
-	/**
-	 * Adds a new column definition to the table.
-	 * @param string $columnName The name of the column that is registered.
-	 * @param Array $definition The definition of that column.
-	 */
-	public function extendTableDefinition($columnName, $definition)
-	{
-		if ($this->tableDefinition === null) {
-			throw new ActiveRecordException("tableDefinition is null, most likely due to parent class not having been initialized in constructor");
-		}
-
-		// Enforcing table can only be extended with new columns
-		if (array_key_exists($columnName, $this->tableDefinition)) {
-			$message = "Table is being extended with a column that already exists, ";
-			$message .= "\"$columnName\" conflicts with your table definition";
-			throw new ActiveRecordException($message, 0);
-		}
-
-		$this->tableDefinition[$columnName] = $definition;
-	}
-
-	/**
-	 * Returns the type string as it should appear in the mysql create table statement for the given column
-	 * @return string The type string
-	 */
-	private function getDatabaseTypeString($colName, $type, $length)
-	{
-		switch (strtoupper($type)) {
-			case '':
-				throw new ActiveRecordException(sprintf("Column %s has invalid type \"NULL\"", $colName));
+    const COLUMN_NAME_ID = 'id';
+    const COLUMN_TYPE_ID = 'INT UNSIGNED';
+
+    /** @var \PDO The PDO object. */
+    protected $pdo;
+
+    /** @var null|int The ID. */
+    private $id;
+
+    /** @var array A map of column name to functions that hook the insert function */
+    protected $registeredCreateHooks;
+
+    /** @var array A map of column name to functions that hook the read function */
+    protected $registeredReadHooks;
+
+    /** @var array A map of column name to functions that hook the update function */
+    protected $registeredUpdateHooks;
+
+    /** @var array A map of column name to functions that hook the update function */
+    protected $registeredDeleteHooks;	
+
+    /** @var array A map of column name to functions that hook the search function */
+    protected $registeredSearchHooks;
+
+    /** @var array A list of table column definitions */
+    protected $tableDefinition;
+
+    /**
+     * Construct an abstract active record with the given PDO.
+     *
+     * @param \PDO $pdo
+     */
+    public function __construct(\PDO $pdo )
+    {
+        $pdo->setAttribute(\PDO::ATTR_DEFAULT_FETCH_MODE, \PDO::FETCH_ASSOC);
+        $pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);
+
+        $this->setPdo($pdo);
+
+        $this->registeredCreateHooks = [];
+        $this->registeredReadHooks = [];
+        $this->registeredUpdateHooks = [];
+        $this->registeredDeleteHooks = [];
+        $this->registeredSearchHooks = [];
+        $this->tableDefinition = $this->getTableDefinition();
+
+        // Extend table definition with default ID field, throw exception if field already exists
+        if (array_key_exists('id', $this->tableDefinition)) {
+            $message = "Table definition in record contains a field with name \"id\"";
+            $message .= ", which is a reserved name by ActiveRecord";
+            throw new ActiveRecordException($message, 0);
+        }
+
+        $this->tableDefinition[self::COLUMN_NAME_ID] =
+        [
+            'value' => &$this->id,
+            'validate' => null,
+            'type' => self::COLUMN_TYPE_ID,
+            'properties' => ColumnProperty::NOT_NULL | ColumnProperty::IMMUTABLE | ColumnProperty::AUTO_INCREMENT | ColumnProperty::PRIMARY_KEY
+        ];
+    }
+
+    private function checkHookConstraints($columnName, $hookMap)
+    {
+        // Check whether column exists
+        if (!array_key_exists($columnName, $this->tableDefinition)) 
+        {
+            throw new ActiveRecordException("Hook is trying to register on non-existing column \"$columnName\"", 0);
+        }
+
+        // Enforcing 1 hook per table column
+        if (array_key_exists($columnName, $hookMap)) {
+            $message = "Hook is trying to register on an already registered column \"$columnName\", ";
+            $message .= "do you have conflicting traits?";
+            throw new ActiveRecordException($message, 0);
+        }
+    }
+
+    /**
+     * Register a new hook for a specific column that gets called before execution of the create() method
+     * Only one hook per column can be registered at a time
+     * @param string $columnName The name of the column that is registered.
+     * @param string|callable $fn Either a callable, or the name of a method on the inheriting object.
+     */
+    public function registerCreateHook($columnName, $fn)
+    {
+        $this->checkHookConstraints($columnName, $this->registeredCreateHooks);
+
+        if (is_string($fn) && is_callable([$this, $fn])) {
+            $this->registeredCreateHooks[$columnName] = [$this, $fn];
+        } else if (is_callable($fn)) {
+            $this->registeredCreateHooks[$columnName] = $fn;
+        } else {
+            throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0);
+        }
+    }
+
+    /**
+     * Register a new hook for a specific column that gets called before execution of the read() method
+     * Only one hook per column can be registered at a time
+     * @param string $columnName The name of the column that is registered.
+     * @param string|callable $fn Either a callable, or the name of a method on the inheriting object.
+     */
+    public function registerReadHook($columnName, $fn)
+    {
+        $this->checkHookConstraints($columnName, $this->registeredReadHooks);
+
+        if (is_string($fn) && is_callable([$this, $fn])) {
+            $this->registeredReadHooks[$columnName] = [$this, $fn];
+        } else if (is_callable($fn)) {
+            $this->registeredReadHooks[$columnName] = $fn;
+        } else {
+            throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0);
+        }
+    }
+
+    /**
+     * Register a new hook for a specific column that gets called before execution of the update() method
+     * Only one hook per column can be registered at a time
+     * @param string $columnName The name of the column that is registered.
+     * @param string|callable $fn Either a callable, or the name of a method on the inheriting object.
+     */
+    public function registerUpdateHook($columnName, $fn)
+    {
+        $this->checkHookConstraints($columnName, $this->registeredUpdateHooks);
+
+        if (is_string($fn) && is_callable([$this, $fn])) {
+            $this->registeredUpdateHooks[$columnName] = [$this, $fn];
+        } else if (is_callable($fn)) {
+            $this->registeredUpdateHooks[$columnName] = $fn;
+        } else {
+            throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0);
+        }
+    }
+
+    /**
+     * Register a new hook for a specific column that gets called before execution of the delete() method
+     * Only one hook per column can be registered at a time
+     * @param string $columnName The name of the column that is registered.
+     * @param string|callable $fn Either a callable, or the name of a method on the inheriting object.
+     */
+    public function registerDeleteHook($columnName, $fn)
+    {
+        $this->checkHookConstraints($columnName, $this->registeredDeleteHooks);
+
+        if (is_string($fn) && is_callable([$this, $fn])) {
+            $this->registeredDeleteHooks[$columnName] = [$this, $fn];
+        } else if (is_callable($fn)) {
+            $this->registeredDeleteHooks[$columnName] = $fn;
+        } else {
+            throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0);
+        }
+    }
+
+    /**
+     * Register a new hook for a specific column that gets called before execution of the search() method
+     * Only one hook per column can be registered at a time
+     * @param string $columnName The name of the column that is registered.
+     * @param string|callable $fn Either a callable, or the name of a method on the inheriting object. The callable is required to take one argument: an instance of miBadger\Query\Query; 
+     */
+    public function registerSearchHook($columnName, $fn)
+    {
+        $this->checkHookConstraints($columnName, $this->registeredSearchHooks);
+
+        if (is_string($fn) && is_callable([$this, $fn])) {
+            $this->registeredSearchHooks[$columnName] = [$this, $fn];
+        } else if (is_callable($fn)) {
+            $this->registeredSearchHooks[$columnName] = $fn;
+        } else {
+            throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0);
+        }
+    }
+
+    /**
+     * Adds a new column definition to the table.
+     * @param string $columnName The name of the column that is registered.
+     * @param Array $definition The definition of that column.
+     */
+    public function extendTableDefinition($columnName, $definition)
+    {
+        if ($this->tableDefinition === null) {
+            throw new ActiveRecordException("tableDefinition is null, most likely due to parent class not having been initialized in constructor");
+        }
+
+        // Enforcing table can only be extended with new columns
+        if (array_key_exists($columnName, $this->tableDefinition)) {
+            $message = "Table is being extended with a column that already exists, ";
+            $message .= "\"$columnName\" conflicts with your table definition";
+            throw new ActiveRecordException($message, 0);
+        }
+
+        $this->tableDefinition[$columnName] = $definition;
+    }
+
+    /**
+     * Returns the type string as it should appear in the mysql create table statement for the given column
+     * @return string The type string
+     */
+    private function getDatabaseTypeString($colName, $type, $length)
+    {
+        switch (strtoupper($type)) {
+            case '':
+                throw new ActiveRecordException(sprintf("Column %s has invalid type \"NULL\"", $colName));
 				
-			case 'DATETIME':
-			case 'DATE':
-			case 'TIME':
-			case 'TEXT':
-			case 'INT UNSIGNED':
-				return $type;
-
-			case 'VARCHAR':
-				if ($length === null) {
-					throw new ActiveRecordException(sprintf("field type %s requires specified column field \"LENGTH\"", $colName));
-				} else {
-					return sprintf('%s(%d)', $type, $length);	
-				}
-
-			case 'INT':
-			case 'TINYINT':
-			case 'BIGINT':
-			default: 	
-				// Implicitly assuming that non-specified cases are correct without a length parameter
-				if ($length === null) {
-					return $type;
-				} else {
-					return sprintf('%s(%d)', $type, $length);	
-				}
-		}
-	}
-
-	/**
-	 * Builds the part of a MySQL create table statement that corresponds to the supplied column
-	 * @param string $colName 	Name of the database column
-	 * @param string $type 		The type of the string
-	 * @param int $properties 	The set of Column properties that apply to this column (See ColumnProperty for options)
-	 * @return string
-	 */
-	private function buildCreateTableColumnEntry($colName, $type, $length, $properties, $default)
-	{
-		$stmnt = sprintf('`%s` %s ', $colName, $this->getDatabaseTypeString($colName, $type, $length));
-		if ($properties & ColumnProperty::NOT_NULL) {
-			$stmnt .= 'NOT NULL ';
-		} else {
-			$stmnt .= 'NULL ';
-		}
-
-		if ($default !== NULL) {
-			$stmnt .= ' DEFAULT ' . $default . ' ';
-		}
-
-		if ($properties & ColumnProperty::AUTO_INCREMENT) {
-			$stmnt .= 'AUTO_INCREMENT ';
-		}
-
-		if ($properties & ColumnProperty::UNIQUE) {
-			$stmnt .= 'UNIQUE ';
-		}
-
-		if ($properties & ColumnProperty::PRIMARY_KEY) {
-			$stmnt .= 'PRIMARY KEY ';
-		}
-
-		return $stmnt;
-	}
-
-	/**
-	 * Sorts the column statement components in the order such that the id appears first, 
-	 * 		followed by all other columns in alphabetical ascending order
-	 * @param   Array $colStatements Array of column statements
-	 * @return  Array
-	 */
-	private function sortColumnStatements($colStatements)
-	{
-		// Find ID statement and put it first
-		$sortedStatements = [];
-
-		$sortedStatements[] = $colStatements[self::COLUMN_NAME_ID];
-		unset($colStatements[self::COLUMN_NAME_ID]);
-
-		// Sort remaining columns in alphabetical order
-		$columns = array_keys($colStatements);
-		sort($columns);
-		foreach ($columns as $colName) {
-			$sortedStatements[] = $colStatements[$colName];
-		}
-
-		return $sortedStatements;
-	}
-
-	/**
-	 * Builds the MySQL Create Table statement for the internal table definition
-	 * @return string
-	 */
-	public function buildCreateTableSQL()
-	{
-		$columnStatements = [];
-		foreach ($this->tableDefinition as $colName => $definition) {
-			// Destructure column definition
-			$type    = $definition['type'] ?? null;
-			$default = $definition['default'] ?? null;
-			$length  = $definition['length'] ?? null;
-			$properties = $definition['properties'] ?? null;
-
-			if (isset($definition['relation']) && $type !== null) {
-				$msg = "Column \"$colName\": ";
-				$msg .= "Relationship columns have an automatically inferred type, so type should be omitted";
-				throw new ActiveRecordException($msg);
-			} else if (isset($definition['relation'])) {
-				$type = self::COLUMN_TYPE_ID;
-			}
-
-			$columnStatements[$colName] = $this->buildCreateTableColumnEntry($colName, $type, $length, $properties, $default);
-		}
-
-		// Sort table (first column is id, the remaining are alphabetically sorted)
-		$columnStatements = $this->sortColumnStatements($columnStatements);
-
-		$sql = 'CREATE TABLE ' . $this->getTableName() . ' ';
-		$sql .= "(\n";
-		$sql .= implode(",\n", $columnStatements);
-		$sql .= "\n);";
-
-		return $sql;
-	}
-
-	/**
-	 * Creates the entity as a table in the database
-	 */
-	public function createTable()
-	{
-		$this->pdo->query($this->buildCreateTableSQL());
-	}
-
-	/**
-	 * builds a MySQL constraint statement for the given parameters
-	 * @param string $parentTable
-	 * @param string $parentColumn
-	 * @param string $childTable
-	 * @param string $childColumn
-	 * @return string The MySQL table constraint string
-	 */
-	protected function buildConstraint($parentTable, $parentColumn, $childTable, $childColumn)
-	{
-		$template = <<<SQL
+            case 'DATETIME':
+            case 'DATE':
+            case 'TIME':
+            case 'TEXT':
+            case 'INT UNSIGNED':
+                return $type;
+
+            case 'VARCHAR':
+                if ($length === null) {
+                    throw new ActiveRecordException(sprintf("field type %s requires specified column field \"LENGTH\"", $colName));
+                } else {
+                    return sprintf('%s(%d)', $type, $length);	
+                }
+
+            case 'INT':
+            case 'TINYINT':
+            case 'BIGINT':
+            default: 	
+                // Implicitly assuming that non-specified cases are correct without a length parameter
+                if ($length === null) {
+                    return $type;
+                } else {
+                    return sprintf('%s(%d)', $type, $length);	
+                }
+        }
+    }
+
+    /**
+     * Builds the part of a MySQL create table statement that corresponds to the supplied column
+     * @param string $colName 	Name of the database column
+     * @param string $type 		The type of the string
+     * @param int $properties 	The set of Column properties that apply to this column (See ColumnProperty for options)
+     * @return string
+     */
+    private function buildCreateTableColumnEntry($colName, $type, $length, $properties, $default)
+    {
+        $stmnt = sprintf('`%s` %s ', $colName, $this->getDatabaseTypeString($colName, $type, $length));
+        if ($properties & ColumnProperty::NOT_NULL) {
+            $stmnt .= 'NOT NULL ';
+        } else {
+            $stmnt .= 'NULL ';
+        }
+
+        if ($default !== NULL) {
+            $stmnt .= ' DEFAULT ' . $default . ' ';
+        }
+
+        if ($properties & ColumnProperty::AUTO_INCREMENT) {
+            $stmnt .= 'AUTO_INCREMENT ';
+        }
+
+        if ($properties & ColumnProperty::UNIQUE) {
+            $stmnt .= 'UNIQUE ';
+        }
+
+        if ($properties & ColumnProperty::PRIMARY_KEY) {
+            $stmnt .= 'PRIMARY KEY ';
+        }
+
+        return $stmnt;
+    }
+
+    /**
+     * Sorts the column statement components in the order such that the id appears first, 
+     * 		followed by all other columns in alphabetical ascending order
+     * @param   Array $colStatements Array of column statements
+     * @return  Array
+     */
+    private function sortColumnStatements($colStatements)
+    {
+        // Find ID statement and put it first
+        $sortedStatements = [];
+
+        $sortedStatements[] = $colStatements[self::COLUMN_NAME_ID];
+        unset($colStatements[self::COLUMN_NAME_ID]);
+
+        // Sort remaining columns in alphabetical order
+        $columns = array_keys($colStatements);
+        sort($columns);
+        foreach ($columns as $colName) {
+            $sortedStatements[] = $colStatements[$colName];
+        }
+
+        return $sortedStatements;
+    }
+
+    /**
+     * Builds the MySQL Create Table statement for the internal table definition
+     * @return string
+     */
+    public function buildCreateTableSQL()
+    {
+        $columnStatements = [];
+        foreach ($this->tableDefinition as $colName => $definition) {
+            // Destructure column definition
+            $type    = $definition['type'] ?? null;
+            $default = $definition['default'] ?? null;
+            $length  = $definition['length'] ?? null;
+            $properties = $definition['properties'] ?? null;
+
+            if (isset($definition['relation']) && $type !== null) {
+                $msg = "Column \"$colName\": ";
+                $msg .= "Relationship columns have an automatically inferred type, so type should be omitted";
+                throw new ActiveRecordException($msg);
+            } else if (isset($definition['relation'])) {
+                $type = self::COLUMN_TYPE_ID;
+            }
+
+            $columnStatements[$colName] = $this->buildCreateTableColumnEntry($colName, $type, $length, $properties, $default);
+        }
+
+        // Sort table (first column is id, the remaining are alphabetically sorted)
+        $columnStatements = $this->sortColumnStatements($columnStatements);
+
+        $sql = 'CREATE TABLE ' . $this->getTableName() . ' ';
+        $sql .= "(\n";
+        $sql .= implode(",\n", $columnStatements);
+        $sql .= "\n);";
+
+        return $sql;
+    }
+
+    /**
+     * Creates the entity as a table in the database
+     */
+    public function createTable()
+    {
+        $this->pdo->query($this->buildCreateTableSQL());
+    }
+
+    /**
+     * builds a MySQL constraint statement for the given parameters
+     * @param string $parentTable
+     * @param string $parentColumn
+     * @param string $childTable
+     * @param string $childColumn
+     * @return string The MySQL table constraint string
+     */
+    protected function buildConstraint($parentTable, $parentColumn, $childTable, $childColumn)
+    {
+        $template = <<<SQL
 ALTER TABLE `%s`
 ADD CONSTRAINT
 FOREIGN KEY (`%s`)
 REFERENCES `%s`(`%s`)
 ON DELETE CASCADE;
 SQL;
-		return sprintf($template, $childTable, $childColumn, $parentTable, $parentColumn);
-	}
-
-	/**
-	 * Iterates over the specified constraints in the table definition, 
-	 * 		and applies these to the database.
-	 */
-	public function createTableConstraints()
-	{
-		// Iterate over columns, check whether "relation" field exists, if so create constraint
-		foreach ($this->tableDefinition as $colName => $definition) {
-			if (isset($definition['relation']) && $definition['relation'] instanceof AbstractActiveRecord) {
-				// Forge new relation
-				$target = $definition['relation'];
-				$constraintSql = $this->buildConstraint($target->getTableName(), 'id', $this->getTableName(), $colName);
-
-				$this->pdo->query($constraintSql);
-			}
-		}
-	}
-
-	/**
-	 * Returns the name -> variable mapping for the table definition.
-	 * @return Array The mapping
-	 */
-	protected function getActiveRecordColumns()
-	{
-		$bindings = [];
-		foreach ($this->tableDefinition as $colName => $definition) {
-
-			// Ignore the id column (key) when inserting or updating
-			if ($colName == self::COLUMN_NAME_ID) {
-				continue;
-			}
-
-			$bindings[$colName] = &$definition['value'];
-		}
-		return $bindings;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function create()
-	{
-		foreach ($this->registeredCreateHooks as $colName => $fn) {
-			// @TODO: Would it be better to pass the Query to the function?
-			$fn();
-		}
-
-		try {
-			(new Query($this->getPdo(), $this->getTableName()))
-				->insert($this->getActiveRecordColumns())
-				->execute();
-
-			$this->setId(intval($this->getPdo()->lastInsertId()));
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), 0, $e);
-		}
-
-		return $this;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function read($id)
-	{
-		foreach ($this->registeredReadHooks as $colName => $fn) {
-			// @TODO: Would it be better to pass the Query to the function?
-			$fn();
-		}
-
-		try {
-			$row = (new Query($this->getPdo(), $this->getTableName()))
-				->select()
-				->where(Query::Equal('id', $id))
-				->execute()
-				->fetch();
-
-			if ($row === false) {
-				throw new ActiveRecordException(sprintf('Can not read the non-existent active record entry %d from the `%s` table.', $id, $this->getTableName()));
-			}
-
-			$this->fill($row)->setId($id);
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), 0, $e);
-		}
-
-		return $this;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function update()
-	{
-		foreach ($this->registeredUpdateHooks as $colName => $fn) {
-			// @TODO: Would it be better to pass the Query to the function?
-			$fn();
-		}
-
-		try {
-			(new Query($this->getPdo(), $this->getTableName()))
-				->update($this->getActiveRecordColumns())
-				->where(Query::Equal('id', $this->getId()))
-				->execute();
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), 0, $e);
-		}
-
-		return $this;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function delete()
-	{
-		foreach ($this->registeredDeleteHooks as $colName => $fn) {
-			// @TODO: Would it be better to pass the Query to the function?
-			$fn();
-		}
-
-		try {
-			(new Query($this->getPdo(), $this->getTableName()))
-				->delete()
-				->where(Query::Equal('id', $this->getId()))
-				->execute();
-
-			$this->setId(null);
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), 0, $e);
-		}
-
-		return $this;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function sync()
-	{
-		if (!$this->exists()) {
-			return $this->create();
-		}
-
-		return $this->update();
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function exists()
-	{
-		return $this->getId() !== null;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function fill(array $attributes)
-	{
-		$columns = $this->getActiveRecordColumns();
-		$columns['id'] = &$this->id;
-
-		foreach ($attributes as $key => $value) {
-			if (array_key_exists($key, $columns)) {
-				$columns[$key] = $value;
-			}
-		}
-
-		return $this;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function search(array $ignoredTraits = [])
-	{
-		$clauses = [];
-		foreach ($this->registeredSearchHooks as $column => $fn) {
-			if (!in_array($column, $ignoredTraits)) {
-				$clauses[] = $fn();
-			}
-		}
-
-		return new ActiveRecordQuery($this, $this->getTableName(), $clauses);
-	}
-
-	/**
-	 * Returns the PDO.
-	 *
-	 * @return \PDO the PDO.
-	 */
-	public function getPdo()
-	{
-		return $this->pdo;
-	}
-
-	/**
-	 * Set the PDO.
-	 *
-	 * @param \PDO $pdo
-	 * @return $this
-	 */
-	protected function setPdo($pdo)
-	{
-		$this->pdo = $pdo;
-
-		return $this;
-	}
-
-	/**
-	 * Returns the ID.
-	 *
-	 * @return null|int The ID.
-	 */
-	public function getId()
-	{
-		return $this->id;
-	}
-
-	/**
-	 * Set the ID.
-	 *
-	 * @param int $id
-	 * @return $this
-	 */
-	protected function setId($id)
-	{
-		$this->id = $id;
-
-		return $this;
-	}
-
-
-	public function newInstance()
-	{
-		return new static($this->pdo);
-	}
-
-	/**
-	 * Returns the active record table.
-	 *
-	 * @return string the active record table name.
-	 */
-	abstract protected function getTableName();
-
-	/**
-	 * Returns the active record columns.
-	 *
-	 * @return array the active record columns.
-	 */
-	abstract protected function getTableDefinition();
+        return sprintf($template, $childTable, $childColumn, $parentTable, $parentColumn);
+    }
+
+    /**
+     * Iterates over the specified constraints in the table definition, 
+     * 		and applies these to the database.
+     */
+    public function createTableConstraints()
+    {
+        // Iterate over columns, check whether "relation" field exists, if so create constraint
+        foreach ($this->tableDefinition as $colName => $definition) {
+            if (isset($definition['relation']) && $definition['relation'] instanceof AbstractActiveRecord) {
+                // Forge new relation
+                $target = $definition['relation'];
+                $constraintSql = $this->buildConstraint($target->getTableName(), 'id', $this->getTableName(), $colName);
+
+                $this->pdo->query($constraintSql);
+            }
+        }
+    }
+
+    /**
+     * Returns the name -> variable mapping for the table definition.
+     * @return Array The mapping
+     */
+    protected function getActiveRecordColumns()
+    {
+        $bindings = [];
+        foreach ($this->tableDefinition as $colName => $definition) {
+
+            // Ignore the id column (key) when inserting or updating
+            if ($colName == self::COLUMN_NAME_ID) {
+                continue;
+            }
+
+            $bindings[$colName] = &$definition['value'];
+        }
+        return $bindings;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function create()
+    {
+        foreach ($this->registeredCreateHooks as $colName => $fn) {
+            // @TODO: Would it be better to pass the Query to the function?
+            $fn();
+        }
+
+        try {
+            (new Query($this->getPdo(), $this->getTableName()))
+                ->insert($this->getActiveRecordColumns())
+                ->execute();
+
+            $this->setId(intval($this->getPdo()->lastInsertId()));
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), 0, $e);
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function read($id)
+    {
+        foreach ($this->registeredReadHooks as $colName => $fn) {
+            // @TODO: Would it be better to pass the Query to the function?
+            $fn();
+        }
+
+        try {
+            $row = (new Query($this->getPdo(), $this->getTableName()))
+                ->select()
+                ->where(Query::Equal('id', $id))
+                ->execute()
+                ->fetch();
+
+            if ($row === false) {
+                throw new ActiveRecordException(sprintf('Can not read the non-existent active record entry %d from the `%s` table.', $id, $this->getTableName()));
+            }
+
+            $this->fill($row)->setId($id);
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), 0, $e);
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function update()
+    {
+        foreach ($this->registeredUpdateHooks as $colName => $fn) {
+            // @TODO: Would it be better to pass the Query to the function?
+            $fn();
+        }
+
+        try {
+            (new Query($this->getPdo(), $this->getTableName()))
+                ->update($this->getActiveRecordColumns())
+                ->where(Query::Equal('id', $this->getId()))
+                ->execute();
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), 0, $e);
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function delete()
+    {
+        foreach ($this->registeredDeleteHooks as $colName => $fn) {
+            // @TODO: Would it be better to pass the Query to the function?
+            $fn();
+        }
+
+        try {
+            (new Query($this->getPdo(), $this->getTableName()))
+                ->delete()
+                ->where(Query::Equal('id', $this->getId()))
+                ->execute();
+
+            $this->setId(null);
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), 0, $e);
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function sync()
+    {
+        if (!$this->exists()) {
+            return $this->create();
+        }
+
+        return $this->update();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function exists()
+    {
+        return $this->getId() !== null;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function fill(array $attributes)
+    {
+        $columns = $this->getActiveRecordColumns();
+        $columns['id'] = &$this->id;
+
+        foreach ($attributes as $key => $value) {
+            if (array_key_exists($key, $columns)) {
+                $columns[$key] = $value;
+            }
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function search(array $ignoredTraits = [])
+    {
+        $clauses = [];
+        foreach ($this->registeredSearchHooks as $column => $fn) {
+            if (!in_array($column, $ignoredTraits)) {
+                $clauses[] = $fn();
+            }
+        }
+
+        return new ActiveRecordQuery($this, $this->getTableName(), $clauses);
+    }
+
+    /**
+     * Returns the PDO.
+     *
+     * @return \PDO the PDO.
+     */
+    public function getPdo()
+    {
+        return $this->pdo;
+    }
+
+    /**
+     * Set the PDO.
+     *
+     * @param \PDO $pdo
+     * @return $this
+     */
+    protected function setPdo($pdo)
+    {
+        $this->pdo = $pdo;
+
+        return $this;
+    }
+
+    /**
+     * Returns the ID.
+     *
+     * @return null|int The ID.
+     */
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    /**
+     * Set the ID.
+     *
+     * @param int $id
+     * @return $this
+     */
+    protected function setId($id)
+    {
+        $this->id = $id;
+
+        return $this;
+    }
+
+
+    public function newInstance()
+    {
+        return new static($this->pdo);
+    }
+
+    /**
+     * Returns the active record table.
+     *
+     * @return string the active record table name.
+     */
+    abstract protected function getTableName();
+
+    /**
+     * Returns the active record columns.
+     *
+     * @return array the active record columns.
+     */
+    abstract protected function getTableDefinition();
 }

Spacing +3 added lines, -3 removed lines

@@ -50,7 +50,7 @@ 
 	 *
 	 * @param \PDO $pdo
 	 */
-	public function __construct(\PDO $pdo )
+	public function __construct(\PDO $pdo)
 	{
 		$pdo->setAttribute(\PDO::ATTR_DEFAULT_FETCH_MODE, \PDO::FETCH_ASSOC);
 		$pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);
@@ -266,7 +266,7 @@ 
 		}
 
 		if ($default !== NULL) {
-			$stmnt .= ' DEFAULT ' . $default . ' ';
+			$stmnt .= ' DEFAULT '.$default.' ';
 		}
 
 		if ($properties & ColumnProperty::AUTO_INCREMENT) {
@@ -336,7 +336,7 @@ 
 		// Sort table (first column is id, the remaining are alphabetically sorted)
 		$columnStatements = $this->sortColumnStatements($columnStatements);
 
-		$sql = 'CREATE TABLE ' . $this->getTableName() . ' ';
+		$sql = 'CREATE TABLE '.$this->getTableName().' ';
 		$sql .= "(\n";
 		$sql .= implode(",\n", $columnStatements);
 		$sql .= "\n);";

src/ActiveRecordQuery.php

Indentation +157 added lines, -157 removed lines

@@ -21,166 +21,166 @@
 class ActiveRecordQuery implements \IteratorAggregate
 {
 
-	private $clauses = [];
+    private $clauses = [];
 
-	private $query;
+    private $query;
 
-	private $results;
+    private $results;
 
-	private $table;
+    private $table;
 
-	private $type;
+    private $type;
 	
-	private $whereExpression = null;
-
-	public function __construct(AbstractActiveRecord $instance, $table, Array $additionalWhereClauses)
-	{
-		$this->table = $table;
-		$this->query = new Query($instance->getPdo(), $table);
-		$this->type = $instance;
-		$this->clauses = $additionalWhereClauses;
-	}
-
-	private function execute()
-	{
-		$clauses = $this->clauses;
-
-		// Optionally add user concatenated where expression
-		if ($this->whereExpression !== null)
-		{
-			$clauses[] = $this->whereExpression;
-		}
-
-		// Construct where clause
-		if (count($clauses) == 1)
-		{
-			$this->query->where($clauses[0]);
-		} else if (count($clauses) >= 2)
-		{
-			$rest = array_slice($clauses, 1);
-			$this->query->where(Query::And($clauses[0], ...$rest));
-		}
-
-		$this->query->select();
-
-		$this->results = $this->query->execute();
-
-		return $this;
-	}
-
-	public function getIterator()
-	{
-		return new \ArrayIterator($this->fetchAll());
-	}
-
-	public function fetchAll()
-	{
-		try {
-			$this->execute();
-
-			$entries = $this->results->fetchAll();
-			if ($entries === false) {
-				throw new ActiveRecordException(sprintf('Can not search one non-existent entry from the `%s` table.', $this->table));
-			}
-
-			$typedResults = [];
-
-			foreach ($entries as $entry) {
-				$typedEntry = $this->type->newInstance();
-				$typedEntry->fill($entry);
-				$typedResults[] = $typedEntry;
-			}
-
-			return $typedResults;
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), 0, $e);
-		}
-	}
-
-	public function fetch()
-	{
-		try {
-			$this->execute();
-
-			$typedResult = $this->type->newInstance();
-
-			$entry = $this->results->fetch();
-			if ($entry === false) {
-				throw new ActiveRecordException(sprintf('Can not search one non-existent entry from the `%s` table.', $this->table));
-			}
-
-			$typedResult->fill($entry);
-
-			return $typedResult;
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), 0, $e);
-		}
-	}
-
-
-	/**
-	 * Set the where condition
-	 *
-	 * @param QueryExpression $expression the query expression
-	 * @return $this
-	 * @see https://en.wikipedia.org/wiki/SQL#Operators
-	 * @see https://en.wikipedia.org/wiki/Where_(SQL)
-	 */
-	public function where(QueryExpression $expression)
-	{
-		$this->whereExpression = $expression;
-		return $this;
-	}
-
-	/**
-	 * Set an additional group by.
-	 *
-	 * @param string $column
-	 * @return $this
-	 * @see https://en.wikipedia.org/wiki/SQL#Queries
-	 */
-	public function groupBy($column)
-	{
-		$this->query->groupBy($column);
-		return $this;
-	}
-
-	/**
-	 * Set an additional order condition.
-	 *
-	 * @param string $column
-	 * @param string|null $order
-	 * @return $this
-	 * @see https://en.wikipedia.org/wiki/SQL#Queries
-	 * @see https://en.wikipedia.org/wiki/Order_by
-	 */
-	public function orderBy($column, $order = null)
-	{
-		$this->query->orderBy($column, $order);	
-		return $this;
-	}
-
-	/**
-	 * Set the limit.
-	 *
-	 * @param mixed $limit
-	 * @return $this
-	 */
-	public function limit($limit)
-	{
-		$this->query->limit($limit);
-		return $this;
-	}
-
-	/**
-	 * Set the offset.
-	 *
-	 * @param mixed $offset
- 	 * @return $this
-	 */
-	public function offset($offset)
-	{
-		$this->query->offset($offset);
-		return $this;
-	}
+    private $whereExpression = null;
+
+    public function __construct(AbstractActiveRecord $instance, $table, Array $additionalWhereClauses)
+    {
+        $this->table = $table;
+        $this->query = new Query($instance->getPdo(), $table);
+        $this->type = $instance;
+        $this->clauses = $additionalWhereClauses;
+    }
+
+    private function execute()
+    {
+        $clauses = $this->clauses;
+
+        // Optionally add user concatenated where expression
+        if ($this->whereExpression !== null)
+        {
+            $clauses[] = $this->whereExpression;
+        }
+
+        // Construct where clause
+        if (count($clauses) == 1)
+        {
+            $this->query->where($clauses[0]);
+        } else if (count($clauses) >= 2)
+        {
+            $rest = array_slice($clauses, 1);
+            $this->query->where(Query::And($clauses[0], ...$rest));
+        }
+
+        $this->query->select();
+
+        $this->results = $this->query->execute();
+
+        return $this;
+    }
+
+    public function getIterator()
+    {
+        return new \ArrayIterator($this->fetchAll());
+    }
+
+    public function fetchAll()
+    {
+        try {
+            $this->execute();
+
+            $entries = $this->results->fetchAll();
+            if ($entries === false) {
+                throw new ActiveRecordException(sprintf('Can not search one non-existent entry from the `%s` table.', $this->table));
+            }
+
+            $typedResults = [];
+
+            foreach ($entries as $entry) {
+                $typedEntry = $this->type->newInstance();
+                $typedEntry->fill($entry);
+                $typedResults[] = $typedEntry;
+            }
+
+            return $typedResults;
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), 0, $e);
+        }
+    }
+
+    public function fetch()
+    {
+        try {
+            $this->execute();
+
+            $typedResult = $this->type->newInstance();
+
+            $entry = $this->results->fetch();
+            if ($entry === false) {
+                throw new ActiveRecordException(sprintf('Can not search one non-existent entry from the `%s` table.', $this->table));
+            }
+
+            $typedResult->fill($entry);
+
+            return $typedResult;
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), 0, $e);
+        }
+    }
+
+
+    /**
+     * Set the where condition
+     *
+     * @param QueryExpression $expression the query expression
+     * @return $this
+     * @see https://en.wikipedia.org/wiki/SQL#Operators
+     * @see https://en.wikipedia.org/wiki/Where_(SQL)
+     */
+    public function where(QueryExpression $expression)
+    {
+        $this->whereExpression = $expression;
+        return $this;
+    }
+
+    /**
+     * Set an additional group by.
+     *
+     * @param string $column
+     * @return $this
+     * @see https://en.wikipedia.org/wiki/SQL#Queries
+     */
+    public function groupBy($column)
+    {
+        $this->query->groupBy($column);
+        return $this;
+    }
+
+    /**
+     * Set an additional order condition.
+     *
+     * @param string $column
+     * @param string|null $order
+     * @return $this
+     * @see https://en.wikipedia.org/wiki/SQL#Queries
+     * @see https://en.wikipedia.org/wiki/Order_by
+     */
+    public function orderBy($column, $order = null)
+    {
+        $this->query->orderBy($column, $order);	
+        return $this;
+    }
+
+    /**
+     * Set the limit.
+     *
+     * @param mixed $limit
+     * @return $this
+     */
+    public function limit($limit)
+    {
+        $this->query->limit($limit);
+        return $this;
+    }
+
+    /**
+     * Set the offset.
+     *
+     * @param mixed $offset
+     * @return $this
+     */
+    public function offset($offset)
+    {
+        $this->query->offset($offset);
+        return $this;
+    }
 }