miBadger / miBadger.ActiveRecord

src/SchemaBuilder.php

Indentation +145 added lines, -145 removed lines

@@ -18,157 +18,157 @@
  */
 class SchemaBuilder
 {
-	/**
-	 * 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
-	 */
-	public static function buildConstraint($parentTable, $parentColumn, $childTable, $childColumn)
-	{
-		$template = <<<SQL
+    /**
+     * 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
+     */
+    public static 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);
-	}
-
-	/**
-	 * Returns the type string as it should appear in the mysql create table statement for the given column
-	 * @return string The type string
-	 */
-	public static function getDatabaseTypeString($colName, $type, $length)
-	{
-		switch (strtoupper($type)) {
-			case '':
-				throw new ActiveRecordException(sprintf("Column %s has invalid type \"NULL\"", $colName));
+        return sprintf($template, $childTable, $childColumn, $parentTable, $parentColumn);
+    }
+
+    /**
+     * Returns the type string as it should appear in the mysql create table statement for the given column
+     * @return string The type string
+     */
+    public static function getDatabaseTypeString($colName, $type, $length)
+    {
+        switch (strtoupper($type)) {
+            case '':
+                throw new ActiveRecordException(sprintf("Column %s has invalid type \"NULL\"", $colName));
 			
-			case 'BOOL';
-			case 'BOOLEAN':
-			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
-	 */
-	public static function buildCreateTableColumnEntry($colName, $type, $length, $properties, $default)
-	{
-		$stmnt = sprintf('`%s` %s ', $colName, self::getDatabaseTypeString($colName, $type, $length));
-		if ($properties & ColumnProperty::NOT_NULL) {
-			$stmnt .= 'NOT NULL ';
-		} else {
-			$stmnt .= 'NULL ';
-		}
-
-		if ($default !== NULL) {
-			$stmnt .= 'DEFAULT ' . var_export($default, true) . ' ';
-		}
-
-		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 static function sortColumnStatements($colStatements)
-	{
-		// Find ID statement and put it first
-		$sortedStatements = [];
-
-		$sortedStatements[] = $colStatements[AbstractActiveRecord::COLUMN_NAME_ID];
-		unset($colStatements[AbstractActiveRecord::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 static function buildCreateTableSQL($tableName, $tableDefinition)
-	{
-		$columnStatements = [];
-		foreach ($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 = sprintf("Column \"%s\" on table \"%s\": ", $colName, $tableName);
-				$msg .= "Relationship columns have an automatically inferred type, so type should be omitted";
-				throw new ActiveRecordException($msg);
-			} else if (isset($definition['relation'])) {
-				$type = AbstractActiveRecord::COLUMN_TYPE_ID;
-			}
-
-			$columnStatements[$colName] = self::buildCreateTableColumnEntry($colName, $type, $length, $properties, $default);
-		}
-
-		// Sort table (first column is id, the remaining are alphabetically sorted)
-		$columnStatements = self::sortColumnStatements($columnStatements);
-
-		$sql = sprintf("CREATE TABLE %s (\n%s\n);", 
-			$tableName, 
-			implode(",\n", $columnStatements));
-
-		return $sql;
-	}
+            case 'BOOL';
+            case 'BOOLEAN':
+            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
+     */
+    public static function buildCreateTableColumnEntry($colName, $type, $length, $properties, $default)
+    {
+        $stmnt = sprintf('`%s` %s ', $colName, self::getDatabaseTypeString($colName, $type, $length));
+        if ($properties & ColumnProperty::NOT_NULL) {
+            $stmnt .= 'NOT NULL ';
+        } else {
+            $stmnt .= 'NULL ';
+        }
+
+        if ($default !== NULL) {
+            $stmnt .= 'DEFAULT ' . var_export($default, true) . ' ';
+        }
+
+        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 static function sortColumnStatements($colStatements)
+    {
+        // Find ID statement and put it first
+        $sortedStatements = [];
+
+        $sortedStatements[] = $colStatements[AbstractActiveRecord::COLUMN_NAME_ID];
+        unset($colStatements[AbstractActiveRecord::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 static function buildCreateTableSQL($tableName, $tableDefinition)
+    {
+        $columnStatements = [];
+        foreach ($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 = sprintf("Column \"%s\" on table \"%s\": ", $colName, $tableName);
+                $msg .= "Relationship columns have an automatically inferred type, so type should be omitted";
+                throw new ActiveRecordException($msg);
+            } else if (isset($definition['relation'])) {
+                $type = AbstractActiveRecord::COLUMN_TYPE_ID;
+            }
+
+            $columnStatements[$colName] = self::buildCreateTableColumnEntry($colName, $type, $length, $properties, $default);
+        }
+
+        // Sort table (first column is id, the remaining are alphabetically sorted)
+        $columnStatements = self::sortColumnStatements($columnStatements);
+
+        $sql = sprintf("CREATE TABLE %s (\n%s\n);", 
+            $tableName, 
+            implode(",\n", $columnStatements));
+
+        return $sql;
+    }
 
 }

src/Traits/AutoApi.php

Indentation +366 added lines, -366 removed lines

@@ -9,386 +9,386 @@
 
 trait AutoApi
 {
-	/* =======================================================================
+    /* =======================================================================
 	 * ===================== Automatic API Support ===========================
 	 * ======================================================================= */
 
-	/** @var array A map of column name to functions that hook the insert function */
-	protected $createHooks;
+    /** @var array A map of column name to functions that hook the insert function */
+    protected $createHooks;
 
-	/** @var array A map of column name to functions that hook the read function */
-	protected $readHooks;
+    /** @var array A map of column name to functions that hook the read function */
+    protected $readHooks;
 
-	/** @var array A map of column name to functions that hook the update function */
-	protected $updateHooks;
+    /** @var array A map of column name to functions that hook the update function */
+    protected $updateHooks;
 
-	/** @var array A map of column name to functions that hook the update function */
-	protected $deleteHooks;	
+    /** @var array A map of column name to functions that hook the update function */
+    protected $deleteHooks;	
 
-	/** @var array A map of column name to functions that hook the search function */
-	protected $searchHooks;
+    /** @var array A map of column name to functions that hook the search function */
+    protected $searchHooks;
 
-	/** @var array A list of table column definitions */
-	protected $tableDefinition;
+    /** @var array A list of table column definitions */
+    protected $tableDefinition;
 
 
-	/**
-	 * @param Array $queryparams associative array of query params. Reserved options are
-	 *                             "search_order_by", "search_order_direction", "search_limit", "search_offset"
-	 *                             or column names corresponding to an instance of miBadger\Query\QueryExpression
-	 * @param Array $fieldWhitelist names of the columns that will appear in the output results
-	 */
-	public function apiSearch(Array $queryParams, Array $fieldWhitelist, ?QueryExpression $whereClause = null, int $maxResultLimit = 100)
-	{
-		$query = $this->search();
+    /**
+     * @param Array $queryparams associative array of query params. Reserved options are
+     *                             "search_order_by", "search_order_direction", "search_limit", "search_offset"
+     *                             or column names corresponding to an instance of miBadger\Query\QueryExpression
+     * @param Array $fieldWhitelist names of the columns that will appear in the output results
+     */
+    public function apiSearch(Array $queryParams, Array $fieldWhitelist, ?QueryExpression $whereClause = null, int $maxResultLimit = 100)
+    {
+        $query = $this->search();
 
-		// Build query
-		$orderColumn = $queryParams['search_order_by'] ?? null;
-		if (!in_array($orderColumn, $fieldWhitelist)) {
-			$orderColumn = null;
-		}
+        // Build query
+        $orderColumn = $queryParams['search_order_by'] ?? null;
+        if (!in_array($orderColumn, $fieldWhitelist)) {
+            $orderColumn = null;
+        }
 
-		$orderDirection = $queryParams['search_order_direction'] ?? null;
-		if ($orderColumn !== null) {
-			$query->orderBy($orderColumn, $orderDirection);
-		}
+        $orderDirection = $queryParams['search_order_direction'] ?? null;
+        if ($orderColumn !== null) {
+            $query->orderBy($orderColumn, $orderDirection);
+        }
 		
-		if ($whereClause !== null) {
-			$query->where($whereClause);
-		}
-
-		$limit = min((int) ($queryParams['search_limit'] ?? $maxResultLimit), $maxResultLimit);
-		$query->limit($limit);
-
-		$offset = $queryParams['search_offset'] ?? 0;
-		$query->offset($offset);
-
-		$numPages = $query->getNumberOfPages();
-		$currentPage = $query->getCurrentPage();
-
-		// Fetch results
-		$results = $query->fetchAll();
-		$resultsArray = [];
-		foreach ($results as $result) {
-			$resultsArray[] = $result->toArray($fieldWhitelist);
-		}
-
-		return [
-			'search_offset' => $offset,
-			'search_limit' => $limit,
-			'search_order_by' => $orderColumn,
-			'search_order_direction' => $orderDirection,
-			'search_pages' => $numPages,
-			'search_current' => $currentPage,
-			'data' => $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)
-	{
-		// @TODO: Should apiRead throw exception or return null on fail?
-		$this->read($id);
-		return $this->toArray($fieldWhitelist);
-	}
-
-	/* =============================================================
+        if ($whereClause !== null) {
+            $query->where($whereClause);
+        }
+
+        $limit = min((int) ($queryParams['search_limit'] ?? $maxResultLimit), $maxResultLimit);
+        $query->limit($limit);
+
+        $offset = $queryParams['search_offset'] ?? 0;
+        $query->offset($offset);
+
+        $numPages = $query->getNumberOfPages();
+        $currentPage = $query->getCurrentPage();
+
+        // Fetch results
+        $results = $query->fetchAll();
+        $resultsArray = [];
+        foreach ($results as $result) {
+            $resultsArray[] = $result->toArray($fieldWhitelist);
+        }
+
+        return [
+            'search_offset' => $offset,
+            'search_limit' => $limit,
+            'search_order_by' => $orderColumn,
+            'search_order_direction' => $orderDirection,
+            'search_pages' => $numPages,
+            'search_current' => $currentPage,
+            'data' => $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)
+    {
+        // @TODO: Should apiRead throw exception or return null on fail?
+        $this->read($id);
+        return $this->toArray($fieldWhitelist);
+    }
+
+    /* =============================================================
 	 * ===================== Constraint validation =================
 	 * ============================================================= */
 
-	/**
-	 * Copy all table variables between two instances
-	 */
-	public function syncInstanceFrom($from)
-	{
-		foreach ($this->tableDefinition as $colName => $definition) {
-			$this->tableDefinition[$colName]['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;
-	}
-
-	/**
-	 * Checks whether input values are correct:
-	 * 1. Checks whether a value passes the validation function for that column
-	 * 2. Checks whether a value supplied to a relationship column is a valid value
-	 */
-	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] ?? $definition['value'] ?? 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)
-	 * Determines whether there are required columns for which no data is provided
-	 */
-	private function validateMissingKeys($input)
-	{
-		$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 (or null) => error message in this method
-			if ($properties & ColumnProperty::NOT_NULL
-				&& $default === null
-				&& !($properties & ColumnProperty::AUTO_INCREMENT)
-				&& (!array_key_exists($colName, $input) 
-					|| $input[$colName] === null 
-					|| (is_string($input[$colName]) && $input[$colName] === '') )
-				&& ($value === null
-					|| (is_string($value) && $value === ''))) {
-				$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(Array $input, Array $createWhitelist, Array $readWhitelist)
-	{
-		// 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, $createWhitelist);
-
-		// 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 ($transaction->createHooks as $colName => $fn) {
-			$fn();
-		}
-
-		// Validate missing keys
-		$errors += $transaction->validateMissingKeys($input);
-
-		// If no errors, commit the pending data
-		if (empty($errors)) {
-			$this->syncInstanceFrom($transaction);
-
-			// Insert default values for not-null fields
-			$this->insertDefaults();
-
-			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($readWhitelist)];
-		} 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(Array $input, Array $updateWhitelist, Array $readWhitelist)
-	{
-		$transaction = $this->newInstance();
-		$transaction->syncInstanceFrom($this);
-		$errors = [];
-
-		// Filter out all non-whitelisted input values
-		$input = $this->filterInputColumns($input, $updateWhitelist);
-
-		// 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 ($transaction->updateHooks as $colName => $fn) {
-			$fn();
-		}
-
-		// Validate missing keys
-		$errors += $transaction->validateMissingKeys($input);
-
-		// Update database
-		if (empty($errors)) {
-			$this->syncInstanceFrom($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($readWhitelist)];
-		} 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 public 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
+     */
+    public function syncInstanceFrom($from)
+    {
+        foreach ($this->tableDefinition as $colName => $definition) {
+            $this->tableDefinition[$colName]['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;
+    }
+
+    /**
+     * Checks whether input values are correct:
+     * 1. Checks whether a value passes the validation function for that column
+     * 2. Checks whether a value supplied to a relationship column is a valid value
+     */
+    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] ?? $definition['value'] ?? 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)
+     * Determines whether there are required columns for which no data is provided
+     */
+    private function validateMissingKeys($input)
+    {
+        $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 (or null) => error message in this method
+            if ($properties & ColumnProperty::NOT_NULL
+                && $default === null
+                && !($properties & ColumnProperty::AUTO_INCREMENT)
+                && (!array_key_exists($colName, $input) 
+                    || $input[$colName] === null 
+                    || (is_string($input[$colName]) && $input[$colName] === '') )
+                && ($value === null
+                    || (is_string($value) && $value === ''))) {
+                $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(Array $input, Array $createWhitelist, Array $readWhitelist)
+    {
+        // 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, $createWhitelist);
+
+        // 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 ($transaction->createHooks as $colName => $fn) {
+            $fn();
+        }
+
+        // Validate missing keys
+        $errors += $transaction->validateMissingKeys($input);
+
+        // If no errors, commit the pending data
+        if (empty($errors)) {
+            $this->syncInstanceFrom($transaction);
+
+            // Insert default values for not-null fields
+            $this->insertDefaults();
+
+            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($readWhitelist)];
+        } 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(Array $input, Array $updateWhitelist, Array $readWhitelist)
+    {
+        $transaction = $this->newInstance();
+        $transaction->syncInstanceFrom($this);
+        $errors = [];
+
+        // Filter out all non-whitelisted input values
+        $input = $this->filterInputColumns($input, $updateWhitelist);
+
+        // 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 ($transaction->updateHooks as $colName => $fn) {
+            $fn();
+        }
+
+        // Validate missing keys
+        $errors += $transaction->validateMissingKeys($input);
+
+        // Update database
+        if (empty($errors)) {
+            $this->syncInstanceFrom($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($readWhitelist)];
+        } 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 public function getTableName();
+
+    /**
+     * Returns the name -> variable mapping for the table definition.
+     * @return Array The mapping
+     */
+    abstract protected function getActiveRecordColumns();
 }

Spacing +1 added lines, -1 removed lines

@@ -215,7 +215,7 @@
 				&& !($properties & ColumnProperty::AUTO_INCREMENT)
 				&& (!array_key_exists($colName, $input) 
 					|| $input[$colName] === null 
-					|| (is_string($input[$colName]) && $input[$colName] === '') )
+					|| (is_string($input[$colName]) && $input[$colName] === ''))
 				&& ($value === null
 					|| (is_string($value) && $value === ''))) {
 				$errors[$colName] = sprintf("The required field \"%s\" is missing", $colName);

src/Traits/Password.php

Indentation +158 added lines, -158 removed lines

@@ -13,165 +13,165 @@
 
 trait Password
 {
-	/** @var string The password hash. */
-	protected $password;
-
-	/** @var string|null The password reset token. */
-	protected $passwordResetToken;
-
-	/**
-	 * this method is required to be called in the constructor for each class that uses this trait. 
-	 * It adds the fields necessary for the passwords struct to the table definition
-	 */
-	protected function initPassword()
-	{
-		$this->extendTableDefinition(TRAIT_PASSWORD_FIELD_PASSWORD, [
-			'value' => &$this->password,
-			'validate' => [$this, 'validatePassword'],
-			'type' => 'VARCHAR',
-			'length' => 1024,
-			'properties' => null
-		]);
-
-		$this->extendTableDefinition(TRAIT_PASSWORD_FIELD_PASSWORD_RESET_TOKEN, [
-			'value' => &$this->passwordResetToken,
-			'validate' => null,
-			'default' => 0,
-			'type' => 'VARCHAR',
-			'length' => 1024
-		]);
-	}
-
-
-	/**
-	 * Returns whether the users password has been set
-	 * @return boolean true if the user has a password
-	 */
-	public function hasPasswordBeenSet()
-	{
-		return $this->password !== null;
-	}
-
-	/**
-	 * Returns true if the credentials are correct.
-	 *
-	 * @param string $password
-	 * @return boolean true if the credentials are correct
-	 */
-	public function isPassword($password)
-	{ 
-		if (!$this->hasPasswordBeenSet())
-		{
-			throw new ActiveRecordTraitException("Password field has not been set");
-		}
-
-		if (!password_verify($password, $this->password)) {
-			return false;
-		}
-
-		if (password_needs_rehash($this->password, TRAIT_PASSWORD_ENCRYPTION, ['cost' => TRAIT_PASSWORD_STRENTH])) {
-			$this->setPassword($password)->sync();
-		}
-
-		return true;
-	}
-
-	public function validatePassword($password) {
-		if (strlen($password) < TRAIT_PASSWORD_MIN_LENGTH) {
-			$message = sprintf('\'Password\' must be atleast %s characters long. %s characters provied.', TRAIT_PASSWORD_MIN_LENGTH, strlen($password));
-			return [false, $message];
-		}
-		return [true, ''];
-	}
-
-	/**
-	 * Set the password.
-	 *
-	 * @param string $password
-	 * @return $this
-	 * @throws \Exception
-	 */
-	public function setPassword($password)
-	{
-		[$status, $error] = $this->validatePassword($password);
-		if (!$status) {
-			throw new ActiveRecordTraitException($error);
-		}
-
-		$passwordHash = \password_hash($password, TRAIT_PASSWORD_ENCRYPTION, ['cost' => TRAIT_PASSWORD_STRENTH]);
-
-		if ($passwordHash === false) {
-			throw new ActiveRecordTraitException('\'Password\' hash failed.');
-		}
-
-		$this->password = $passwordHash;
-
-		return $this;
-	}
-
-	/**
-	 * @return string The Hash of the password
-	 */
-	public function getPasswordHash()
-	{
-		return $this->password;
-	}
-
-	/**
-	 * Returns the currently set password token for the entity, or null if not set
-	 * @return string|null The password reset token
-	 */
-	public function getPasswordResetToken()
-	{
-		return $this->passwordResetToken;
-	}
-
-	/**
-	 * Generates a new password reset token for the user
-	 */
-	public function generatePasswordResetToken()
-	{
-		$this->passwordResetToken = md5(uniqid(mt_rand(), true));
-		return $this;
-	}
-
-	/**
-	 * Clears the current password reset token
-	 */
-	public function clearPasswordResetToken()
-	{
-		$this->passwordResetToken = null;
-		return $this;
-	}
+    /** @var string The password hash. */
+    protected $password;
+
+    /** @var string|null The password reset token. */
+    protected $passwordResetToken;
+
+    /**
+     * this method is required to be called in the constructor for each class that uses this trait. 
+     * It adds the fields necessary for the passwords struct to the table definition
+     */
+    protected function initPassword()
+    {
+        $this->extendTableDefinition(TRAIT_PASSWORD_FIELD_PASSWORD, [
+            'value' => &$this->password,
+            'validate' => [$this, 'validatePassword'],
+            'type' => 'VARCHAR',
+            'length' => 1024,
+            'properties' => null
+        ]);
+
+        $this->extendTableDefinition(TRAIT_PASSWORD_FIELD_PASSWORD_RESET_TOKEN, [
+            'value' => &$this->passwordResetToken,
+            'validate' => null,
+            'default' => 0,
+            'type' => 'VARCHAR',
+            'length' => 1024
+        ]);
+    }
+
+
+    /**
+     * Returns whether the users password has been set
+     * @return boolean true if the user has a password
+     */
+    public function hasPasswordBeenSet()
+    {
+        return $this->password !== null;
+    }
+
+    /**
+     * Returns true if the credentials are correct.
+     *
+     * @param string $password
+     * @return boolean true if the credentials are correct
+     */
+    public function isPassword($password)
+    { 
+        if (!$this->hasPasswordBeenSet())
+        {
+            throw new ActiveRecordTraitException("Password field has not been set");
+        }
+
+        if (!password_verify($password, $this->password)) {
+            return false;
+        }
+
+        if (password_needs_rehash($this->password, TRAIT_PASSWORD_ENCRYPTION, ['cost' => TRAIT_PASSWORD_STRENTH])) {
+            $this->setPassword($password)->sync();
+        }
+
+        return true;
+    }
+
+    public function validatePassword($password) {
+        if (strlen($password) < TRAIT_PASSWORD_MIN_LENGTH) {
+            $message = sprintf('\'Password\' must be atleast %s characters long. %s characters provied.', TRAIT_PASSWORD_MIN_LENGTH, strlen($password));
+            return [false, $message];
+        }
+        return [true, ''];
+    }
+
+    /**
+     * Set the password.
+     *
+     * @param string $password
+     * @return $this
+     * @throws \Exception
+     */
+    public function setPassword($password)
+    {
+        [$status, $error] = $this->validatePassword($password);
+        if (!$status) {
+            throw new ActiveRecordTraitException($error);
+        }
+
+        $passwordHash = \password_hash($password, TRAIT_PASSWORD_ENCRYPTION, ['cost' => TRAIT_PASSWORD_STRENTH]);
+
+        if ($passwordHash === false) {
+            throw new ActiveRecordTraitException('\'Password\' hash failed.');
+        }
+
+        $this->password = $passwordHash;
+
+        return $this;
+    }
+
+    /**
+     * @return string The Hash of the password
+     */
+    public function getPasswordHash()
+    {
+        return $this->password;
+    }
+
+    /**
+     * Returns the currently set password token for the entity, or null if not set
+     * @return string|null The password reset token
+     */
+    public function getPasswordResetToken()
+    {
+        return $this->passwordResetToken;
+    }
+
+    /**
+     * Generates a new password reset token for the user
+     */
+    public function generatePasswordResetToken()
+    {
+        $this->passwordResetToken = md5(uniqid(mt_rand(), true));
+        return $this;
+    }
+
+    /**
+     * Clears the current password reset token
+     */
+    public function clearPasswordResetToken()
+    {
+        $this->passwordResetToken = null;
+        return $this;
+    }
 	
-	/**
-	 * @return void
-	 */
-	abstract protected function extendTableDefinition($columnName, $definition);
+    /**
+     * @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);
 
 }
\ No newline at end of file

src/Traits/Address.php

Indentation +170 added lines, -170 removed lines

@@ -12,181 +12,181 @@
 
 trait Address
 {
-	/** @var string the address line */
-	protected $address;
-
-	/** @var string the zipcode */
-	protected $zipcode;
-
-	/** @var string the city */
-	protected $city;
-
-	/** @var string the country */
-	protected $country;
-
-	/** @var string the state */
-	protected $state;
-
-	/**
-	 * Registers the Address trait on the including class
-	 * @return void
-	 */
-	protected function initAddress() 
-	{
-		$this->extendTableDefinition(TRAIT_ADDRESS_FIELD_ADDRESS, [
-			'value' => &$this->address,
-			'validate' => null,
-			'type' => 'VARCHAR',
-			'length' => 1024,
-			'properties' => null
-		]);
-
-		$this->extendTableDefinition(TRAIT_ADDRESS_FIELD_ZIPCODE, [
-			'value' => &$this->zipcode,
-			'validate' => null,
-			'type' => 'VARCHAR',
-			'length' => 1024,
-			'properties' => null
-		]);
-
-		$this->extendTableDefinition(TRAIT_ADDRESS_FIELD_CITY, [
-			'value' => &$this->city,
-			'validate' => null,
-			'type' => 'VARCHAR',
-			'length' => 1024,
-			'properties' => null
-		]);
-
-		$this->extendTableDefinition(TRAIT_ADDRESS_FIELD_COUNTRY, [
-			'value' => &$this->country,
-			'validate' => null,
-			'type' => 'VARCHAR',
-			'length' => 1024,
-			'properties' => null
-		]);
-
-		$this->extendTableDefinition(TRAIT_ADDRESS_FIELD_STATE, [
-			'value' => &$this->state,
-			'validate' => null,
-			'type' => 'VARCHAR',
-			'length' => 1024,
-			'properties' => null
-		]);
-
-		$this->address = null;
-		$this->zipcode = null;
-		$this->city = null;
-		$this->country = null;
-		$this->state = null;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getAddress()
-	{
-		return $this->address;
-	}
+    /** @var string the address line */
+    protected $address;
+
+    /** @var string the zipcode */
+    protected $zipcode;
+
+    /** @var string the city */
+    protected $city;
+
+    /** @var string the country */
+    protected $country;
+
+    /** @var string the state */
+    protected $state;
+
+    /**
+     * Registers the Address trait on the including class
+     * @return void
+     */
+    protected function initAddress() 
+    {
+        $this->extendTableDefinition(TRAIT_ADDRESS_FIELD_ADDRESS, [
+            'value' => &$this->address,
+            'validate' => null,
+            'type' => 'VARCHAR',
+            'length' => 1024,
+            'properties' => null
+        ]);
+
+        $this->extendTableDefinition(TRAIT_ADDRESS_FIELD_ZIPCODE, [
+            'value' => &$this->zipcode,
+            'validate' => null,
+            'type' => 'VARCHAR',
+            'length' => 1024,
+            'properties' => null
+        ]);
+
+        $this->extendTableDefinition(TRAIT_ADDRESS_FIELD_CITY, [
+            'value' => &$this->city,
+            'validate' => null,
+            'type' => 'VARCHAR',
+            'length' => 1024,
+            'properties' => null
+        ]);
+
+        $this->extendTableDefinition(TRAIT_ADDRESS_FIELD_COUNTRY, [
+            'value' => &$this->country,
+            'validate' => null,
+            'type' => 'VARCHAR',
+            'length' => 1024,
+            'properties' => null
+        ]);
+
+        $this->extendTableDefinition(TRAIT_ADDRESS_FIELD_STATE, [
+            'value' => &$this->state,
+            'validate' => null,
+            'type' => 'VARCHAR',
+            'length' => 1024,
+            'properties' => null
+        ]);
+
+        $this->address = null;
+        $this->zipcode = null;
+        $this->city = null;
+        $this->country = null;
+        $this->state = null;
+    }
+
+    /**
+     * @return string
+     */
+    public function getAddress()
+    {
+        return $this->address;
+    }
 	
-	/**
-	 * @param string $address
-	 */
-	public function setAddress($address)
-	{
-		$this->address = $address;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getZipcode()
-	{
-		return $this->zipcode;
-	}
+    /**
+     * @param string $address
+     */
+    public function setAddress($address)
+    {
+        $this->address = $address;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getZipcode()
+    {
+        return $this->zipcode;
+    }
 	
-	/**
-	 * @param string $zipcode
-	 */
-	public function setZipcode($zipcode)
-	{
-		$this->zipcode = $zipcode;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getCity()
-	{
-		return $this->city;
-	}
+    /**
+     * @param string $zipcode
+     */
+    public function setZipcode($zipcode)
+    {
+        $this->zipcode = $zipcode;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getCity()
+    {
+        return $this->city;
+    }
 	
-	/**
-	 * @param string $city
-	 */
-	public function setCity($city)
-	{
-		$this->city = $city;
-		return $this;
-	}
-
-	/**
-	 * @return string
-	 */
-	public function getCountry()
-	{
-		return $this->country;
-	}
+    /**
+     * @param string $city
+     */
+    public function setCity($city)
+    {
+        $this->city = $city;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getCountry()
+    {
+        return $this->country;
+    }
 	
-	/**
-	 * @param string $country
-	 */
-	public function setCountry($country)
-	{
-		$this->country = $country;
-		return $this;
-	}
-
-	public function getState()
-	{
-		return $this->state;
-	}
+    /**
+     * @param string $country
+     */
+    public function setCountry($country)
+    {
+        $this->country = $country;
+        return $this;
+    }
+
+    public function getState()
+    {
+        return $this->state;
+    }
 	
-	public function setState($state)
-	{
-		$this->state = $state;
-		return $this;
-	}
-
-	/**
-	 * @return void
-	 */
-	abstract protected function extendTableDefinition($columnName, $definition);
+    public function setState($state)
+    {
+        $this->state = $state;
+        return $this;
+    }
+
+    /**
+     * @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);
 	
 }
\ No newline at end of file

src/Traits/ManyToManyRelation.php

Indentation +104 added lines, -104 removed lines

@@ -9,110 +9,110 @@
 
 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 = SchemaBuilder::buildConstraint($leftParentTable, 'id', $childTable, $this->_leftColumnName);
-		$rightConstraint = SchemaBuilder::buildConstraint($rightParentTable, 'id', $childTable, $this->_rightColumnName);
-
-		$this->pdo->query($leftConstraint);
-		$this->pdo->query($rightConstraint);
-	}
-
-	/**
-	 * @return void
-	 */	
-	abstract public function getTableName();
-
-	/**
-	 * @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 = SchemaBuilder::buildConstraint($leftParentTable, 'id', $childTable, $this->_leftColumnName);
+        $rightConstraint = SchemaBuilder::buildConstraint($rightParentTable, 'id', $childTable, $this->_rightColumnName);
+
+        $this->pdo->query($leftConstraint);
+        $this->pdo->query($rightConstraint);
+    }
+
+    /**
+     * @return void
+     */	
+    abstract public function getTableName();
+
+    /**
+     * @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/AbstractActiveRecord.php

Indentation +484 added lines, -484 removed lines

@@ -18,489 +18,489 @@
  */
 abstract class AbstractActiveRecord implements ActiveRecordInterface
 {
-	const COLUMN_NAME_ID = 'id';
-	const COLUMN_TYPE_ID = 'INT UNSIGNED';
-
-	const CREATE = "CREATE";
-	const READ = "READ";
-	const UPDATE = "UPDATE";
-	const DELETE = "DELETE";
-	const SEARCH = "SEARCH";
-
-	/** @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 $createHooks;
-
-	/** @var array A map of column name to functions that hook the read function */
-	protected $readHooks;
-
-	/** @var array A map of column name to functions that hook the update function */
-	protected $updateHooks;
-
-	/** @var array A map of column name to functions that hook the update function */
-	protected $deleteHooks;	
-
-	/** @var array A map of column name to functions that hook the search function */
-	protected $searchHooks;
-
-	/** @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->createHooks = [];
-		$this->readHooks = [];
-		$this->updateHooks = [];
-		$this->deleteHooks = [];
-		$this->searchHooks = [];
-		$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);
-		}
-	}
-
-	public function registerHookOnAction($actionName, $columnName, $fn)
-	{
-		if (is_string($fn) && is_callable([$this, $fn])) {
-			$fn = [$this, $fn];
-		}
-
-		if (!is_callable($fn)) { 
-			throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0);
-		}
-
-		switch ($actionName) {
-			case self::CREATE:
-				$this->checkHookConstraints($columnName, $this->createHooks);
-				$this->createHooks[$columnName] = $fn;
-				break;
-			case self::READ:
-				$this->checkHookConstraints($columnName, $this->readHooks);
-				$this->readHooks[$columnName] = $fn;
-				break;
-			case self::UPDATE:
-				$this->checkHookConstraints($columnName, $this->updateHooks);
-				$this->updateHooks[$columnName] = $fn;
-				break;
-			case self::DELETE:
-				$this->checkHookConstraints($columnName, $this->deleteHooks);
-				$this->deleteHooks[$columnName] = $fn;
-				break;
-			case self::SEARCH:
-				$this->checkHookConstraints($columnName, $this->searchHooks);
-				$this->searchHooks[$columnName] = $fn;
-				break;
-			default:
-				throw new ActiveRecordException("Invalid action: Can not register hook on non-existing action");
-		}
-	}
-
-	/**
-	 * 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->registerHookOnAction(self::CREATE, $columnName, $fn);
-	}
-
-	/**
-	 * 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->registerHookOnAction(self::READ, $columnName, $fn);
-	}
-
-	/**
-	 * 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->registerHookOnAction(self::UPDATE, $columnName, $fn);
-	}
-
-	/**
-	 * 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->registerHookOnAction(self::DELETE, $columnName, $fn);
-	}
-
-	/**
-	 * 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->registerHookOnAction(self::SEARCH, $columnName, $fn);
-	}
-
-	/**
-	 * 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, has parent 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;
-	}
-
-	/**
-	 * Creates the entity as a table in the database
-	 */
-	public function createTable()
-	{
-		$this->pdo->query(SchemaBuilder::buildCreateTableSQL($this->getTableName(), $this->tableDefinition));
-	}
-
-	/**
-	 * 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 = SchemaBuilder::buildConstraint($target->getTableName(), 'id', $this->getTableName(), $colName);
-
-				$this->pdo->query($constraintSql);
-			} else if (isset($definition['relation'])) {
-				$msg = sprintf("Relation constraint on column \"%s\" of table \"%s\" does not contain a valid ActiveRecord instance", 
-					$colName,
-					$this->getTableName());
-				throw new ActiveRecordException($msg);
-			}
-		}
-	}
-
-	/**
-	 * 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;
-	}
-
-	protected function insertDefaults()
-	{
-		// Insert default values for not-null fields
-		foreach ($this->tableDefinition as $colName => $colDef) {
-			if ($colDef['value'] === null
-				&& ($colDef['properties'] ?? 0) & ColumnProperty::NOT_NULL
-				&& isset($colDef['default'])) {
-				$this->tableDefinition[$colName]['value'] = $colDef['default'];
-			}
-		}		
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function create()
-	{
-		foreach ($this->createHooks as $colName => $fn) {
-			$fn();
-		}
-
-		$this->insertDefaults();
-
-		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)
-	{
-		$whereConditions = [
-			Query::Equal('id', $id)
-		];
-		foreach ($this->readHooks as $colName => $fn) {
-			$cond = $fn();
-			if ($cond !== null) {
-				$whereConditions[] = $cond;
-			}
-		}
-
-		try {
-			$row = (new Query($this->getPdo(), $this->getTableName()))
-				->select()
-				->where(Query::AndArray($whereConditions))
-				->execute()
-				->fetch();
+    const COLUMN_NAME_ID = 'id';
+    const COLUMN_TYPE_ID = 'INT UNSIGNED';
+
+    const CREATE = "CREATE";
+    const READ = "READ";
+    const UPDATE = "UPDATE";
+    const DELETE = "DELETE";
+    const SEARCH = "SEARCH";
+
+    /** @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 $createHooks;
+
+    /** @var array A map of column name to functions that hook the read function */
+    protected $readHooks;
+
+    /** @var array A map of column name to functions that hook the update function */
+    protected $updateHooks;
+
+    /** @var array A map of column name to functions that hook the update function */
+    protected $deleteHooks;	
+
+    /** @var array A map of column name to functions that hook the search function */
+    protected $searchHooks;
+
+    /** @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->createHooks = [];
+        $this->readHooks = [];
+        $this->updateHooks = [];
+        $this->deleteHooks = [];
+        $this->searchHooks = [];
+        $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);
+        }
+    }
+
+    public function registerHookOnAction($actionName, $columnName, $fn)
+    {
+        if (is_string($fn) && is_callable([$this, $fn])) {
+            $fn = [$this, $fn];
+        }
+
+        if (!is_callable($fn)) { 
+            throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0);
+        }
+
+        switch ($actionName) {
+            case self::CREATE:
+                $this->checkHookConstraints($columnName, $this->createHooks);
+                $this->createHooks[$columnName] = $fn;
+                break;
+            case self::READ:
+                $this->checkHookConstraints($columnName, $this->readHooks);
+                $this->readHooks[$columnName] = $fn;
+                break;
+            case self::UPDATE:
+                $this->checkHookConstraints($columnName, $this->updateHooks);
+                $this->updateHooks[$columnName] = $fn;
+                break;
+            case self::DELETE:
+                $this->checkHookConstraints($columnName, $this->deleteHooks);
+                $this->deleteHooks[$columnName] = $fn;
+                break;
+            case self::SEARCH:
+                $this->checkHookConstraints($columnName, $this->searchHooks);
+                $this->searchHooks[$columnName] = $fn;
+                break;
+            default:
+                throw new ActiveRecordException("Invalid action: Can not register hook on non-existing action");
+        }
+    }
+
+    /**
+     * 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->registerHookOnAction(self::CREATE, $columnName, $fn);
+    }
+
+    /**
+     * 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->registerHookOnAction(self::READ, $columnName, $fn);
+    }
+
+    /**
+     * 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->registerHookOnAction(self::UPDATE, $columnName, $fn);
+    }
+
+    /**
+     * 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->registerHookOnAction(self::DELETE, $columnName, $fn);
+    }
+
+    /**
+     * 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->registerHookOnAction(self::SEARCH, $columnName, $fn);
+    }
+
+    /**
+     * 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, has parent 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;
+    }
+
+    /**
+     * Creates the entity as a table in the database
+     */
+    public function createTable()
+    {
+        $this->pdo->query(SchemaBuilder::buildCreateTableSQL($this->getTableName(), $this->tableDefinition));
+    }
+
+    /**
+     * 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 = SchemaBuilder::buildConstraint($target->getTableName(), 'id', $this->getTableName(), $colName);
+
+                $this->pdo->query($constraintSql);
+            } else if (isset($definition['relation'])) {
+                $msg = sprintf("Relation constraint on column \"%s\" of table \"%s\" does not contain a valid ActiveRecord instance", 
+                    $colName,
+                    $this->getTableName());
+                throw new ActiveRecordException($msg);
+            }
+        }
+    }
+
+    /**
+     * 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;
+    }
+
+    protected function insertDefaults()
+    {
+        // Insert default values for not-null fields
+        foreach ($this->tableDefinition as $colName => $colDef) {
+            if ($colDef['value'] === null
+                && ($colDef['properties'] ?? 0) & ColumnProperty::NOT_NULL
+                && isset($colDef['default'])) {
+                $this->tableDefinition[$colName]['value'] = $colDef['default'];
+            }
+        }		
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function create()
+    {
+        foreach ($this->createHooks as $colName => $fn) {
+            $fn();
+        }
+
+        $this->insertDefaults();
+
+        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)
+    {
+        $whereConditions = [
+            Query::Equal('id', $id)
+        ];
+        foreach ($this->readHooks as $colName => $fn) {
+            $cond = $fn();
+            if ($cond !== null) {
+                $whereConditions[] = $cond;
+            }
+        }
+
+        try {
+            $row = (new Query($this->getPdo(), $this->getTableName()))
+                ->select()
+                ->where(Query::AndArray($whereConditions))
+                ->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->updateHooks as $colName => $fn) {
-			$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->deleteHooks as $colName => $fn) {
-			$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->searchHooks as $column => $fn) {
-			if (!in_array($column, $ignoredTraits)) {
-				$clauses[] = $fn();
-			}
-		}
-
-		return new ActiveRecordQuery($this, $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 getFinalTableDefinition()
-	{
-		return $this->tableDefinition;
-	}
-
-	public function newInstance()
-	{
-		return new static($this->pdo);
-	}
-
-	/**
-	 * Returns the active record table.
-	 *
-	 * @return string the active record table name.
-	 */
-	abstract public function getTableName();
-
-	/**
-	 * Returns the active record columns.
-	 *
-	 * @return array the active record columns.
-	 */
-	abstract protected function getTableDefinition();
+            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->updateHooks as $colName => $fn) {
+            $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->deleteHooks as $colName => $fn) {
+            $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->searchHooks as $column => $fn) {
+            if (!in_array($column, $ignoredTraits)) {
+                $clauses[] = $fn();
+            }
+        }
+
+        return new ActiveRecordQuery($this, $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 getFinalTableDefinition()
+    {
+        return $this->tableDefinition;
+    }
+
+    public function newInstance()
+    {
+        return new static($this->pdo);
+    }
+
+    /**
+     * Returns the active record table.
+     *
+     * @return string the active record table name.
+     */
+    abstract public function getTableName();
+
+    /**
+     * Returns the active record columns.
+     *
+     * @return array the active record columns.
+     */
+    abstract protected function getTableDefinition();
 }