miBadger / miBadger.ActiveRecord

src/ActiveRecordInterface.php

Indentation +71 added lines, -71 removed lines

@@ -19,83 +19,83 @@
  */
 interface ActiveRecordInterface
 {
-	/**
-	 * 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 this record after filling it with the attributes of the first entry with the given where and order by clauses.
-	 *
-	 * @param array $where = []
-	 * @param array $orderBy = []
-	 * @return $this
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function searchOne(array $where = [], array $orderBy = []);
+    /**
+     * Returns this record after filling it with the attributes of the first entry with the given where and order by clauses.
+     *
+     * @param array $where = []
+     * @param array $orderBy = []
+     * @return $this
+     * @throws ActiveRecordException on failure.
+     */
+    public function searchOne(array $where = [], array $orderBy = []);
 
-	/**
-	 * Returns the records with the given where, order by, limit and offset clauses.
-	 *
-	 * @param array $where = []
-	 * @param array $orderBy = []
-	 * @param int $limit = -1
-	 * @param int $offset = 0
-	 * @return static[] the records with the given where, order by, limit and offset clauses.
-	 * @throws ActiveRecordException on failure.
-	 */
-	public function search(array $where = [], array $orderBy = [], $limit = -1, $offset = 0);
+    /**
+     * Returns the records with the given where, order by, limit and offset clauses.
+     *
+     * @param array $where = []
+     * @param array $orderBy = []
+     * @param int $limit = -1
+     * @param int $offset = 0
+     * @return static[] the records with the given where, order by, limit and offset clauses.
+     * @throws ActiveRecordException on failure.
+     */
+    public function search(array $where = [], array $orderBy = [], $limit = -1, $offset = 0);
 }

src/Traits/Address.php

Unused Use Statements -2 removed lines

@@ -2,8 +2,6 @@
 
 namespace miBadger\ActiveRecord\Traits;
 
-use miBadger\ActiveRecord\ColumnProperty;
-
 const TRAIT_ADDRESS_FIELD_ADDRESS = "address_address";
 const TRAIT_ADDRESS_FIELD_ZIPCODE = "address_zipcode";
 const TRAIT_ADDRESS_FIELD_CITY = "address_city";

Indentation +89 added lines, -89 removed lines

@@ -11,104 +11,104 @@
 
 trait Address
 {
-	protected $address;
-
-	protected $zipcode;
-
-	protected $city;
-
-	protected $country;
-
-	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->address = null;
-		$this->zipcode = null;
-		$this->city = null;
-		$this->country = null;
-	}
-
-	public function getAddress()
-	{
-		return $this->address;
-	}
+    protected $address;
+
+    protected $zipcode;
+
+    protected $city;
+
+    protected $country;
+
+    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->address = null;
+        $this->zipcode = null;
+        $this->city = null;
+        $this->country = null;
+    }
+
+    public function getAddress()
+    {
+        return $this->address;
+    }
 	
-	public function setAddress($address)
-	{
-		$this->address = $address;
-	}
-
-	public function getZipcode()
-	{
-		return $this->zipcode;
-	}
+    public function setAddress($address)
+    {
+        $this->address = $address;
+    }
+
+    public function getZipcode()
+    {
+        return $this->zipcode;
+    }
 	
-	public function setZipcode($zipcode)
-	{
-		$this->zipcode = $zipcode;
-	}
-
-	public function getCity()
-	{
-		return $this->city;
-	}
+    public function setZipcode($zipcode)
+    {
+        $this->zipcode = $zipcode;
+    }
+
+    public function getCity()
+    {
+        return $this->city;
+    }
 	
-	public function setCity($city)
-	{
-		$this->city = $city;
-	}
-
-	public function getCountry()
-	{
-		return $this->country;
-	}
+    public function setCity($city)
+    {
+        $this->city = $city;
+    }
+
+    public function getCountry()
+    {
+        return $this->country;
+    }
 	
-	public function setCountry($country)
-	{
-		$this->country = $country;
-	}
+    public function setCountry($country)
+    {
+        $this->country = $country;
+    }
 
-	abstract function extendTableDefinition($columnName, $definition);
+    abstract function extendTableDefinition($columnName, $definition);
 
-	abstract function registerSearchHook($columnName, $fn);
+    abstract function registerSearchHook($columnName, $fn);
 
-	abstract function registerDeleteHook($columnName, $fn);
+    abstract function registerDeleteHook($columnName, $fn);
 
-	abstract function registerUpdateHook($columnName, $fn);
+    abstract function registerUpdateHook($columnName, $fn);
 
-	abstract function registerReadHook($columnName, $fn);
+    abstract function registerReadHook($columnName, $fn);
 
-	abstract function registerCreateHook($columnName, $fn);
+    abstract function registerCreateHook($columnName, $fn);
 	
 }
\ No newline at end of file

src/Traits/Datefields.php

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 
 namespace miBadger\ActiveRecord\Traits;
 
-use miBadger\Query\Query;
 use miBadger\ActiveRecord\ColumnProperty;
 
 const TRAIT_DATEFIELDS_LAST_MODIFIED = "last_modified";

Doc Comments +8 added lines, -2 removed lines

@@ -65,7 +65,7 @@ 
 
 	/**
 	 * Returns the timestamp of last update for this record
-	 * @return DateTime
+	 * @return \DateTime
 	 */
 	public function getLastModifiedDate()
 	{
@@ -74,7 +74,7 @@ 
 
 	/**
 	 * Returns the timestamp of when this record was created
-	 * @return DateTime
+	 * @return \DateTime
 	 */
 	public function getCreationDate()
 	{
@@ -88,10 +88,16 @@ 
 
 	abstract function registerDeleteHook($columnName, $fn);
 
+	/**
+	 * @param string $fn
+	 */
 	abstract function registerUpdateHook($columnName, $fn);
 
 	abstract function registerReadHook($columnName, $fn);
 
+	/**
+	 * @param string $fn
+	 */
 	abstract function registerCreateHook($columnName, $fn);
 }
 

Indentation +83 added lines, -83 removed lines

@@ -10,89 +10,89 @@
 
 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',
-			'default' => 'CURRENT_TIMESTAMP',
-			'properties' => ColumnProperty::NOT_NULL | ColumnProperty::IMMUTABLE
-		]);
-
-		$this->extendTableDefinition(TRAIT_DATEFIELDS_LAST_MODIFIED, [
-			'value' => &$this->lastModified,
-			'validate' => null,
-			'type' => 'DATETIME',
-			'default' => 'CURRENT_TIMESTAMP',
-			'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',
+            'default' => 'CURRENT_TIMESTAMP',
+            'properties' => ColumnProperty::NOT_NULL | ColumnProperty::IMMUTABLE
+        ]);
+
+        $this->extendTableDefinition(TRAIT_DATEFIELDS_LAST_MODIFIED, [
+            'value' => &$this->lastModified,
+            'validate' => null,
+            'type' => 'DATETIME',
+            'default' => 'CURRENT_TIMESTAMP',
+            'properties' => ColumnProperty::NOT_NULL | ColumnProperty::IMMUTABLE
+        ]);
 		
-		$this->registerUpdateHook(TRAIT_DATEFIELDS_LAST_MODIFIED, 'DatefieldsUpdateHook');
-		$this->registerCreateHook(TRAIT_DATEFIELDS_LAST_MODIFIED, 'DatefieldsCreateHook');
-
-		$this->created = null;
-		$this->lastModified = null;
-	}
-
-	/**
-	 * The hook that gets called to set the timestamp whenever a new record is created
-	 */
-	protected function DatefieldsCreateHook()
-	{
-		// @TODO: Should this be split up to seperate hooks for "last_modified" and "created" for consistency?
-		$this->created = (new \DateTime('now'))->format('Y-m-d H:i:s');
-		$this->lastModified = (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);
-	}
-
-
-	abstract function extendTableDefinition($columnName, $definition);
-
-	abstract function registerSearchHook($columnName, $fn);
-
-	abstract function registerDeleteHook($columnName, $fn);
-
-	abstract function registerUpdateHook($columnName, $fn);
-
-	abstract function registerReadHook($columnName, $fn);
-
-	abstract function registerCreateHook($columnName, $fn);
+        $this->registerUpdateHook(TRAIT_DATEFIELDS_LAST_MODIFIED, 'DatefieldsUpdateHook');
+        $this->registerCreateHook(TRAIT_DATEFIELDS_LAST_MODIFIED, 'DatefieldsCreateHook');
+
+        $this->created = null;
+        $this->lastModified = null;
+    }
+
+    /**
+     * The hook that gets called to set the timestamp whenever a new record is created
+     */
+    protected function DatefieldsCreateHook()
+    {
+        // @TODO: Should this be split up to seperate hooks for "last_modified" and "created" for consistency?
+        $this->created = (new \DateTime('now'))->format('Y-m-d H:i:s');
+        $this->lastModified = (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);
+    }
+
+
+    abstract function extendTableDefinition($columnName, $definition);
+
+    abstract function registerSearchHook($columnName, $fn);
+
+    abstract function registerDeleteHook($columnName, $fn);
+
+    abstract function registerUpdateHook($columnName, $fn);
+
+    abstract function registerReadHook($columnName, $fn);
+
+    abstract function registerCreateHook($columnName, $fn);
 }
 
-	
\ No newline at end of file
+    
\ No newline at end of file

src/Traits/ManyToManyRelation.php

Unused Use Statements +1 added lines, -2 removed lines

@@ -2,9 +2,8 @@
 
 namespace miBadger\ActiveRecord\Traits;
 
-use miBadger\Query\Query;
-use miBadger\ActiveRecord\ColumnProperty;
 use miBadger\ActiveRecord\AbstractActiveRecord;
+use miBadger\ActiveRecord\ColumnProperty;
 
 Trait ManyToManyRelation
 {

Doc Comments +3 added lines

@@ -74,6 +74,9 @@
 		$this->pdo->query($rightConstraint);
 	}
 	
+	/**
+	 * @param string $columnName
+	 */
 	abstract function extendTableDefinition($columnName, $definition);
 
 	abstract function registerSearchHook($columnName, $fn);

Indentation +71 added lines, -71 removed lines

@@ -8,82 +8,82 @@
 
 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;
-
-	/**
-	 * Initializes the the ManyToManyRelation trait on the included object
-	 * 
-	 * @param AbstractActiveRecord $leftEntity The left entity of the relation
-	 * @param &variable $leftVariable The variable where the id for the left entity will be stored
-	 * @param AbstractActiveRecord $rightEntity The left entity of the relation
-	 * @param &variable $leftVariable The variable where the id for the right entity will be stored
-	 */
-	protected function initManyToManyRelation(AbstractActiveRecord $leftEntity, &$leftVariable, AbstractActiveRecord $rightEntity, &$rightVariable)
-	{
-		$this->_leftEntityTable = $leftEntity->getActiveRecordTable();
-		$this->_rightEntityTable = $rightEntity->getActiveRecordTable();
-
-		if (get_class($leftEntity) === get_class($rightEntity)) {
-			$this->_leftColumnName = sprintf("id_%s_left", $leftEntity->getActiveRecordTable());
-			$this->_rightColumnName = sprintf("id_%s_right", $rightEntity->getActiveRecordTable());
-		} else {
-			$this->_leftColumnName = sprintf("id_%s", $leftEntity->getActiveRecordTable());
-			$this->_rightColumnName = sprintf("id_%s", $rightEntity->getActiveRecordTable());
-		}
-
-		$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
-	 */
-	public function createTableConstraints()
-	{
-		$childTable = $this->getActiveRecordTable();
-
-		$leftParentTable = $this->_leftEntityTable;
-		$rightParentTable = $this->_rightEntityTable;
-
-		$leftConstraint = $this->buildConstraint($leftParentTable, 'id', $childTable, $this->_leftColumnName);
-		$rightConstraint = $this->buildConstraint($rightParentTable, 'id', $childTable, $this->_rightColumnName);
-
-		$this->pdo->query($leftConstraint);
-		$this->pdo->query($rightConstraint);
-	}
+    // 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;
+
+    /**
+     * Initializes the the ManyToManyRelation trait on the included object
+     * 
+     * @param AbstractActiveRecord $leftEntity The left entity of the relation
+     * @param &variable $leftVariable The variable where the id for the left entity will be stored
+     * @param AbstractActiveRecord $rightEntity The left entity of the relation
+     * @param &variable $leftVariable The variable where the id for the right entity will be stored
+     */
+    protected function initManyToManyRelation(AbstractActiveRecord $leftEntity, &$leftVariable, AbstractActiveRecord $rightEntity, &$rightVariable)
+    {
+        $this->_leftEntityTable = $leftEntity->getActiveRecordTable();
+        $this->_rightEntityTable = $rightEntity->getActiveRecordTable();
+
+        if (get_class($leftEntity) === get_class($rightEntity)) {
+            $this->_leftColumnName = sprintf("id_%s_left", $leftEntity->getActiveRecordTable());
+            $this->_rightColumnName = sprintf("id_%s_right", $rightEntity->getActiveRecordTable());
+        } else {
+            $this->_leftColumnName = sprintf("id_%s", $leftEntity->getActiveRecordTable());
+            $this->_rightColumnName = sprintf("id_%s", $rightEntity->getActiveRecordTable());
+        }
+
+        $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
+     */
+    public function createTableConstraints()
+    {
+        $childTable = $this->getActiveRecordTable();
+
+        $leftParentTable = $this->_leftEntityTable;
+        $rightParentTable = $this->_rightEntityTable;
+
+        $leftConstraint = $this->buildConstraint($leftParentTable, 'id', $childTable, $this->_leftColumnName);
+        $rightConstraint = $this->buildConstraint($rightParentTable, 'id', $childTable, $this->_rightColumnName);
+
+        $this->pdo->query($leftConstraint);
+        $this->pdo->query($rightConstraint);
+    }
 	
-	abstract function extendTableDefinition($columnName, $definition);
+    abstract function extendTableDefinition($columnName, $definition);
 
-	abstract function registerSearchHook($columnName, $fn);
+    abstract function registerSearchHook($columnName, $fn);
 
-	abstract function registerDeleteHook($columnName, $fn);
+    abstract function registerDeleteHook($columnName, $fn);
 
-	abstract function registerUpdateHook($columnName, $fn);
+    abstract function registerUpdateHook($columnName, $fn);
 
-	abstract function registerReadHook($columnName, $fn);
+    abstract function registerReadHook($columnName, $fn);
 
-	abstract function registerCreateHook($columnName, $fn);
+    abstract function registerCreateHook($columnName, $fn);
 
 }

src/Traits/SoftDelete.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -2,8 +2,8 @@
 
 namespace miBadger\ActiveRecord\Traits;
 
-use miBadger\Query\Query;
 use miBadger\ActiveRecord\ColumnProperty;
+use miBadger\Query\Query;
 
 const TRAIT_SOFT_DELETE_FIELD_KEY = "soft_delete";
 

Doc Comments +3 added lines

@@ -80,6 +80,9 @@
 
 	abstract function extendTableDefinition($columnName, $definition);
 
+	/**
+	 * @param string $fn
+	 */
 	abstract function registerSearchHook($columnName, $fn);
 
 	abstract function registerDeleteHook($columnName, $fn);

Indentation +79 added lines, -79 removed lines

@@ -9,84 +9,84 @@
 
 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');
-	}
-
-	/**
-	 * The hook that gets called whenever a query is made
-	 */
-	protected function softDeleteSearchHook(Query $query)
-	{
-		$query->where(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');
+    }
+
+    /**
+     * The hook that gets called whenever a query is made
+     */
+    protected function softDeleteSearchHook(Query $query)
+    {
+        $query->where(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;
-		return $this;
-	}
-
-	/**
-	 * Undo the current soft deletion status (mark it as non-soft deleted)
-	 * @return $this
-	 */
-	public function softRestore()
-	{
-		$this->softDelete = false;
-		return $this;
-	}
-
-	/**
-	 * returns the current soft deletion status
-	 * @return $this
-	 */
-	public function getDeletionStatus() 
-	{
-		return $this->softDelete;
-	}
-
-	abstract function extendTableDefinition($columnName, $definition);
-
-	abstract function registerSearchHook($columnName, $fn);
-
-	abstract function registerDeleteHook($columnName, $fn);
-
-	abstract function registerUpdateHook($columnName, $fn);
-
-	abstract function registerReadHook($columnName, $fn);
-
-	abstract function registerCreateHook($columnName, $fn);
+    /**
+     * Mark the current record as soft deleted
+     * @return $this
+     */
+    public function softDelete()
+    {
+        $this->softDelete = true;
+        return $this;
+    }
+
+    /**
+     * Undo the current soft deletion status (mark it as non-soft deleted)
+     * @return $this
+     */
+    public function softRestore()
+    {
+        $this->softDelete = false;
+        return $this;
+    }
+
+    /**
+     * returns the current soft deletion status
+     * @return $this
+     */
+    public function getDeletionStatus() 
+    {
+        return $this->softDelete;
+    }
+
+    abstract function extendTableDefinition($columnName, $definition);
+
+    abstract function registerSearchHook($columnName, $fn);
+
+    abstract function registerDeleteHook($columnName, $fn);
+
+    abstract function registerUpdateHook($columnName, $fn);
+
+    abstract function registerReadHook($columnName, $fn);
+
+    abstract function registerCreateHook($columnName, $fn);
 }
\ No newline at end of file

src/ColumnProperty.php

Indentation +6 added lines, -6 removed lines

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

src/Traits/Password.php

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 
 namespace miBadger\ActiveRecord\Traits;
 
-use miBadger\ActiveRecord\ColumnProperty;
 use miBadger\ActiveRecord\ActiveRecordTraitException;
 
 const TRAIT_PASSWORD_FIELD_PASSWORD = "password";

Indentation +125 added lines, -125 removed lines

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

src/Traits/AutoApi.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -2,8 +2,8 @@
 
 namespace miBadger\ActiveRecord\Traits;
 
-use miBadger\ActiveRecord\ColumnProperty;
 use miBadger\ActiveRecord\ActiveRecordException;
+use miBadger\ActiveRecord\ColumnProperty;
 use miBadger\Query\Query;
 
 trait AutoApi

Doc Comments +11 added lines

@@ -44,6 +44,8 @@ 
 
 	/**
 	 * Copy all table variables between two instances
+	 * @param AutoApi $to
+	 * @param AutoApi $from
 	 */
 	private function syncInstances($to, $from)
 	{
@@ -272,10 +274,19 @@ 
 
 	abstract public function read($id);
 
+	/**
+	 * @return \PDO
+	 */
 	abstract public function getPdo();
 
+	/**
+	 * @param integer $id
+	 */
 	abstract function setId($id);
 
+	/**
+	 * @return string
+	 */
 	abstract function getActiveRecordTable();
 
 	abstract function getActiveRecordColumns();

Indentation +262 added lines, -262 removed lines

@@ -8,275 +8,275 @@
 
 trait AutoApi
 {
-	/* =======================================================================
+    /* =======================================================================
 	 * ===================== Automatic API Support ===========================
 	 * ======================================================================= */
 
-	public function apiSearch($inputs, $fieldWhitelist)
-	{
-		// @TODO: How to handle this case?
-		// => Default parameter names for searching? (limit, pagination, sort order etc)
-		//		Find default names for this and store in class
-		// => Limited search parameters? (We don't want to be able to search on a password field for example)
-	}
-
-	public function toArray($fieldWhitelist)
-	{
-		$output = [];
-		foreach ($this->tableDefinition as $colName => $definition) {
-			if (in_array($colName, $fieldWhitelist)) {
-				$output[$colName] = $definition['value'];
-			}
-		}
-
-		return $output;
-	}
-
-	public function apiRead($id, $fieldWhitelist)
-	{
-		$this->read($id);
-		return $this->toArray($fieldWhitelist);
-	}
-
-	/* =============================================================
+    public function apiSearch($inputs, $fieldWhitelist)
+    {
+        // @TODO: How to handle this case?
+        // => Default parameter names for searching? (limit, pagination, sort order etc)
+        //		Find default names for this and store in class
+        // => Limited search parameters? (We don't want to be able to search on a password field for example)
+    }
+
+    public function toArray($fieldWhitelist)
+    {
+        $output = [];
+        foreach ($this->tableDefinition as $colName => $definition) {
+            if (in_array($colName, $fieldWhitelist)) {
+                $output[$colName] = $definition['value'];
+            }
+        }
+
+        return $output;
+    }
+
+    public function apiRead($id, $fieldWhitelist)
+    {
+        $this->read($id);
+        return $this->toArray($fieldWhitelist);
+    }
+
+    /* =============================================================
 	 * ===================== Constraint validation =================
 	 * ============================================================= */
 
-	/**
-	 * Copy all table variables between two instances
-	 */
-	private function syncInstances($to, $from)
-	{
-		foreach ($to->tableDefinition as $colName => $definition) {
-			$definition['value'] = $from->tableDefinition[$colName]['value'];
-		}
-	}
-
-	private function filterInputColumns($input, $whitelist)
-	{
-		$filteredInput = $input;
-		foreach ($input as $colName => $value) {
-			if (!in_array($colName, $whitelist)) {
-				unset($filteredInput[$colName]);
-			}
-		}
-		return $filteredInput;
-	}
-
-	private function validateExcessKeys($input)
-	{
-		$errors = [];
-		foreach ($input as $colName => $value) {
-			if (!array_key_exists($colName, $this->tableDefinition)) {
-				$errors[$colName] = "Unknown input field";
-				continue;
-			}
-		}
-		return $errors;
-	}
-
-	private function validateImmutableColumns($input)
-	{
-		$errors = [];
-		foreach ($this->tableDefinition as $colName => $definition) {
-			$property = $definition['properties'] ?? null;
-			if (array_key_exists($colName, $input)
-				&& $property & ColumnProperty::IMMUTABLE) {
-				$errors[$colName] = "Field cannot be changed";
-			}
-		}
-		return $errors;
-	}
-
-	private function validateInputValues($input)
-	{
-		$errors = [];
-		foreach ($this->tableDefinition as $colName => $definition) {
-			// Validation check 1: If validate function is present
-			if (array_key_exists($colName, $input) 
-				&& is_callable($definition['validate'] ?? null)) {
-				$inputValue = $input[$colName];
-
-				// If validation function fails
-				[$status, $message] = $definition['validate']($inputValue);
-				if (!$status) {
-					$errors[$colName] = $message;
-				}	
-			}
-
-			// Validation check 2: If relation column, check whether entity exists
-			$properties = $definition['properties'] ?? null;
-			if (isset($definition['relation'])
-				&& ($properties & ColumnProperty::NOT_NULL)) {
-				$instance = clone $definition['relation'];
-				try {
-					$instance->read($input[$colName] ?? null);
-				} catch (ActiveRecordException $e) {
-					$errors[$colName] = "Entity for this value doesn't exist";
-				}
-			}
-		}
-		return $errors;
-	}
-
-	/**
-	 * This function is only used for API Update calls (direct getter/setter functions are unconstrained)
-	 */
-	private function validateMissingKeys()
-	{
-		$errors = [];
-
-		foreach ($this->tableDefinition as $colName => $colDefinition) {
-			$default = $colDefinition['default'] ?? null;
-			$properties = $colDefinition['properties'] ?? null;
-			$value = $colDefinition['value'];
-
-			// If nullable and default not set => null
-			// If nullable and default null => default (null)
-			// If nullable and default set => default (value)
-
-			// if not nullable and default not set => error
-			// if not nullable and default null => error
-			// if not nullable and default st => default (value)
-			// => if not nullable and default null and value not set => error message in this method
-			if ($properties & ColumnProperty::NOT_NULL
-				&& $default === null
-				&& !($properties & ColumnProperty::AUTO_INCREMENT)
-				// && !array_key_exists($colName, $input)
-				&& $value === null) {
-				$errors[$colName] = sprintf("The required field \"%s\" is missing", $colName);
-			}
-		}
-
-		return $errors;
-	}
-
-	/**
-	 * Copies the values for entries in the input with matching variable names in the record definition
-	 * @param Array $input The input data to be loaded into $this record
-	 */
-	private function loadData($input)
-	{
-		foreach ($this->tableDefinition as $colName => $definition) {
-			if (array_key_exists($colName, $input)) {
-				$definition['value'] = $input[$colName];
-			}
-		}
-	}
-
-	/**
-	 * @param Array $input Associative array of input values
-	 * @param Array $fieldWhitelist array of column names that are allowed to be filled by the input array 
-	 * @return Array Array containing the set of optional errors (associative array) and an optional array representation (associative)
-	 * 					of the modified data.
-	 */
-	public function apiCreate($input, $fieldWhitelist)
-	{
-		// Clone $this to new instance (for restoring if validation goes wrong)
-		$transaction = clone $this;
-		$errors = [];
-
-		// Filter out all non-whitelisted input values
-		$input = $this->filterInputColumns($input, $fieldWhitelist);
-
-		// Validate excess keys
-		$errors += $transaction->validateExcessKeys($input);
-
-		// Validate input values (using validation function)
-		$errors += $transaction->validateInputValues($input);
-
-		// "Copy" data into transaction
-		$transaction->loadData($input);
-
-		// Run create hooks
-		foreach ($this->registeredCreateHooks as $colName => $fn) {
-			$fn();
-		}
-
-		// Validate missing keys
-		$errors += $transaction->validateMissingKeys();
-
-		// If no errors, commit the pending data
-		if (empty($errors)) {
-			$this->syncInstances($this, $transaction);
-
-			try {
-				$q = (new Query($this->getPdo(), $this->getActiveRecordTable()))
-					->insert($this->getActiveRecordColumns())
-					->execute();
-
-				$this->setId(intval($this->getPdo()->lastInsertId()));
-			} catch (\PDOException $e) {
-				// @TODO: Potentially filter and store mysql messages (where possible) in error messages
-				throw new ActiveRecordException($e->getMessage(), 0, $e);
-			}
-
-			return [null, $this->toArray($fieldWhitelist)];
-		} else {
-			return [$errors, null];
-		}
-	}
-
-	/**
-	 * @param Array $input Associative array of input values
-	 * @param Array $fieldWhitelist array of column names that are allowed to be filled by the input array 
-	 * @return Array Array containing the set of optional errors (associative array) and an optional array representation (associative)
-	 * 					of the modified data.
-	 */
-	public function apiUpdate($input, $fieldWhitelist)
-	{
-		$transaction = clone $this;
-		$errors = [];
-
-		// Filter out all non-whitelisted input values
-		$input = $this->filterInputColumns($input, $fieldWhitelist);
-
-		// Check for excess keys
-		$errors += $transaction->validateExcessKeys($input);
-
-		// Check for immutable keys
-		$errors += $transaction->validateImmutableColumns($input);
-
-		// Validate input values (using validation function)
-		$errors += $transaction->validateInputValues($input);
-
-		// "Copy" data into transaction
-		$transaction->loadData($input);
-
-		// Run create hooks
-		foreach ($this->registeredUpdateHooks as $colName => $fn) {
-			$fn();
-		}
-
-		// Validate missing keys
-		$errors += $transaction->validateMissingKeys();
-
-		// Update database
-		if (empty($errors)) {
-			$this->syncInstances($this, $transaction);
-
-			try {
-				(new Query($this->getPdo(), $this->getActiveRecordTable()))
-					->update($this->getActiveRecordColumns())
-					->where('id', '=', $this->getId())
-					->execute();
-			} catch (\PDOException $e) {
-				throw new ActiveRecordException($e->getMessage(), 0, $e);
-			}
-
-			return [null, $this->toArray($fieldWhitelist)];
-		} else {
-			return [$errors, null];
-		}
-	}
-
-	abstract public function read($id);
-
-	abstract public function getPdo();
+    /**
+     * Copy all table variables between two instances
+     */
+    private function syncInstances($to, $from)
+    {
+        foreach ($to->tableDefinition as $colName => $definition) {
+            $definition['value'] = $from->tableDefinition[$colName]['value'];
+        }
+    }
+
+    private function filterInputColumns($input, $whitelist)
+    {
+        $filteredInput = $input;
+        foreach ($input as $colName => $value) {
+            if (!in_array($colName, $whitelist)) {
+                unset($filteredInput[$colName]);
+            }
+        }
+        return $filteredInput;
+    }
+
+    private function validateExcessKeys($input)
+    {
+        $errors = [];
+        foreach ($input as $colName => $value) {
+            if (!array_key_exists($colName, $this->tableDefinition)) {
+                $errors[$colName] = "Unknown input field";
+                continue;
+            }
+        }
+        return $errors;
+    }
+
+    private function validateImmutableColumns($input)
+    {
+        $errors = [];
+        foreach ($this->tableDefinition as $colName => $definition) {
+            $property = $definition['properties'] ?? null;
+            if (array_key_exists($colName, $input)
+                && $property & ColumnProperty::IMMUTABLE) {
+                $errors[$colName] = "Field cannot be changed";
+            }
+        }
+        return $errors;
+    }
+
+    private function validateInputValues($input)
+    {
+        $errors = [];
+        foreach ($this->tableDefinition as $colName => $definition) {
+            // Validation check 1: If validate function is present
+            if (array_key_exists($colName, $input) 
+                && is_callable($definition['validate'] ?? null)) {
+                $inputValue = $input[$colName];
+
+                // If validation function fails
+                [$status, $message] = $definition['validate']($inputValue);
+                if (!$status) {
+                    $errors[$colName] = $message;
+                }	
+            }
+
+            // Validation check 2: If relation column, check whether entity exists
+            $properties = $definition['properties'] ?? null;
+            if (isset($definition['relation'])
+                && ($properties & ColumnProperty::NOT_NULL)) {
+                $instance = clone $definition['relation'];
+                try {
+                    $instance->read($input[$colName] ?? null);
+                } catch (ActiveRecordException $e) {
+                    $errors[$colName] = "Entity for this value doesn't exist";
+                }
+            }
+        }
+        return $errors;
+    }
+
+    /**
+     * This function is only used for API Update calls (direct getter/setter functions are unconstrained)
+     */
+    private function validateMissingKeys()
+    {
+        $errors = [];
+
+        foreach ($this->tableDefinition as $colName => $colDefinition) {
+            $default = $colDefinition['default'] ?? null;
+            $properties = $colDefinition['properties'] ?? null;
+            $value = $colDefinition['value'];
+
+            // If nullable and default not set => null
+            // If nullable and default null => default (null)
+            // If nullable and default set => default (value)
+
+            // if not nullable and default not set => error
+            // if not nullable and default null => error
+            // if not nullable and default st => default (value)
+            // => if not nullable and default null and value not set => error message in this method
+            if ($properties & ColumnProperty::NOT_NULL
+                && $default === null
+                && !($properties & ColumnProperty::AUTO_INCREMENT)
+                // && !array_key_exists($colName, $input)
+                && $value === null) {
+                $errors[$colName] = sprintf("The required field \"%s\" is missing", $colName);
+            }
+        }
+
+        return $errors;
+    }
+
+    /**
+     * Copies the values for entries in the input with matching variable names in the record definition
+     * @param Array $input The input data to be loaded into $this record
+     */
+    private function loadData($input)
+    {
+        foreach ($this->tableDefinition as $colName => $definition) {
+            if (array_key_exists($colName, $input)) {
+                $definition['value'] = $input[$colName];
+            }
+        }
+    }
+
+    /**
+     * @param Array $input Associative array of input values
+     * @param Array $fieldWhitelist array of column names that are allowed to be filled by the input array 
+     * @return Array Array containing the set of optional errors (associative array) and an optional array representation (associative)
+     * 					of the modified data.
+     */
+    public function apiCreate($input, $fieldWhitelist)
+    {
+        // Clone $this to new instance (for restoring if validation goes wrong)
+        $transaction = clone $this;
+        $errors = [];
+
+        // Filter out all non-whitelisted input values
+        $input = $this->filterInputColumns($input, $fieldWhitelist);
+
+        // Validate excess keys
+        $errors += $transaction->validateExcessKeys($input);
+
+        // Validate input values (using validation function)
+        $errors += $transaction->validateInputValues($input);
+
+        // "Copy" data into transaction
+        $transaction->loadData($input);
+
+        // Run create hooks
+        foreach ($this->registeredCreateHooks as $colName => $fn) {
+            $fn();
+        }
+
+        // Validate missing keys
+        $errors += $transaction->validateMissingKeys();
+
+        // If no errors, commit the pending data
+        if (empty($errors)) {
+            $this->syncInstances($this, $transaction);
+
+            try {
+                $q = (new Query($this->getPdo(), $this->getActiveRecordTable()))
+                    ->insert($this->getActiveRecordColumns())
+                    ->execute();
+
+                $this->setId(intval($this->getPdo()->lastInsertId()));
+            } catch (\PDOException $e) {
+                // @TODO: Potentially filter and store mysql messages (where possible) in error messages
+                throw new ActiveRecordException($e->getMessage(), 0, $e);
+            }
+
+            return [null, $this->toArray($fieldWhitelist)];
+        } else {
+            return [$errors, null];
+        }
+    }
+
+    /**
+     * @param Array $input Associative array of input values
+     * @param Array $fieldWhitelist array of column names that are allowed to be filled by the input array 
+     * @return Array Array containing the set of optional errors (associative array) and an optional array representation (associative)
+     * 					of the modified data.
+     */
+    public function apiUpdate($input, $fieldWhitelist)
+    {
+        $transaction = clone $this;
+        $errors = [];
+
+        // Filter out all non-whitelisted input values
+        $input = $this->filterInputColumns($input, $fieldWhitelist);
+
+        // Check for excess keys
+        $errors += $transaction->validateExcessKeys($input);
+
+        // Check for immutable keys
+        $errors += $transaction->validateImmutableColumns($input);
+
+        // Validate input values (using validation function)
+        $errors += $transaction->validateInputValues($input);
+
+        // "Copy" data into transaction
+        $transaction->loadData($input);
+
+        // Run create hooks
+        foreach ($this->registeredUpdateHooks as $colName => $fn) {
+            $fn();
+        }
+
+        // Validate missing keys
+        $errors += $transaction->validateMissingKeys();
+
+        // Update database
+        if (empty($errors)) {
+            $this->syncInstances($this, $transaction);
+
+            try {
+                (new Query($this->getPdo(), $this->getActiveRecordTable()))
+                    ->update($this->getActiveRecordColumns())
+                    ->where('id', '=', $this->getId())
+                    ->execute();
+            } catch (\PDOException $e) {
+                throw new ActiveRecordException($e->getMessage(), 0, $e);
+            }
+
+            return [null, $this->toArray($fieldWhitelist)];
+        } else {
+            return [$errors, null];
+        }
+    }
+
+    abstract public function read($id);
+
+    abstract public function getPdo();
 
-	abstract function setId($id);
+    abstract function setId($id);
 
-	abstract function getActiveRecordTable();
+    abstract function getActiveRecordTable();
 
-	abstract function getActiveRecordColumns();
+    abstract function getActiveRecordColumns();
 }

src/Traits/Pagination.php

Indentation +1 added lines, -1 removed lines

@@ -6,5 +6,5 @@
 
 trait Pagination
 {
-	// @TODO: This one would most likely only be relevant for api requests (and perhaps supply a public method for searching with a page)
+    // @TODO: This one would most likely only be relevant for api requests (and perhaps supply a public method for searching with a page)
 }
\ No newline at end of file