miBadger / miBadger.ActiveRecord

src/AbstractActiveRecord.php

Indentation +602 added lines, -602 removed lines

@@ -18,613 +18,613 @@
  */
 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 '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
-	 */
-	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) {
-				$tableName = $this->getTableName();
-				$msg = "Column \"$colName\" on table \"$tableName\": ";
-				$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 = sprintf("CREATE TABLE %s (\n%s\n);", 
-			$this->getTableName(), 
-			implode(",\n", $columnStatements));
-
-		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 '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
+     */
+    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) {
+                $tableName = $this->getTableName();
+                $msg = "Column \"$colName\" on table \"$tableName\": ";
+                $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 = sprintf("CREATE TABLE %s (\n%s\n);", 
+            $this->getTableName(), 
+            implode(",\n", $columnStatements));
+
+        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);
-			} 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;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function create()
-	{
-		foreach ($this->registeredCreateHooks as $colName => $fn) {
-			$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) {
-			$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) {
-			$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) {
-			$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);
+            } 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;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function create()
+    {
+        foreach ($this->registeredCreateHooks as $colName => $fn) {
+            $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) {
+            $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) {
+            $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) {
+            $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 +1 added lines, -1 removed lines

@@ -268,7 +268,7 @@
 		}
 
 		if ($default !== NULL) {
-			$stmnt .= ' DEFAULT ' . $default . ' ';
+			$stmnt .= ' DEFAULT '.$default.' ';
 		}
 
 		if ($properties & ColumnProperty::AUTO_INCREMENT) {

src/ActiveRecordQuery.php

Indentation +181 added lines, -181 removed lines

@@ -21,190 +21,190 @@
 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;
-
-	/**
-	 * Constructs a new Active Record Query
-	 */
-	public function __construct(AbstractActiveRecord $instance, $table, Array $additionalWhereClauses)
-	{
-		$this->table = $table;
-		$this->query = new Query($instance->getPdo(), $table);
-		$this->type = $instance;
-		$this->clauses = $additionalWhereClauses;
-		$this->results = null;
-	}
-
-	/**
-	 * Executes the query
-	 */
-	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;
-	}
-
-	/**
-	 * Returns an iterator for the result set
-	 * @return ArrayIterator
-	 */
-	public function getIterator()
-	{
-		return new \ArrayIterator($this->fetchAll());
-	}
-
-	/**
-	 * returns the result set of ActiveRecord instances for this query
-	 * @return Array
-	 */
-	public function fetchAll()
-	{
-		try {
-			if ($this->results === null) {
-				$this->execute();	
-			}
-
-			$entries = $this->results->fetchAll();
-			if ($entries === false) {
-				throw new ActiveRecordException(sprintf('Can not search non-existent entries 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);
-		}
-	}
-
-	/**
-	 * Fetch one record from the database
-	 * @return AbstractActiveRecord 
-	 */
-	public function fetch()
-	{
-		try {
-			if ($this->results === null) 
-			{
-				$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;
+
+    /**
+     * Constructs a new Active Record Query
+     */
+    public function __construct(AbstractActiveRecord $instance, $table, Array $additionalWhereClauses)
+    {
+        $this->table = $table;
+        $this->query = new Query($instance->getPdo(), $table);
+        $this->type = $instance;
+        $this->clauses = $additionalWhereClauses;
+        $this->results = null;
+    }
+
+    /**
+     * Executes the query
+     */
+    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;
+    }
+
+    /**
+     * Returns an iterator for the result set
+     * @return ArrayIterator
+     */
+    public function getIterator()
+    {
+        return new \ArrayIterator($this->fetchAll());
+    }
+
+    /**
+     * returns the result set of ActiveRecord instances for this query
+     * @return Array
+     */
+    public function fetchAll()
+    {
+        try {
+            if ($this->results === null) {
+                $this->execute();	
+            }
+
+            $entries = $this->results->fetchAll();
+            if ($entries === false) {
+                throw new ActiveRecordException(sprintf('Can not search non-existent entries 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);
+        }
+    }
+
+    /**
+     * Fetch one record from the database
+     * @return AbstractActiveRecord 
+     */
+    public function fetch()
+    {
+        try {
+            if ($this->results === null) 
+            {
+                $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;
+    }
 }