miBadger / miBadger.ActiveRecord

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(string $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(string $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(string $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(string $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;
+    }
 }

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(string $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(string $columnName, $definition);
 	
-	/**
-	 * @return void
-	 */
-	abstract protected function registerSearchHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerDeleteHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerUpdateHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerReadHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerCreateHook(string $columnName, $fn);
+    /**
+     * @return void
+     */
+    abstract protected function registerSearchHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerDeleteHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerUpdateHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerReadHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerCreateHook(string $columnName, $fn);
 	
 }
\ No newline at end of file

src/Traits/Datefields.php

Indentation +104 added lines, -104 removed lines

@@ -10,111 +10,111 @@
 
 trait Datefields
 {
-	/** @var string The timestamp representing the moment this record was created */
-	protected $created;
-
-	/** @var string The timestamp representing the moment this record was last updated */
-	protected $lastModified;
-
-	/**
-	 * this method is required to be called in the constructor for each class that uses this trait. 
-	 * It adds the datefields to the table definition and registers the callback hooks
-	 */
-	protected function initDatefields()
-	{
-		$this->extendTableDefinition(TRAIT_DATEFIELDS_CREATED, [
-			'value' => &$this->created,
-			'validate' => null,
-			'type' => 'DATETIME',
-			'properties' => ColumnProperty::NOT_NULL | ColumnProperty::IMMUTABLE
-		]);
-
-		$this->extendTableDefinition(TRAIT_DATEFIELDS_LAST_MODIFIED, [
-			'value' => &$this->lastModified,
-			'validate' => null,
-			'type' => 'DATETIME',
-			'properties' => ColumnProperty::NOT_NULL | ColumnProperty::IMMUTABLE
-		]);
+    /** @var string The timestamp representing the moment this record was created */
+    protected $created;
+
+    /** @var string The timestamp representing the moment this record was last updated */
+    protected $lastModified;
+
+    /**
+     * this method is required to be called in the constructor for each class that uses this trait. 
+     * It adds the datefields to the table definition and registers the callback hooks
+     */
+    protected function initDatefields()
+    {
+        $this->extendTableDefinition(TRAIT_DATEFIELDS_CREATED, [
+            'value' => &$this->created,
+            'validate' => null,
+            'type' => 'DATETIME',
+            'properties' => ColumnProperty::NOT_NULL | ColumnProperty::IMMUTABLE
+        ]);
+
+        $this->extendTableDefinition(TRAIT_DATEFIELDS_LAST_MODIFIED, [
+            'value' => &$this->lastModified,
+            'validate' => null,
+            'type' => 'DATETIME',
+            'properties' => ColumnProperty::NOT_NULL | ColumnProperty::IMMUTABLE
+        ]);
 		
-		$this->registerCreateHook(TRAIT_DATEFIELDS_CREATED, 'DatefieldsLastModifiedCreateHook');
-		$this->registerCreateHook(TRAIT_DATEFIELDS_LAST_MODIFIED, 'DatefieldsCreatedCreateHook');
-		$this->registerUpdateHook(TRAIT_DATEFIELDS_LAST_MODIFIED, 'DatefieldsUpdateHook');
-
-		$this->created = null;
-		$this->lastModified = null;
-	}
-
-	/**
-	 * The hook that gets called to set the last modified timestamp whenever a new record is created
-	 */
-	protected function DatefieldsLastModifiedCreateHook()
-	{
-		$this->lastModified = (new \DateTime('now'))->format('Y-m-d H:i:s');
-	}
-
-	/**
-	 * The hook that gets called to set the created timestamp whenever a new record is created
-	 */
-	protected function DatefieldsCreatedCreateHook()
-	{
-		$this->created = (new \DateTime('now'))->format('Y-m-d H:i:s');
-	}
-
-	/**
-	 * The hook that gets called to set the timestamp whenever a record gets updated
-	 */
-	protected function DatefieldsUpdateHook()
-	{
-		$this->lastModified = (new \DateTime('now'))->format('Y-m-d H:i:s');
-	}
-
-	/**
-	 * Returns the timestamp of last update for this record
-	 * @return \DateTime
-	 */
-	public function getLastModifiedDate()
-	{
-		return new \DateTime($this->lastModified);
-	}
-
-	/**
-	 * Returns the timestamp of when this record was created
-	 * @return \DateTime
-	 */
-	public function getCreationDate()
-	{
-		return new \DateTime($this->created);
-	}
-
-	/**
-	 * @return void
-	 */
-	abstract protected function extendTableDefinition(string $columnName, $definition);
+        $this->registerCreateHook(TRAIT_DATEFIELDS_CREATED, 'DatefieldsLastModifiedCreateHook');
+        $this->registerCreateHook(TRAIT_DATEFIELDS_LAST_MODIFIED, 'DatefieldsCreatedCreateHook');
+        $this->registerUpdateHook(TRAIT_DATEFIELDS_LAST_MODIFIED, 'DatefieldsUpdateHook');
+
+        $this->created = null;
+        $this->lastModified = null;
+    }
+
+    /**
+     * The hook that gets called to set the last modified timestamp whenever a new record is created
+     */
+    protected function DatefieldsLastModifiedCreateHook()
+    {
+        $this->lastModified = (new \DateTime('now'))->format('Y-m-d H:i:s');
+    }
+
+    /**
+     * The hook that gets called to set the created timestamp whenever a new record is created
+     */
+    protected function DatefieldsCreatedCreateHook()
+    {
+        $this->created = (new \DateTime('now'))->format('Y-m-d H:i:s');
+    }
+
+    /**
+     * The hook that gets called to set the timestamp whenever a record gets updated
+     */
+    protected function DatefieldsUpdateHook()
+    {
+        $this->lastModified = (new \DateTime('now'))->format('Y-m-d H:i:s');
+    }
+
+    /**
+     * Returns the timestamp of last update for this record
+     * @return \DateTime
+     */
+    public function getLastModifiedDate()
+    {
+        return new \DateTime($this->lastModified);
+    }
+
+    /**
+     * Returns the timestamp of when this record was created
+     * @return \DateTime
+     */
+    public function getCreationDate()
+    {
+        return new \DateTime($this->created);
+    }
+
+    /**
+     * @return void
+     */
+    abstract protected function extendTableDefinition(string $columnName, $definition);
 	
-	/**
-	 * @return void
-	 */
-	abstract protected function registerSearchHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerDeleteHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerUpdateHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerReadHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerCreateHook(string $columnName, $fn);
+    /**
+     * @return void
+     */
+    abstract protected function registerSearchHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerDeleteHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerUpdateHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerReadHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerCreateHook(string $columnName, $fn);
 }
 
-	
\ No newline at end of file
+    
\ No newline at end of file

src/Traits/AutoApi.php

Indentation +415 added lines, -415 removed lines

@@ -9,436 +9,436 @@
 
 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
-		];
-	}
-
-	/**
-	 * Performs a read call on the entity (modifying the current object) 
-	 * 	and returns a result array ($error, $data), with an optional error, and the results array (as filtered by the whitelist)
-	 * 	containing the loaded data.
-	 * 
-	 * @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 [$error, $result]
-	 * 				Where $error contains the error message (@TODO: & Error type?)
-	 * 				Where result is an associative array containing the data for this record, and the keys are a subset of $fieldWhitelist
-	 * 				
-	 */
-	public function apiRead($id, Array $fieldWhitelist = []): Array
-	{
-		try {
-			$this->read($id);	
-		} catch (ActiveRecordException $e) {
-			if ($e->getCode() === ActiveRecordException::NOT_FOUND) {
-				$err = [
-					'type' => 'invalid',
-					'message' => $e->getMessage()
-				];
-				return [$err, null];
-			}
-			throw $e;
-		}
-		return [null, $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
+        ];
+    }
+
+    /**
+     * Performs a read call on the entity (modifying the current object) 
+     * 	and returns a result array ($error, $data), with an optional error, and the results array (as filtered by the whitelist)
+     * 	containing the loaded data.
+     * 
+     * @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 [$error, $result]
+     * 				Where $error contains the error message (@TODO: & Error type?)
+     * 				Where result is an associative array containing the data for this record, and the keys are a subset of $fieldWhitelist
+     * 				
+     */
+    public function apiRead($id, Array $fieldWhitelist = []): Array
+    {
+        try {
+            $this->read($id);	
+        } catch (ActiveRecordException $e) {
+            if ($e->getCode() === ActiveRecordException::NOT_FOUND) {
+                $err = [
+                    'type' => 'invalid',
+                    'message' => $e->getMessage()
+                ];
+                return [$err, null];
+            }
+            throw $e;
+        }
+        return [null, $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] = [
-					'type' => 'unknown_field',
-					'message' => '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] = [
-					'type' => 'immutable',
-					'message' => 'Value 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] = [
-						'type' => 'invalid',
-						'message' => $message
-					];
-				}	
-			}
-
-			// Validation check 2: If relation column, check whether entity exists
-			$properties = $definition['properties'] ?? null;
-			if (isset($definition['relation'])
-				&& ($properties & ColumnProperty::NOT_NULL)) {
+    /**
+     * 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] = [
+                    'type' => 'unknown_field',
+                    'message' => '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] = [
+                    'type' => 'immutable',
+                    'message' => 'Value 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] = [
+                        'type' => 'invalid',
+                        'message' => $message
+                    ];
+                }	
+            }
+
+            // Validation check 2: If relation column, check whether entity exists
+            $properties = $definition['properties'] ?? null;
+            if (isset($definition['relation'])
+                && ($properties & ColumnProperty::NOT_NULL)) {
 				
-				try {
-					if ($definition['relation'] instanceof AbstractActiveRecord) {
-						$instance = $definition['relation'];
-					} else {
-						$instance = new $definition['relation']($this->pdo);	
-					}
-					$instance->read($input[$colName] ?? $definition['value'] ?? null);
-				} catch (ActiveRecordException $e) {
-					$errors[$colName] = [
-						'type' => 'invalid',
-						'message' => 'Entry for this value does not 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] = [
-					'type' => 'missing',
-					'message' => 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) {
-			// Skip if this table column does not appear in the input
-			if (!array_key_exists($colName, $input)) {
-				continue;
-			}
-
-			// Use setter if known, otherwise set value directly
-			$fn = $definition['setter'] ?? null;
-			if (is_callable($fn)) {
-				$fn($input[$colName]);
-			} else {
-				$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|null $id
-	 * @return $this
-	 */
-	abstract protected function setId(?int $id);
-
-	/**
-	 * Returns the ID.
-	 *
-	 * @return null|int The ID.
-	 */
-	abstract protected function getId();
-
-
-	/**
-	 * Returns the serialized form of the specified columns
-	 * 
-	 * @return Array
-	 */
-	abstract public function toArray(Array $fieldWhitelist);
-
-	/**
-	 * 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();
+                try {
+                    if ($definition['relation'] instanceof AbstractActiveRecord) {
+                        $instance = $definition['relation'];
+                    } else {
+                        $instance = new $definition['relation']($this->pdo);	
+                    }
+                    $instance->read($input[$colName] ?? $definition['value'] ?? null);
+                } catch (ActiveRecordException $e) {
+                    $errors[$colName] = [
+                        'type' => 'invalid',
+                        'message' => 'Entry for this value does not 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] = [
+                    'type' => 'missing',
+                    'message' => 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) {
+            // Skip if this table column does not appear in the input
+            if (!array_key_exists($colName, $input)) {
+                continue;
+            }
+
+            // Use setter if known, otherwise set value directly
+            $fn = $definition['setter'] ?? null;
+            if (is_callable($fn)) {
+                $fn($input[$colName]);
+            } else {
+                $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|null $id
+     * @return $this
+     */
+    abstract protected function setId(?int $id);
+
+    /**
+     * Returns the ID.
+     *
+     * @return null|int The ID.
+     */
+    abstract protected function getId();
+
+
+    /**
+     * Returns the serialized form of the specified columns
+     * 
+     * @return Array
+     */
+    abstract public function toArray(Array $fieldWhitelist);
+
+    /**
+     * 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(string $columnName, $definition);
+    public function setState($state)
+    {
+        $this->state = $state;
+        return $this;
+    }
+
+    /**
+     * @return void
+     */
+    abstract protected function extendTableDefinition(string $columnName, $definition);
 	
-	/**
-	 * @return void
-	 */
-	abstract protected function registerSearchHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerDeleteHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerUpdateHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerReadHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerCreateHook(string $columnName, $fn);
+    /**
+     * @return void
+     */
+    abstract protected function registerSearchHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerDeleteHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerUpdateHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerReadHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerCreateHook(string $columnName, $fn);
 	
 }
\ No newline at end of file

src/Traits/Password.php

Indentation +180 added lines, -180 removed lines

@@ -14,187 +14,187 @@
 
 trait Password
 {
-	/** @var string The password hash. */
-	protected $password;
-
-	/** @var string|null The password reset token. */
-	protected $passwordResetToken;
-
-	/** @var string|null The password expiry date */
-	protected $passwordExpiryDate;
-
-	/**
-	 * this method is required to be called in the constructor for each class that uses this trait. 
-	 * It adds the fields necessary for the passwords struct to the table definition
-	 */
-	protected function initPassword()
-	{
-		$this->extendTableDefinition(TRAIT_PASSWORD_FIELD_PASSWORD, [
-			'value' => &$this->password,
-			'validate' => [$this, 'validatePassword'],
-			'setter' => [$this, 'setPassword'],
-			'type' => 'VARCHAR',
-			'length' => 1024,
-			'properties' => null
-		]);
-
-		$this->extendTableDefinition(TRAIT_PASSWORD_FIELD_RESET_TOKEN, [
-			'value' => &$this->passwordResetToken,
-			'validate' => null,
-			'default' => 0,
-			'type' => 'VARCHAR',
-			'length' => 1024
-		]);
-
-		$this->extendTableDefinition(TRAIT_PASSWORD_FIELD_RESET_TOKEN_EXPIRY, [
-			'value' => &$this->passwordExpiryDate,
-			'validate' => null,
-			'type' => 'DATETIME',
-		]);
-	}
-
-
-	/**
-	 * Returns whether the users password has been set
-	 * @return boolean true if the user has a password
-	 */
-	public function hasPasswordBeenSet()
-	{
-		return $this->password !== null;
-	}
-
-	/**
-	 * Returns true if the credentials are correct.
-	 *
-	 * @param string $password
-	 * @return boolean true if the credentials are correct
-	 */
-	public function isPassword($password)
-	{ 
-		if (!$this->hasPasswordBeenSet())
-		{
-			throw new ActiveRecordTraitException("Password field has not been set");
-		}
-
-		if (!password_verify($password, $this->password)) {
-			return false;
-		}
-
-		if (password_needs_rehash($this->password, TRAIT_PASSWORD_ENCRYPTION, ['cost' => TRAIT_PASSWORD_STRENTH])) {
-			$this->setPassword($password)->sync();
-		}
-
-		return true;
-	}
-
-	public function validatePassword($password) {
-		if (strlen($password) < TRAIT_PASSWORD_MIN_LENGTH) {
-			$message = sprintf('\'Password\' must be atleast %s characters long. %s characters provided.', TRAIT_PASSWORD_MIN_LENGTH, strlen($password));
-			return [false, $message];
-		}
-		return [true, ''];
-	}
-
-	/**
-	 * Set the password.
-	 *
-	 * @param string $password
-	 * @return $this
-	 * @throws \Exception
-	 */
-	public function setPassword($password)
-	{
-		[$status, $error] = $this->validatePassword($password);
-		if (!$status) {
-			throw new ActiveRecordTraitException($error);
-		}
-
-		$passwordHash = \password_hash($password, TRAIT_PASSWORD_ENCRYPTION, ['cost' => TRAIT_PASSWORD_STRENTH]);
-
-		if ($passwordHash === false) {
-			throw new ActiveRecordTraitException('\'Password\' hash failed.');
-		}
-
-		$this->password = $passwordHash;
-
-		return $this;
-	}
-
-	/**
-	 * @return string The Hash of the password
-	 */
-	public function getPasswordHash()
-	{
-		return $this->password;
-	}
-
-	/**
-	 * Returns the currently set password token for the entity, or null if not set
-	 * @return string|null The password reset token
-	 */
-	public function getPasswordResetToken()
-	{
-		return $this->passwordResetToken;
-	}
-
-	/**
-	 * Generates a new password reset token for the user
-	 */
-	public function generatePasswordResetToken()
-	{
-		$this->passwordResetToken = md5(uniqid(mt_rand(), true));
-
-		$validityDuration = new \DateInterval('PT24H');
-
-		$this->passwordExpiryDate = (new \DateTime('now'))->add($validityDuration)->format('Y-m-d H:i:s');
-		return $this;
-	}
-
-	/**
-	 * Clears the current password reset token
-	 */
-	public function clearPasswordResetToken()
-	{
-		$this->passwordResetToken = null;
-		$this->passwordExpiryDate = null;
-		return $this;
-	}
-
-	public function validatePasswordResetToken(string $token)
-	{
-		return $this->passwordResetToken !== null
-			&& $token === $this->passwordResetToken
-			&& (new \DateTime('now')) < (new \DateTime($this->passwordExpiryDate));
-	}
+    /** @var string The password hash. */
+    protected $password;
+
+    /** @var string|null The password reset token. */
+    protected $passwordResetToken;
+
+    /** @var string|null The password expiry date */
+    protected $passwordExpiryDate;
+
+    /**
+     * this method is required to be called in the constructor for each class that uses this trait. 
+     * It adds the fields necessary for the passwords struct to the table definition
+     */
+    protected function initPassword()
+    {
+        $this->extendTableDefinition(TRAIT_PASSWORD_FIELD_PASSWORD, [
+            'value' => &$this->password,
+            'validate' => [$this, 'validatePassword'],
+            'setter' => [$this, 'setPassword'],
+            'type' => 'VARCHAR',
+            'length' => 1024,
+            'properties' => null
+        ]);
+
+        $this->extendTableDefinition(TRAIT_PASSWORD_FIELD_RESET_TOKEN, [
+            'value' => &$this->passwordResetToken,
+            'validate' => null,
+            'default' => 0,
+            'type' => 'VARCHAR',
+            'length' => 1024
+        ]);
+
+        $this->extendTableDefinition(TRAIT_PASSWORD_FIELD_RESET_TOKEN_EXPIRY, [
+            'value' => &$this->passwordExpiryDate,
+            'validate' => null,
+            'type' => 'DATETIME',
+        ]);
+    }
+
+
+    /**
+     * Returns whether the users password has been set
+     * @return boolean true if the user has a password
+     */
+    public function hasPasswordBeenSet()
+    {
+        return $this->password !== null;
+    }
+
+    /**
+     * Returns true if the credentials are correct.
+     *
+     * @param string $password
+     * @return boolean true if the credentials are correct
+     */
+    public function isPassword($password)
+    { 
+        if (!$this->hasPasswordBeenSet())
+        {
+            throw new ActiveRecordTraitException("Password field has not been set");
+        }
+
+        if (!password_verify($password, $this->password)) {
+            return false;
+        }
+
+        if (password_needs_rehash($this->password, TRAIT_PASSWORD_ENCRYPTION, ['cost' => TRAIT_PASSWORD_STRENTH])) {
+            $this->setPassword($password)->sync();
+        }
+
+        return true;
+    }
+
+    public function validatePassword($password) {
+        if (strlen($password) < TRAIT_PASSWORD_MIN_LENGTH) {
+            $message = sprintf('\'Password\' must be atleast %s characters long. %s characters provided.', TRAIT_PASSWORD_MIN_LENGTH, strlen($password));
+            return [false, $message];
+        }
+        return [true, ''];
+    }
+
+    /**
+     * Set the password.
+     *
+     * @param string $password
+     * @return $this
+     * @throws \Exception
+     */
+    public function setPassword($password)
+    {
+        [$status, $error] = $this->validatePassword($password);
+        if (!$status) {
+            throw new ActiveRecordTraitException($error);
+        }
+
+        $passwordHash = \password_hash($password, TRAIT_PASSWORD_ENCRYPTION, ['cost' => TRAIT_PASSWORD_STRENTH]);
+
+        if ($passwordHash === false) {
+            throw new ActiveRecordTraitException('\'Password\' hash failed.');
+        }
+
+        $this->password = $passwordHash;
+
+        return $this;
+    }
+
+    /**
+     * @return string The Hash of the password
+     */
+    public function getPasswordHash()
+    {
+        return $this->password;
+    }
+
+    /**
+     * Returns the currently set password token for the entity, or null if not set
+     * @return string|null The password reset token
+     */
+    public function getPasswordResetToken()
+    {
+        return $this->passwordResetToken;
+    }
+
+    /**
+     * Generates a new password reset token for the user
+     */
+    public function generatePasswordResetToken()
+    {
+        $this->passwordResetToken = md5(uniqid(mt_rand(), true));
+
+        $validityDuration = new \DateInterval('PT24H');
+
+        $this->passwordExpiryDate = (new \DateTime('now'))->add($validityDuration)->format('Y-m-d H:i:s');
+        return $this;
+    }
+
+    /**
+     * Clears the current password reset token
+     */
+    public function clearPasswordResetToken()
+    {
+        $this->passwordResetToken = null;
+        $this->passwordExpiryDate = null;
+        return $this;
+    }
+
+    public function validatePasswordResetToken(string $token)
+    {
+        return $this->passwordResetToken !== null
+            && $token === $this->passwordResetToken
+            && (new \DateTime('now')) < (new \DateTime($this->passwordExpiryDate));
+    }
 	
-	/**
-	 * @return void
-	 */
-	abstract protected function extendTableDefinition(string $columnName, $definition);
+    /**
+     * @return void
+     */
+    abstract protected function extendTableDefinition(string $columnName, $definition);
 	
-	/**
-	 * @return void
-	 */
-	abstract protected function registerSearchHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerDeleteHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerUpdateHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerReadHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerCreateHook(string $columnName, $fn);
+    /**
+     * @return void
+     */
+    abstract protected function registerSearchHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerDeleteHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerUpdateHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerReadHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerCreateHook(string $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::buildConstraintOnDeleteCascade($leftParentTable, 'id', $childTable, $this->_leftColumnName);
-		$rightConstraint = SchemaBuilder::buildConstraintOnDeleteCascade($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(string $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::buildConstraintOnDeleteCascade($leftParentTable, 'id', $childTable, $this->_leftColumnName);
+        $rightConstraint = SchemaBuilder::buildConstraintOnDeleteCascade($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(string $columnName, $definition);
 	
-	/**
-	 * @return void
-	 */
-	abstract protected function registerSearchHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerDeleteHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerUpdateHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerReadHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerCreateHook(string $columnName, $fn);
+    /**
+     * @return void
+     */
+    abstract protected function registerSearchHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerDeleteHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerUpdateHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerReadHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerCreateHook(string $columnName, $fn);
 
 }

src/AbstractActiveRecord.php

Indentation +666 added lines, -666 removed lines

@@ -18,672 +18,672 @@
  */
 abstract class AbstractActiveRecord implements ActiveRecordInterface
 {
-	const COLUMN_NAME_ID = 'id';
-	const COLUMN_TYPE_ID = 'INT UNSIGNED';
-
-	const CREATE = 'CREATE';
-	const READ = 'READ';
-	const UPDATE = 'UPDATE';
-	const DELETE = 'DELETE';
-	const SEARCH = 'SEARCH';
-
-	/** @var \PDO The PDO object. */
-	protected $pdo;
-
-	/** @var null|int The ID. */
-	private $id;
-
-	/** @var array A map of column name to functions that hook the insert function */
-	protected $createHooks;
-
-	/** @var array A map of column name to functions that hook the read function */
-	protected $readHooks;
-
-	/** @var array A map of column name to functions that hook the update function */
-	protected $updateHooks;
-
-	/** @var array A map of column name to functions that hook the update function */
-	protected $deleteHooks;	
-
-	/** @var array A map of column name to functions that hook the search function */
-	protected $searchHooks;
-
-	/** @var array A list of table column definitions */
-	protected $tableDefinition;
-
-	/**
-	 * Construct an abstract active record with the given PDO.
-	 *
-	 * @param \PDO $pdo
-	 */
-	public function __construct(\PDO $pdo)
-	{
-		$pdo->setAttribute(\PDO::ATTR_DEFAULT_FETCH_MODE, \PDO::FETCH_ASSOC);
-		$pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);
-
-		$this->setPdo($pdo);
-
-		$this->createHooks = [];
-		$this->readHooks = [];
-		$this->updateHooks = [];
-		$this->deleteHooks = [];
-		$this->searchHooks = [];
-		$this->tableDefinition = $this->getTableDefinition();
-
-		// Extend table definition with default ID field, throw exception if field already exists
-		if (array_key_exists('id', $this->tableDefinition)) {
-			$message = "Table definition in record contains a field with name \"id\"";
-			$message .= ", which is a reserved name by ActiveRecord";
-			throw new ActiveRecordException($message, 0);
-		}
-
-		$this->tableDefinition[self::COLUMN_NAME_ID] =
-		[
-			'value' => &$this->id,
-			'validate' => null,
-			'type' => self::COLUMN_TYPE_ID,
-			'properties' =>
-				ColumnProperty::NOT_NULL
-				| ColumnProperty::IMMUTABLE
-				| ColumnProperty::AUTO_INCREMENT
-				| ColumnProperty::PRIMARY_KEY
-		];
-	}
-
-	/**
-	 * Verifies whether a column already has an entry in the specified hook map. If so, throws.
-	 * @param string $columnName The column name for which to verify the hook constraints
-	 * @param Array $hookMap The associative map of hooks to be verifie
-	 */
-	private function checkHookConstraints(string $columnName, Array $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);
-		}
-	}
-
-
-	/**
-	 * Registers a hook to be called on one of the following actions
-	 * 		[CREATE, READ, UPDATE, DELETE, SEARCH]
-	 * @param string $actionName The name of the action to register for
-	 * @param string $columnName The columnName for which to register this action
-	 * @param callable|string $fn The function name to call, or a callable function
-	 */
-	public function registerHookOnAction(string $actionName, string $columnName, $fn)
-	{
-		if (is_string($fn) && is_callable([$this, $fn])) {
-			$fn = [$this, $fn];
-		}
-
-		if (!is_callable($fn)) { 
-			throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0);
-		}
-
-		switch ($actionName) {
-			case self::CREATE:
-				$this->checkHookConstraints($columnName, $this->createHooks);
-				$this->createHooks[$columnName] = $fn;
-				break;
-			case self::READ:
-				$this->checkHookConstraints($columnName, $this->readHooks);
-				$this->readHooks[$columnName] = $fn;
-				break;
-			case self::UPDATE:
-				$this->checkHookConstraints($columnName, $this->updateHooks);
-				$this->updateHooks[$columnName] = $fn;
-				break;
-			case self::DELETE:
-				$this->checkHookConstraints($columnName, $this->deleteHooks);
-				$this->deleteHooks[$columnName] = $fn;
-				break;
-			case self::SEARCH:
-				$this->checkHookConstraints($columnName, $this->searchHooks);
-				$this->searchHooks[$columnName] = $fn;
-				break;
-			default:
-				throw new ActiveRecordException("Invalid action: Can not register hook on non-existing action");
-		}
-	}
-
-	/**
-	 * Register a new hook for a specific column that gets called before execution of the create() method
-	 * Only one hook per column can be registered at a time
-	 * @param string $columnName The name of the column that is registered.
-	 * @param string|callable $fn Either a callable, or the name of a method on the inheriting object.
-	 */
-	public function registerCreateHook(string $columnName, $fn)
-	{
-		$this->registerHookOnAction(self::CREATE, $columnName, $fn);
-	}
-
-	/**
-	 * Register a new hook for a specific column that gets called before execution of the read() method
-	 * Only one hook per column can be registered at a time
-	 * @param string $columnName The name of the column that is registered.
-	 * @param string|callable $fn Either a callable, or the name of a method on the inheriting object.
-	 */
-	public function registerReadHook(string $columnName, $fn)
-	{
-		$this->registerHookOnAction(self::READ, $columnName, $fn);
-	}
-
-	/**
-	 * Register a new hook for a specific column that gets called before execution of the update() method
-	 * Only one hook per column can be registered at a time
-	 * @param string $columnName The name of the column that is registered.
-	 * @param string|callable $fn Either a callable, or the name of a method on the inheriting object.
-	 */
-	public function registerUpdateHook(string $columnName, $fn)
-	{
-		$this->registerHookOnAction(self::UPDATE, $columnName, $fn);
-	}
-
-	/**
-	 * Register a new hook for a specific column that gets called before execution of the delete() method
-	 * Only one hook per column can be registered at a time
-	 * @param string $columnName The name of the column that is registered.
-	 * @param string|callable $fn Either a callable, or the name of a method on the inheriting object.
-	 */
-	public function registerDeleteHook(string $columnName, $fn)
-	{
-		$this->registerHookOnAction(self::DELETE, $columnName, $fn);
-	}
-
-	/**
-	 * Register a new hook for a specific column that gets called before execution of the search() method
-	 * Only one hook per column can be registered at a time
-	 * @param string $columnName The name of the column that is registered.
-	 * @param string|callable $fn Either a callable, or the name of a method on the inheriting object. The callable is required to take one argument: an instance of miBadger\Query\Query; 
-	 */
-	public function registerSearchHook(string $columnName, $fn)
-	{
-		$this->registerHookOnAction(self::SEARCH, $columnName, $fn);
-	}
-
-	/**
-	 * Adds a new column definition to the table.
-	 * @param string $columnName The name of the column that is registered.
-	 * @param Array $definition The definition of that column.
-	 */
-	protected function extendTableDefinition(string $columnName, $definition)
-	{
-		if ($this->tableDefinition === null) {
-			throw new ActiveRecordException("tableDefinition is null, has parent been initialized in constructor?");
-		}
-
-		// Enforcing table can only be extended with new columns
-		if (array_key_exists($columnName, $this->tableDefinition)) {
-			$message = "Table is being extended with a column that already exists, ";
-			$message .= "\"$columnName\" conflicts with your table definition";
-			throw new ActiveRecordException($message, 0);
-		}
-
-		$this->tableDefinition[$columnName] = $definition;
-	}
-
-	/**
-	 * Checks whether the provided column name is registered in the table definition
-	 * @param string $column The column name
-	 */
-	public function hasColumn(string $column): bool {
-		return array_key_exists($column, $this->tableDefinition);
-	}
-
-	/**
-	 * Checks whether the column has a relation onto the provided record table
-	 * @param string $column The column name
-	 * @param ActiveRecordInterface $record The record to check the relation on
-	 */
-	public function hasRelation(string $column, ActiveRecordInterface $record): bool {
-		if (!$this->hasColumn($column)) {
-			throw new ActiveRecordException("Provided column \"$column\" does not exist in table definition", 0);
-		}
-
-		if (!isset($this->tableDefinition[$column]['relation'])) {
-			return false;
-		}
-
-		$relation = $this->tableDefinition[$column]['relation'];
-		if ($relation instanceof AbstractActiveRecord) {
-			// Injected object
-			return get_class($record) === get_class($relation);
-		} else {
-			// :: class definition
-			return get_class($record) === $relation;
-		}
-	}
-
-
-	/**
-	 * Checks whether the property Exists for an instance of t
-	 * @param string $column The column name
-	 * @param int $property The ColumnProperty enum value
-	 */
-	public function hasProperty(string $column, $property): bool {
-		if (!$this->hasColumn($column)) {
-			throw new ActiveRecordException("Provided column \"$column\" does not exist in table definition", 0);
-		}
-
-		try {
-			$enumValue = ColumnProperty::valueOf($property);
-		} catch (\UnexpectedValueException $e) {
-			throw new ActiveRecordException("Provided property \"$property\" is not a valid property", 0, $e);
-		}
-
-		$properties = $this->tableDefinition[$column]['properties'] ?? null;
-
-		return $properties !== null && (($properties & $enumValue->getValue()) > 0);
-	}
-	/**
-	 * @param $column string The column name
-	 */
-	public function getColumnType(string $column): string {
-		if (!$this->hasColumn($column)) {
-			throw new ActiveRecordException("Provided column \"$column\" does not exist in table definition", 0);
-		}
-
-		return $this->tableDefinition[$column]['type'] ?? null;
-	}
-
-	/**
-	 * Returns the default value on a column
-	 * @param $column string The column name
-	 */
-	public function getColumnLength(string $column): ?int {
-		if (!$this->hasColumn($column)) {
-			throw new ActiveRecordException("Provided column \"$column\" does not exist in table definition", 0);
-		}
-
-		return $this->tableDefinition[$column]['length'] ?? null;
-	}
-
-	/**
-	 * Returns the default value on a column
-	 * @param $column string The column name
-	 */
-	public function getDefault(string $column) {
-		if (!$this->hasColumn($column)) {
-			throw new ActiveRecordException("Provided column \"$column\" does not exist in table definition", 0);
-		}
-
-		return $this->tableDefinition[$column]['default'] ?? null;
-	}
-
-	/**
-	 * Validates that the column matches the input constraints & passes the validator function
-	 * @param $column string The column name
-	 */
-	public function validateColumn(string $column, $input) {
-		if (!$this->hasColumn($column)) {
-			throw new ActiveRecordException("Provided column \"$column\" does not exist in table definition", 0);
-		}
-
-		$fn = $this->tableDefinition[$column]['validate'] ?? null;
-
-		if ($fn === null) {
-			return [true, ''];
-		}
-
-		if (!is_callable($fn)) {
-			throw new ActiveRecordException("Provided validation function is not callable", 0);
-		}
-
-		return $fn($input);
-	}
-
-	/**
-	 * Useful for writing unit tests of models against ActiveRecord: 
-	 * overrides a relation column with a relation onto a mock object.
-	 * @param string $column the name of the column onto which to place the mock relation
-	 * @param object $mock the instance of a mock object to palce onto the model.
-	 */
-	public function injectInstanceOnRelation(string $column, $mock) {
-		if (!$this->hasColumn($column)) {
-			throw new ActiveRecordException("Provided column \"$column\" does not exist in table definition", 0);
-		}
-
-		$this->tableDefinition[$column]['relation'] = $mock;
-	}
-
-	/**
-	 * Creates the entity as a table in the database
-	 */
-	public function createTable()
-	{
-		$this->pdo->query(SchemaBuilder::buildCreateTableSQL($this->getTableName(), $this->tableDefinition));
-	}
-
-	/**
-	 * Iterates over the specified constraints in the table definition, 
-	 * 		and applies these to the database.
-	 */
-	public function createTableConstraints()
-	{
-		// Iterate over columns, check whether "relation" field exists, if so create constraint
-		foreach ($this->tableDefinition as $colName => $definition) {
-			if (!isset($definition['relation'])) {
-				continue;
-			}
-
-			$relation = $definition['relation'];
-			$properties = $definition['properties'] ?? 0;
+    const COLUMN_NAME_ID = 'id';
+    const COLUMN_TYPE_ID = 'INT UNSIGNED';
+
+    const CREATE = 'CREATE';
+    const READ = 'READ';
+    const UPDATE = 'UPDATE';
+    const DELETE = 'DELETE';
+    const SEARCH = 'SEARCH';
+
+    /** @var \PDO The PDO object. */
+    protected $pdo;
+
+    /** @var null|int The ID. */
+    private $id;
+
+    /** @var array A map of column name to functions that hook the insert function */
+    protected $createHooks;
+
+    /** @var array A map of column name to functions that hook the read function */
+    protected $readHooks;
+
+    /** @var array A map of column name to functions that hook the update function */
+    protected $updateHooks;
+
+    /** @var array A map of column name to functions that hook the update function */
+    protected $deleteHooks;	
+
+    /** @var array A map of column name to functions that hook the search function */
+    protected $searchHooks;
+
+    /** @var array A list of table column definitions */
+    protected $tableDefinition;
+
+    /**
+     * Construct an abstract active record with the given PDO.
+     *
+     * @param \PDO $pdo
+     */
+    public function __construct(\PDO $pdo)
+    {
+        $pdo->setAttribute(\PDO::ATTR_DEFAULT_FETCH_MODE, \PDO::FETCH_ASSOC);
+        $pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);
+
+        $this->setPdo($pdo);
+
+        $this->createHooks = [];
+        $this->readHooks = [];
+        $this->updateHooks = [];
+        $this->deleteHooks = [];
+        $this->searchHooks = [];
+        $this->tableDefinition = $this->getTableDefinition();
+
+        // Extend table definition with default ID field, throw exception if field already exists
+        if (array_key_exists('id', $this->tableDefinition)) {
+            $message = "Table definition in record contains a field with name \"id\"";
+            $message .= ", which is a reserved name by ActiveRecord";
+            throw new ActiveRecordException($message, 0);
+        }
+
+        $this->tableDefinition[self::COLUMN_NAME_ID] =
+        [
+            'value' => &$this->id,
+            'validate' => null,
+            'type' => self::COLUMN_TYPE_ID,
+            'properties' =>
+                ColumnProperty::NOT_NULL
+                | ColumnProperty::IMMUTABLE
+                | ColumnProperty::AUTO_INCREMENT
+                | ColumnProperty::PRIMARY_KEY
+        ];
+    }
+
+    /**
+     * Verifies whether a column already has an entry in the specified hook map. If so, throws.
+     * @param string $columnName The column name for which to verify the hook constraints
+     * @param Array $hookMap The associative map of hooks to be verifie
+     */
+    private function checkHookConstraints(string $columnName, Array $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);
+        }
+    }
+
+
+    /**
+     * Registers a hook to be called on one of the following actions
+     * 		[CREATE, READ, UPDATE, DELETE, SEARCH]
+     * @param string $actionName The name of the action to register for
+     * @param string $columnName The columnName for which to register this action
+     * @param callable|string $fn The function name to call, or a callable function
+     */
+    public function registerHookOnAction(string $actionName, string $columnName, $fn)
+    {
+        if (is_string($fn) && is_callable([$this, $fn])) {
+            $fn = [$this, $fn];
+        }
+
+        if (!is_callable($fn)) { 
+            throw new ActiveRecordException("Provided hook on column \"$columnName\" is not callable", 0);
+        }
+
+        switch ($actionName) {
+            case self::CREATE:
+                $this->checkHookConstraints($columnName, $this->createHooks);
+                $this->createHooks[$columnName] = $fn;
+                break;
+            case self::READ:
+                $this->checkHookConstraints($columnName, $this->readHooks);
+                $this->readHooks[$columnName] = $fn;
+                break;
+            case self::UPDATE:
+                $this->checkHookConstraints($columnName, $this->updateHooks);
+                $this->updateHooks[$columnName] = $fn;
+                break;
+            case self::DELETE:
+                $this->checkHookConstraints($columnName, $this->deleteHooks);
+                $this->deleteHooks[$columnName] = $fn;
+                break;
+            case self::SEARCH:
+                $this->checkHookConstraints($columnName, $this->searchHooks);
+                $this->searchHooks[$columnName] = $fn;
+                break;
+            default:
+                throw new ActiveRecordException("Invalid action: Can not register hook on non-existing action");
+        }
+    }
+
+    /**
+     * Register a new hook for a specific column that gets called before execution of the create() method
+     * Only one hook per column can be registered at a time
+     * @param string $columnName The name of the column that is registered.
+     * @param string|callable $fn Either a callable, or the name of a method on the inheriting object.
+     */
+    public function registerCreateHook(string $columnName, $fn)
+    {
+        $this->registerHookOnAction(self::CREATE, $columnName, $fn);
+    }
+
+    /**
+     * Register a new hook for a specific column that gets called before execution of the read() method
+     * Only one hook per column can be registered at a time
+     * @param string $columnName The name of the column that is registered.
+     * @param string|callable $fn Either a callable, or the name of a method on the inheriting object.
+     */
+    public function registerReadHook(string $columnName, $fn)
+    {
+        $this->registerHookOnAction(self::READ, $columnName, $fn);
+    }
+
+    /**
+     * Register a new hook for a specific column that gets called before execution of the update() method
+     * Only one hook per column can be registered at a time
+     * @param string $columnName The name of the column that is registered.
+     * @param string|callable $fn Either a callable, or the name of a method on the inheriting object.
+     */
+    public function registerUpdateHook(string $columnName, $fn)
+    {
+        $this->registerHookOnAction(self::UPDATE, $columnName, $fn);
+    }
+
+    /**
+     * Register a new hook for a specific column that gets called before execution of the delete() method
+     * Only one hook per column can be registered at a time
+     * @param string $columnName The name of the column that is registered.
+     * @param string|callable $fn Either a callable, or the name of a method on the inheriting object.
+     */
+    public function registerDeleteHook(string $columnName, $fn)
+    {
+        $this->registerHookOnAction(self::DELETE, $columnName, $fn);
+    }
+
+    /**
+     * Register a new hook for a specific column that gets called before execution of the search() method
+     * Only one hook per column can be registered at a time
+     * @param string $columnName The name of the column that is registered.
+     * @param string|callable $fn Either a callable, or the name of a method on the inheriting object. The callable is required to take one argument: an instance of miBadger\Query\Query; 
+     */
+    public function registerSearchHook(string $columnName, $fn)
+    {
+        $this->registerHookOnAction(self::SEARCH, $columnName, $fn);
+    }
+
+    /**
+     * Adds a new column definition to the table.
+     * @param string $columnName The name of the column that is registered.
+     * @param Array $definition The definition of that column.
+     */
+    protected function extendTableDefinition(string $columnName, $definition)
+    {
+        if ($this->tableDefinition === null) {
+            throw new ActiveRecordException("tableDefinition is null, has parent been initialized in constructor?");
+        }
+
+        // Enforcing table can only be extended with new columns
+        if (array_key_exists($columnName, $this->tableDefinition)) {
+            $message = "Table is being extended with a column that already exists, ";
+            $message .= "\"$columnName\" conflicts with your table definition";
+            throw new ActiveRecordException($message, 0);
+        }
+
+        $this->tableDefinition[$columnName] = $definition;
+    }
+
+    /**
+     * Checks whether the provided column name is registered in the table definition
+     * @param string $column The column name
+     */
+    public function hasColumn(string $column): bool {
+        return array_key_exists($column, $this->tableDefinition);
+    }
+
+    /**
+     * Checks whether the column has a relation onto the provided record table
+     * @param string $column The column name
+     * @param ActiveRecordInterface $record The record to check the relation on
+     */
+    public function hasRelation(string $column, ActiveRecordInterface $record): bool {
+        if (!$this->hasColumn($column)) {
+            throw new ActiveRecordException("Provided column \"$column\" does not exist in table definition", 0);
+        }
+
+        if (!isset($this->tableDefinition[$column]['relation'])) {
+            return false;
+        }
+
+        $relation = $this->tableDefinition[$column]['relation'];
+        if ($relation instanceof AbstractActiveRecord) {
+            // Injected object
+            return get_class($record) === get_class($relation);
+        } else {
+            // :: class definition
+            return get_class($record) === $relation;
+        }
+    }
+
+
+    /**
+     * Checks whether the property Exists for an instance of t
+     * @param string $column The column name
+     * @param int $property The ColumnProperty enum value
+     */
+    public function hasProperty(string $column, $property): bool {
+        if (!$this->hasColumn($column)) {
+            throw new ActiveRecordException("Provided column \"$column\" does not exist in table definition", 0);
+        }
+
+        try {
+            $enumValue = ColumnProperty::valueOf($property);
+        } catch (\UnexpectedValueException $e) {
+            throw new ActiveRecordException("Provided property \"$property\" is not a valid property", 0, $e);
+        }
+
+        $properties = $this->tableDefinition[$column]['properties'] ?? null;
+
+        return $properties !== null && (($properties & $enumValue->getValue()) > 0);
+    }
+    /**
+     * @param $column string The column name
+     */
+    public function getColumnType(string $column): string {
+        if (!$this->hasColumn($column)) {
+            throw new ActiveRecordException("Provided column \"$column\" does not exist in table definition", 0);
+        }
+
+        return $this->tableDefinition[$column]['type'] ?? null;
+    }
+
+    /**
+     * Returns the default value on a column
+     * @param $column string The column name
+     */
+    public function getColumnLength(string $column): ?int {
+        if (!$this->hasColumn($column)) {
+            throw new ActiveRecordException("Provided column \"$column\" does not exist in table definition", 0);
+        }
+
+        return $this->tableDefinition[$column]['length'] ?? null;
+    }
+
+    /**
+     * Returns the default value on a column
+     * @param $column string The column name
+     */
+    public function getDefault(string $column) {
+        if (!$this->hasColumn($column)) {
+            throw new ActiveRecordException("Provided column \"$column\" does not exist in table definition", 0);
+        }
+
+        return $this->tableDefinition[$column]['default'] ?? null;
+    }
+
+    /**
+     * Validates that the column matches the input constraints & passes the validator function
+     * @param $column string The column name
+     */
+    public function validateColumn(string $column, $input) {
+        if (!$this->hasColumn($column)) {
+            throw new ActiveRecordException("Provided column \"$column\" does not exist in table definition", 0);
+        }
+
+        $fn = $this->tableDefinition[$column]['validate'] ?? null;
+
+        if ($fn === null) {
+            return [true, ''];
+        }
+
+        if (!is_callable($fn)) {
+            throw new ActiveRecordException("Provided validation function is not callable", 0);
+        }
+
+        return $fn($input);
+    }
+
+    /**
+     * Useful for writing unit tests of models against ActiveRecord: 
+     * overrides a relation column with a relation onto a mock object.
+     * @param string $column the name of the column onto which to place the mock relation
+     * @param object $mock the instance of a mock object to palce onto the model.
+     */
+    public function injectInstanceOnRelation(string $column, $mock) {
+        if (!$this->hasColumn($column)) {
+            throw new ActiveRecordException("Provided column \"$column\" does not exist in table definition", 0);
+        }
+
+        $this->tableDefinition[$column]['relation'] = $mock;
+    }
+
+    /**
+     * Creates the entity as a table in the database
+     */
+    public function createTable()
+    {
+        $this->pdo->query(SchemaBuilder::buildCreateTableSQL($this->getTableName(), $this->tableDefinition));
+    }
+
+    /**
+     * Iterates over the specified constraints in the table definition, 
+     * 		and applies these to the database.
+     */
+    public function createTableConstraints()
+    {
+        // Iterate over columns, check whether "relation" field exists, if so create constraint
+        foreach ($this->tableDefinition as $colName => $definition) {
+            if (!isset($definition['relation'])) {
+                continue;
+            }
+
+            $relation = $definition['relation'];
+            $properties = $definition['properties'] ?? 0;
 			
-			if (is_string($relation) 
-				&& class_exists($relation) 
-				&& new $relation($this->pdo) instanceof AbstractActiveRecord) {
-				// ::class relation in tableDefinition
-				$target = new $definition['relation']($this->pdo);
-			}
-			else if ($relation instanceof AbstractActiveRecord) {
-				throw new ActiveRecordException(sprintf(
-					"Relation constraint on column \"%s\" of table \"%s\" can not be built from relation instance, use %s::class in table definition instead",
-					$colName,
-					$this->getTableName(),
-					get_class($relation)
-				));
-			}
-			else {
-				// Invalid class
-				throw new ActiveRecordException(sprintf(
-					"Relation constraint on column \"%s\" of table \"%s\" does not contain a valid ActiveRecord instance", 
-					$colName,
-					$this->getTableName()));
-			}
-
-			// Add new relation constraint on database
-			if ($properties & ColumnProperty::NOT_NULL) {
-				$constraintSql = SchemaBuilder::buildConstraintOnDeleteCascade($target->getTableName(), 'id', $this->getTableName(), $colName);
-			} else {
-				$constraintSql = SchemaBuilder::buildConstraintOnDeleteSetNull($target->getTableName(), 'id', $this->getTableName(), $colName);
-			}
-			$this->pdo->query($constraintSql);
-		}
-	}
-
-	/**
-	 * Returns the name -> variable mapping for the table definition.
-	 * @return Array The mapping
-	 */
-	protected function getActiveRecordColumns()
-	{
-		$bindings = [];
-		foreach ($this->tableDefinition as $colName => $definition) {
-
-			// Ignore the id column (key) when inserting or updating
-			if ($colName == self::COLUMN_NAME_ID) {
-				continue;
-			}
-
-			$bindings[$colName] = &$definition['value'];
-		}
-		return $bindings;
-	}
-
-	/**
-	 * Inserts the default values for columns that have a non-null specification
-	 * 	and a registered default value
-	 */
-	protected function insertDefaults()
-	{
-		// Insert default values for not-null fields
-		foreach ($this->tableDefinition as $colName => $colDef) {
-			if ($colDef['value'] === null
-				&& ($colDef['properties'] ?? 0) & ColumnProperty::NOT_NULL
-				&& isset($colDef['default'])) {
-				$this->tableDefinition[$colName]['value'] = $colDef['default'];
-			}
-		}		
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function create()
-	{
-		foreach ($this->createHooks as $colName => $fn) {
-			$fn();
-		}
-
-		$this->insertDefaults();
-
-		try {
-			(new Query($this->getPdo(), $this->getTableName()))
-				->insert($this->getActiveRecordColumns())
-				->execute();
-
-			$this->setId(intval($this->getPdo()->lastInsertId()));
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), ActiveRecordException::DB_ERROR, $e);
-		}
-
-		return $this;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function read($id)
-	{
-		$whereConditions = [
-			Query::Equal('id', $id)
-		];
-		foreach ($this->readHooks as $colName => $fn) {
-			$cond = $fn();
-			if ($cond !== null) {
-				$whereConditions[] = $cond;
-			}
-		}
-
-		try {
-			$row = (new Query($this->getPdo(), $this->getTableName()))
-				->select()
-				->where(Query::AndArray($whereConditions))
-				->execute()
-				->fetch();
+            if (is_string($relation) 
+                && class_exists($relation) 
+                && new $relation($this->pdo) instanceof AbstractActiveRecord) {
+                // ::class relation in tableDefinition
+                $target = new $definition['relation']($this->pdo);
+            }
+            else if ($relation instanceof AbstractActiveRecord) {
+                throw new ActiveRecordException(sprintf(
+                    "Relation constraint on column \"%s\" of table \"%s\" can not be built from relation instance, use %s::class in table definition instead",
+                    $colName,
+                    $this->getTableName(),
+                    get_class($relation)
+                ));
+            }
+            else {
+                // Invalid class
+                throw new ActiveRecordException(sprintf(
+                    "Relation constraint on column \"%s\" of table \"%s\" does not contain a valid ActiveRecord instance", 
+                    $colName,
+                    $this->getTableName()));
+            }
+
+            // Add new relation constraint on database
+            if ($properties & ColumnProperty::NOT_NULL) {
+                $constraintSql = SchemaBuilder::buildConstraintOnDeleteCascade($target->getTableName(), 'id', $this->getTableName(), $colName);
+            } else {
+                $constraintSql = SchemaBuilder::buildConstraintOnDeleteSetNull($target->getTableName(), 'id', $this->getTableName(), $colName);
+            }
+            $this->pdo->query($constraintSql);
+        }
+    }
+
+    /**
+     * Returns the name -> variable mapping for the table definition.
+     * @return Array The mapping
+     */
+    protected function getActiveRecordColumns()
+    {
+        $bindings = [];
+        foreach ($this->tableDefinition as $colName => $definition) {
+
+            // Ignore the id column (key) when inserting or updating
+            if ($colName == self::COLUMN_NAME_ID) {
+                continue;
+            }
+
+            $bindings[$colName] = &$definition['value'];
+        }
+        return $bindings;
+    }
+
+    /**
+     * Inserts the default values for columns that have a non-null specification
+     * 	and a registered default value
+     */
+    protected function insertDefaults()
+    {
+        // Insert default values for not-null fields
+        foreach ($this->tableDefinition as $colName => $colDef) {
+            if ($colDef['value'] === null
+                && ($colDef['properties'] ?? 0) & ColumnProperty::NOT_NULL
+                && isset($colDef['default'])) {
+                $this->tableDefinition[$colName]['value'] = $colDef['default'];
+            }
+        }		
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function create()
+    {
+        foreach ($this->createHooks as $colName => $fn) {
+            $fn();
+        }
+
+        $this->insertDefaults();
+
+        try {
+            (new Query($this->getPdo(), $this->getTableName()))
+                ->insert($this->getActiveRecordColumns())
+                ->execute();
+
+            $this->setId(intval($this->getPdo()->lastInsertId()));
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), ActiveRecordException::DB_ERROR, $e);
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function read($id)
+    {
+        $whereConditions = [
+            Query::Equal('id', $id)
+        ];
+        foreach ($this->readHooks as $colName => $fn) {
+            $cond = $fn();
+            if ($cond !== null) {
+                $whereConditions[] = $cond;
+            }
+        }
+
+        try {
+            $row = (new Query($this->getPdo(), $this->getTableName()))
+                ->select()
+                ->where(Query::AndArray($whereConditions))
+                ->execute()
+                ->fetch();
 			
-			if ($row === false) {
-				$msg = sprintf('Can not read the non-existent active record entry %d from the `%s` table.', $id, $this->getTableName());
-				throw new ActiveRecordException($msg, ActiveRecordException::NOT_FOUND);
-			}
-
-			$this->fill($row)->setId($id);
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), ActiveRecordException::DB_ERROR, $e);
-		}
-
-		return $this;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function update()
-	{
-		foreach ($this->updateHooks as $colName => $fn) {
-			$fn();
-		}
-
-		try {
-			(new Query($this->getPdo(), $this->getTableName()))
-				->update($this->getActiveRecordColumns())
-				->where(Query::Equal('id', $this->getId()))
-				->execute();
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), ActiveRecordException::DB_ERROR, $e);
-		}
-
-		return $this;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function delete()
-	{
-		foreach ($this->deleteHooks as $colName => $fn) {
-			$fn();
-		}
-
-		try {
-			(new Query($this->getPdo(), $this->getTableName()))
-				->delete()
-				->where(Query::Equal('id', $this->getId()))
-				->execute();
-
-			$this->setId(null);
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), ActiveRecordException::DB_ERROR, $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;
-	}
-
-	/**
-	 * Returns the serialized form of the specified columns
-	 * 
-	 * @return Array
-	 */
-	public function toArray(Array $fieldWhitelist)
-	{
-		$output = [];
-		foreach ($this->tableDefinition as $colName => $definition) {
-			if (in_array($colName, $fieldWhitelist)) {
-				$output[$colName] = $definition['value'];
-			}
-		}
-
-		return $output;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function search(array $ignoredTraits = [])
-	{
-		$clauses = [];
-		foreach ($this->searchHooks as $column => $fn) {
-			if (!in_array($column, $ignoredTraits)) {
-				$clauses[] = $fn();
-			}
-		}
-
-		return new ActiveRecordQuery($this, $clauses);
-	}
-
-	/**
-	 * Returns the PDO.
-	 *
-	 * @return \PDO the PDO.
-	 */
-	public function getPdo()
-	{
-		return $this->pdo;
-	}
-
-	/**
-	 * Set the PDO.
-	 *
-	 * @param \PDO $pdo
-	 * @return $this
-	 */
-	protected function setPdo($pdo)
-	{
-		$this->pdo = $pdo;
-
-		return $this;
-	}
-
-	/**
-	 * Returns the ID.
-	 *
-	 * @return null|int The ID.
-	 */
-	public function getId(): ?int
-	{
-		return $this->id;
-	}
-
-	/**
-	 * Set the ID.
-	 *
-	 * @param int|null $id
-	 * @return $this
-	 */
-	protected function setId(?int $id)
-	{
-		$this->id = $id;
-
-		return $this;
-	}
-
-	public function getFinalTableDefinition()
-	{
-		return $this->tableDefinition;
-	}
-
-	public function newInstance()
-	{
-		return new static($this->pdo);
-	}
-
-	/**
-	 * Returns the active record table.
-	 *
-	 * @return string the active record table name.
-	 */
-	abstract public function getTableName(): string;
-
-	/**
-	 * Returns the active record columns.
-	 *
-	 * @return array the active record columns.
-	 */
-	abstract protected function getTableDefinition(): Array;
+            if ($row === false) {
+                $msg = sprintf('Can not read the non-existent active record entry %d from the `%s` table.', $id, $this->getTableName());
+                throw new ActiveRecordException($msg, ActiveRecordException::NOT_FOUND);
+            }
+
+            $this->fill($row)->setId($id);
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), ActiveRecordException::DB_ERROR, $e);
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function update()
+    {
+        foreach ($this->updateHooks as $colName => $fn) {
+            $fn();
+        }
+
+        try {
+            (new Query($this->getPdo(), $this->getTableName()))
+                ->update($this->getActiveRecordColumns())
+                ->where(Query::Equal('id', $this->getId()))
+                ->execute();
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), ActiveRecordException::DB_ERROR, $e);
+        }
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function delete()
+    {
+        foreach ($this->deleteHooks as $colName => $fn) {
+            $fn();
+        }
+
+        try {
+            (new Query($this->getPdo(), $this->getTableName()))
+                ->delete()
+                ->where(Query::Equal('id', $this->getId()))
+                ->execute();
+
+            $this->setId(null);
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), ActiveRecordException::DB_ERROR, $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;
+    }
+
+    /**
+     * Returns the serialized form of the specified columns
+     * 
+     * @return Array
+     */
+    public function toArray(Array $fieldWhitelist)
+    {
+        $output = [];
+        foreach ($this->tableDefinition as $colName => $definition) {
+            if (in_array($colName, $fieldWhitelist)) {
+                $output[$colName] = $definition['value'];
+            }
+        }
+
+        return $output;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function search(array $ignoredTraits = [])
+    {
+        $clauses = [];
+        foreach ($this->searchHooks as $column => $fn) {
+            if (!in_array($column, $ignoredTraits)) {
+                $clauses[] = $fn();
+            }
+        }
+
+        return new ActiveRecordQuery($this, $clauses);
+    }
+
+    /**
+     * Returns the PDO.
+     *
+     * @return \PDO the PDO.
+     */
+    public function getPdo()
+    {
+        return $this->pdo;
+    }
+
+    /**
+     * Set the PDO.
+     *
+     * @param \PDO $pdo
+     * @return $this
+     */
+    protected function setPdo($pdo)
+    {
+        $this->pdo = $pdo;
+
+        return $this;
+    }
+
+    /**
+     * Returns the ID.
+     *
+     * @return null|int The ID.
+     */
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    /**
+     * Set the ID.
+     *
+     * @param int|null $id
+     * @return $this
+     */
+    protected function setId(?int $id)
+    {
+        $this->id = $id;
+
+        return $this;
+    }
+
+    public function getFinalTableDefinition()
+    {
+        return $this->tableDefinition;
+    }
+
+    public function newInstance()
+    {
+        return new static($this->pdo);
+    }
+
+    /**
+     * Returns the active record table.
+     *
+     * @return string the active record table name.
+     */
+    abstract public function getTableName(): string;
+
+    /**
+     * Returns the active record columns.
+     *
+     * @return array the active record columns.
+     */
+    abstract protected function getTableDefinition(): Array;
 }

src/ActiveRecordInterface.php

Indentation +66 added lines, -66 removed lines

@@ -19,79 +19,79 @@
 interface ActiveRecordInterface
 {
 
-	public function __construct(\PDO $pdo);
+    public function __construct(\PDO $pdo);
 	
-	/**
-	 * Returns the ID of the record.
-	 *
-	 * @return null|int The ID.
-	 */	
-	public function getId(): ?int;
+    /**
+     * Returns the ID of the record.
+     *
+     * @return null|int The ID.
+     */	
+    public function getId(): ?int;
 
-	/**
-	 * 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);
 }