miBadger / miBadger.ActiveRecord

src/ColumnProperty.php

Indentation +6 added lines, -6 removed lines

@@ -5,10 +5,10 @@
 
 class ColumnProperty
 {
-	const NONE = 0;
-	const UNIQUE = 1;
-	const NOT_NULL = 2;
-	const IMMUTABLE = 4;
-	const AUTO_INCREMENT = 8;
-	const PRIMARY_KEY = 16;
+    const NONE = 0;
+    const UNIQUE = 1;
+    const NOT_NULL = 2;
+    const IMMUTABLE = 4;
+    const AUTO_INCREMENT = 8;
+    const PRIMARY_KEY = 16;
 }
\ No newline at end of file

test-bootstrap.php

Spacing +2 added lines, -2 removed lines

@@ -9,7 +9,7 @@ 
 // Cleanup SQL
 $user_delete = "DROP USER IF EXISTS $dbuser@'localhost'; ";
 $database_delete = "DROP DATABASE IF EXISTS $dbname; ";
-$sql_cleanup = $user_delete . $database_delete;
+$sql_cleanup = $user_delete.$database_delete;
 
 // Setup SQL
 $db_create = "CREATE DATABASE $dbname; ";
@@ -17,7 +17,7 @@ 
 $user_alter = "ALTER USER '$dbuser'@'localhost' IDENTIFIED with mysql_native_password BY '$dbpass'; ";
 $user_grant = "GRANT ALL PRIVILEGES ON *.* TO '$dbuser'@'localhost';";
 
-$sql_setup = $sql_cleanup . $db_create . $user_create . $user_alter . $user_grant;
+$sql_setup = $sql_cleanup.$db_create.$user_create.$user_alter.$user_grant;
 print $sql_setup;
 echo "Please enter mysql root password to set up a database environment for testing\n";
 exec("echo \"$sql_setup\" | mysql -u root -p");

src/ActiveRecordInterface.php

Indentation +60 added lines, -60 removed lines

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

src/Traits/SoftDelete.php

Indentation +104 added lines, -104 removed lines

@@ -9,111 +9,111 @@
 
 trait SoftDelete
 {
-	/** @var boolean the soft delete status for the entity this trait is embedded into. */
-	protected $softDelete;
-
-	/**
-	 * this method is required to be called in the constructor for each class that uses this trait. 
-	 * It adds the required fields to the table definition and registers hooks
-	 */
-	protected function initSoftDelete()
-	{
-		$this->softDelete = false;
-
-		$this->extendTableDefinition(TRAIT_SOFT_DELETE_FIELD_KEY, [
-			'value' => &$this->softDelete,
-			'validate' => null,
-			'default' => 0,
-			'type' => 'INT',
-			'length' => 1,
-			'properties' => ColumnProperty::NOT_NULL
-		]);
-
-		$this->registerSearchHook(TRAIT_SOFT_DELETE_FIELD_KEY, 'softDeleteSearchHook');
-		$this->registerReadHook(TRAIT_SOFT_DELETE_FIELD_KEY, 'softDeleteReadHook');
-	}
-
-	/**
-	 * The hook that gets called whenever a query is made
-	 */
-	protected function softDeleteSearchHook()
-	{
-		return Query::Equal(TRAIT_SOFT_DELETE_FIELD_KEY, 0);
-	}
-
-	protected function softDeleteReadHook()
-	{
-		return Query::Equal(TRAIT_SOFT_DELETE_FIELD_KEY, 0);
-	}
-
-	/**
-	 * returns the name for the soft delete field in the database
-	 * @return string
-	 */
-	public function getSoftDeleteFieldName()
-	{
-		return TRAIT_SOFT_DELETE_FIELD_KEY;
-	}
+    /** @var boolean the soft delete status for the entity this trait is embedded into. */
+    protected $softDelete;
+
+    /**
+     * this method is required to be called in the constructor for each class that uses this trait. 
+     * It adds the required fields to the table definition and registers hooks
+     */
+    protected function initSoftDelete()
+    {
+        $this->softDelete = false;
+
+        $this->extendTableDefinition(TRAIT_SOFT_DELETE_FIELD_KEY, [
+            'value' => &$this->softDelete,
+            'validate' => null,
+            'default' => 0,
+            'type' => 'INT',
+            'length' => 1,
+            'properties' => ColumnProperty::NOT_NULL
+        ]);
+
+        $this->registerSearchHook(TRAIT_SOFT_DELETE_FIELD_KEY, 'softDeleteSearchHook');
+        $this->registerReadHook(TRAIT_SOFT_DELETE_FIELD_KEY, 'softDeleteReadHook');
+    }
+
+    /**
+     * The hook that gets called whenever a query is made
+     */
+    protected function softDeleteSearchHook()
+    {
+        return Query::Equal(TRAIT_SOFT_DELETE_FIELD_KEY, 0);
+    }
+
+    protected function softDeleteReadHook()
+    {
+        return Query::Equal(TRAIT_SOFT_DELETE_FIELD_KEY, 0);
+    }
+
+    /**
+     * returns the name for the soft delete field in the database
+     * @return string
+     */
+    public function getSoftDeleteFieldName()
+    {
+        return TRAIT_SOFT_DELETE_FIELD_KEY;
+    }
 	
-	/**
-	 * Mark the current record as soft deleted
-	 * @return $this
-	 */
-	public function softDelete()
-	{
-		$this->softDelete = true;
-		$this->update();
-		return $this;
-	}
-
-	/**
-	 * Undo the current soft deletion status (mark it as non-soft deleted)
-	 * @return $this
-	 */
-	public function softRestore()
-	{
-		$this->softDelete = false;
-		$this->update();
-		return $this;
-	}
-
-	/**
-	 * returns the current soft deletion status
-	 * @return $this
-	 */
-	public function getDeletionStatus() 
-	{
-		return $this->softDelete;
-	}
-
-	/**
-	 * @return void
-	 */
-	abstract protected function extendTableDefinition($columnName, $definition);
+    /**
+     * Mark the current record as soft deleted
+     * @return $this
+     */
+    public function softDelete()
+    {
+        $this->softDelete = true;
+        $this->update();
+        return $this;
+    }
+
+    /**
+     * Undo the current soft deletion status (mark it as non-soft deleted)
+     * @return $this
+     */
+    public function softRestore()
+    {
+        $this->softDelete = false;
+        $this->update();
+        return $this;
+    }
+
+    /**
+     * returns the current soft deletion status
+     * @return $this
+     */
+    public function getDeletionStatus() 
+    {
+        return $this->softDelete;
+    }
+
+    /**
+     * @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/SchemaBuilder.php

Spacing +1 added lines, -1 removed lines

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

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) DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;", 
-			$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) DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;", 
+            $tableName, 
+            implode(",\n", $columnStatements));
+
+        return $sql;
+    }
 
 }

src/Traits/AutoApi.php

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);

Indentation +375 added lines, -375 removed lines

@@ -9,395 +9,395 @@
 
 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
-	 * 
-	 * @return Array an associative array containing the query parameters, and a data field containing an array of search results (associative arrays indexed by the keys in $fieldWhitelist)
-	 */
-	public function apiSearch(Array $queryParams, Array $fieldWhitelist, ?QueryExpression $whereClause = null, int $maxResultLimit = 100): Array
-	{
-		$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
+     * 
+     * @return Array an associative array containing the query parameters, and a data field containing an array of search results (associative arrays indexed by the keys in $fieldWhitelist)
+     */
+    public function apiSearch(Array $queryParams, Array $fieldWhitelist, ?QueryExpression $whereClause = null, int $maxResultLimit = 100): Array
+    {
+        $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;
-	}
-
-	/**
-	 * @param string|int $id the id of the current entity
-	 * @param Array $fieldWhitelist an array of fields that are allowed to appear in the output
-	 * 
-	 * @param Array An associative array containing the data for this record, 
-	 * 				where the keys are entries in $fieldWhitelist
-	 */
-	public function apiRead($id, Array $fieldWhitelist): Array
-	{
-		// @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;
+    }
+
+    /**
+     * @param string|int $id the id of the current entity
+     * @param Array $fieldWhitelist an array of fields that are allowed to appear in the output
+     * 
+     * @param Array An associative array containing the data for this record, 
+     * 				where the keys are entries in $fieldWhitelist
+     */
+    public function apiRead($id, Array $fieldWhitelist): Array
+    {
+        // @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();
 }

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/ActiveRecordQuery.php

Indentation +266 added lines, -266 removed lines

@@ -20,276 +20,276 @@
  */
 class ActiveRecordQuery implements \IteratorAggregate
 {
-	private $instance;
+    private $instance;
 
-	private $query;
+    private $query;
 
-	private $type;
+    private $type;
 
-	private $clauses = [];
+    private $clauses = [];
 
-	private $maxresultCount;
+    private $maxresultCount;
 
-	private $results;
+    private $results;
 	
-	private $whereExpression = null;
-
-	private $limit;
-
-	private $offset;
-
-	private $orderBy;
-
-	private $orderDirection;
-
-	/**
-	 * Constructs a new Active Record Query
-	 */
-	public function __construct(AbstractActiveRecord $instance, Array $additionalWhereClauses)
-	{
-		$this->instance = $instance;
-		$this->query = new Query($instance->getPdo(), $instance->getTableName());
-		$this->type = $instance;
-		$this->clauses = $additionalWhereClauses;
-		$this->maxResultCount = null;
-		$this->results = null;
-		$this->limit = null;
-		$this->offset = null;
-	}
-
-	private function getWhereCondition()
-	{
-		$clauses = $this->clauses;
-
-		// Optionally add user concatenated where expression
-		if ($this->whereExpression !== null) {
-			$clauses[] = $this->whereExpression;
-		}
-
-		// Construct where clause
-		if (count($clauses) > 0) {
-			return Query::AndArray($clauses);
-		}
-		return null;
-	}
-
-	/**
-	 * Executes the query
-	 */
-	public function execute()
-	{
-		$whereCondition = $this->getWhereCondition();
-		if ($whereCondition !== null) {
-			$this->query->where($whereCondition);
-		}
-
-		$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) {
-				return [];
-			}
-
-			$typedResults = [];
-			foreach ($entries as $entry) {
-				$typedEntry = $this->type->newInstance();
-				$typedEntry->fill($entry);
-				$typedResults[] = $typedEntry;
-			}
-
-			return $typedResults;
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), 0, $e);
-		}
-	}
-
-	public function fetchAllAsArray($readWhitelist)
-	{
-		$data = $this->fetchAll();
-		$output = [];
-		foreach ($data as $entry) {
-			$output[] = $entry->toArray($readWhitelist);
-		}
-		return $output;
-	}
-
-	/**
-	 * 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) {
-				return null;
-			}
-
-			$typedResult->fill($entry);
-
-			return $typedResult;
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), 0, $e);
-		}
-	}
-
-	/**
-	 * Fetch one record from the database and format it as an associative array, 
-	 * 	 filtered by the entries in $readwhitelist
-	 * @param Array $readWhitelist Array of whitelisted database column keys to be returned in the result
-	 * @return Array|Null
-	 */
-	public function fetchAsArray($readWhitelist)
-	{
-		$res = $this->fetch();
-		if ($res !== null) {
-			return $res->toArray($readWhitelist);
-		}
-		return null;
-	}
-
-	public function countMaxResults()
-	{
-		if ($this->maxResultCount === null) {
-			$query = new Query($this->instance->getPdo(), $this->instance->getTableName());
-			$query->select(['count(*) as count'], false);
-
-			$whereCondition = $this->getWhereCondition();
-			if ($whereCondition !== null) {
-				$query->where($whereCondition);
-			}
-
-			$this->maxResultCount = $query->execute()->fetch()['count'];
-		}
-		return $this->maxResultCount;
-	}
-
-	public function getNumberOfPages()
-	{
-		if ($this->limit === null) {
-			return 1;
-		}
-
-		if ($this->limit === 0) {
-			return 0;
-		}
-
-		$resultCount = $this->countMaxResults();
-		if ($resultCount % $this->limit > 0) {
-			return (int) floor($resultCount / $this->limit) + 1;
-		}
-		return (int) floor($resultCount / $this->limit);
-	}
-
-	public function getCurrentPage()
-	{
-		if ($this->offset === null || $this->offset === 0) {
-			return 1;
-		}
-
-		if ($this->limit === null || $this->limit === 0) {
-			return 1;
-		}
-
-		return (int) floor($this->offset / $this->limit);
-	}
-
-	/**
-	 * 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->limit = $limit;
-		$this->query->limit($limit);
-		return $this;
-	}
-
-	/**
-	 * Set the offset.
-	 *
-	 * @param mixed $offset
- 	 * @return $this
-	 */
-	public function offset($offset)
-	{
-		$this->offset = $offset;
-		$this->query->offset($offset);
-		return $this;
-	}
+    private $whereExpression = null;
+
+    private $limit;
+
+    private $offset;
+
+    private $orderBy;
+
+    private $orderDirection;
+
+    /**
+     * Constructs a new Active Record Query
+     */
+    public function __construct(AbstractActiveRecord $instance, Array $additionalWhereClauses)
+    {
+        $this->instance = $instance;
+        $this->query = new Query($instance->getPdo(), $instance->getTableName());
+        $this->type = $instance;
+        $this->clauses = $additionalWhereClauses;
+        $this->maxResultCount = null;
+        $this->results = null;
+        $this->limit = null;
+        $this->offset = null;
+    }
+
+    private function getWhereCondition()
+    {
+        $clauses = $this->clauses;
+
+        // Optionally add user concatenated where expression
+        if ($this->whereExpression !== null) {
+            $clauses[] = $this->whereExpression;
+        }
+
+        // Construct where clause
+        if (count($clauses) > 0) {
+            return Query::AndArray($clauses);
+        }
+        return null;
+    }
+
+    /**
+     * Executes the query
+     */
+    public function execute()
+    {
+        $whereCondition = $this->getWhereCondition();
+        if ($whereCondition !== null) {
+            $this->query->where($whereCondition);
+        }
+
+        $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) {
+                return [];
+            }
+
+            $typedResults = [];
+            foreach ($entries as $entry) {
+                $typedEntry = $this->type->newInstance();
+                $typedEntry->fill($entry);
+                $typedResults[] = $typedEntry;
+            }
+
+            return $typedResults;
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), 0, $e);
+        }
+    }
+
+    public function fetchAllAsArray($readWhitelist)
+    {
+        $data = $this->fetchAll();
+        $output = [];
+        foreach ($data as $entry) {
+            $output[] = $entry->toArray($readWhitelist);
+        }
+        return $output;
+    }
+
+    /**
+     * 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) {
+                return null;
+            }
+
+            $typedResult->fill($entry);
+
+            return $typedResult;
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), 0, $e);
+        }
+    }
+
+    /**
+     * Fetch one record from the database and format it as an associative array, 
+     * 	 filtered by the entries in $readwhitelist
+     * @param Array $readWhitelist Array of whitelisted database column keys to be returned in the result
+     * @return Array|Null
+     */
+    public function fetchAsArray($readWhitelist)
+    {
+        $res = $this->fetch();
+        if ($res !== null) {
+            return $res->toArray($readWhitelist);
+        }
+        return null;
+    }
+
+    public function countMaxResults()
+    {
+        if ($this->maxResultCount === null) {
+            $query = new Query($this->instance->getPdo(), $this->instance->getTableName());
+            $query->select(['count(*) as count'], false);
+
+            $whereCondition = $this->getWhereCondition();
+            if ($whereCondition !== null) {
+                $query->where($whereCondition);
+            }
+
+            $this->maxResultCount = $query->execute()->fetch()['count'];
+        }
+        return $this->maxResultCount;
+    }
+
+    public function getNumberOfPages()
+    {
+        if ($this->limit === null) {
+            return 1;
+        }
+
+        if ($this->limit === 0) {
+            return 0;
+        }
+
+        $resultCount = $this->countMaxResults();
+        if ($resultCount % $this->limit > 0) {
+            return (int) floor($resultCount / $this->limit) + 1;
+        }
+        return (int) floor($resultCount / $this->limit);
+    }
+
+    public function getCurrentPage()
+    {
+        if ($this->offset === null || $this->offset === 0) {
+            return 1;
+        }
+
+        if ($this->limit === null || $this->limit === 0) {
+            return 1;
+        }
+
+        return (int) floor($this->offset / $this->limit);
+    }
+
+    /**
+     * 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->limit = $limit;
+        $this->query->limit($limit);
+        return $this;
+    }
+
+    /**
+     * Set the offset.
+     *
+     * @param mixed $offset
+     * @return $this
+     */
+    public function offset($offset)
+    {
+        $this->offset = $offset;
+        $this->query->offset($offset);
+        return $this;
+    }
 }