miBadger / miBadger.ActiveRecord

src/ColumnProperty.php

Indentation +6 added lines, -6 removed lines

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

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

test-bootstrap.php

Spacing +2 added lines, -2 removed lines

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

src/Traits/Address.php

Indentation +144 added lines, -144 removed lines

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

src/Traits/Datefields.php

Indentation +99 added lines, -99 removed lines

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

src/Traits/Password.php

Indentation +156 added lines, -156 removed lines

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

src/Traits/SoftDelete.php

Indentation +96 added lines, -96 removed lines

@@ -9,103 +9,103 @@
 
 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()
-	{
-		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');
+    }
+
+    /**
+     * The hook that gets called whenever a query is made
+     */
+    protected function softDeleteSearchHook()
+    {
+        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;
-		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;
-	}
-
-	/**
-	 * @return void
-	 */
-	abstract protected function extendTableDefinition($columnName, $definition);
+    /**
+     * 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;
+    }
+
+    /**
+     * @return void
+     */
+    abstract protected function extendTableDefinition($columnName, $definition);
 	
-	/**
-	 * @return void
-	 */
-	abstract protected function registerSearchHook($columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerDeleteHook($columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerUpdateHook($columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerReadHook($columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerCreateHook($columnName, $fn);
+    /**
+     * @return void
+     */
+    abstract protected function registerSearchHook($columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerDeleteHook($columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerUpdateHook($columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerReadHook($columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerCreateHook($columnName, $fn);
 	
 }
\ No newline at end of file

src/ActiveRecordQuery.php

Spacing +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
 		} else if (count($clauses) >= 2)
 		{
 			$rest = array_slice($clauses, 1);
-			$this->query->where(Query::And($clauses[0], ...$rest));
+			$this->query->where(Query:: And ($clauses[0], ...$rest));
 		}
 
 		$this->query->select();

Indentation +181 added lines, -181 removed lines

@@ -21,190 +21,190 @@
 class ActiveRecordQuery implements \IteratorAggregate
 {
 
-	private $clauses = [];
+    private $clauses = [];
 
-	private $query;
+    private $query;
 
-	private $results;
+    private $results;
 
-	private $table;
+    private $table;
 
-	private $type;
+    private $type;
 	
-	private $whereExpression = null;
-
-	/**
-	 * Constructs a new Active Record Query
-	 */
-	public function __construct(AbstractActiveRecord $instance, $table, Array $additionalWhereClauses)
-	{
-		$this->table = $table;
-		$this->query = new Query($instance->getPdo(), $table);
-		$this->type = $instance;
-		$this->clauses = $additionalWhereClauses;
-		$this->results = null;
-	}
-
-	/**
-	 * Executes the query
-	 */
-	private function execute()
-	{
-		$clauses = $this->clauses;
-
-		// Optionally add user concatenated where expression
-		if ($this->whereExpression !== null)
-		{
-			$clauses[] = $this->whereExpression;
-		}
-
-		// Construct where clause
-		if (count($clauses) == 1)
-		{
-			$this->query->where($clauses[0]);
-		} else if (count($clauses) >= 2)
-		{
-			$rest = array_slice($clauses, 1);
-			$this->query->where(Query::And($clauses[0], ...$rest));
-		}
-
-		$this->query->select();
-
-		$this->results = $this->query->execute();
-
-		return $this;
-	}
-
-	/**
-	 * Returns an iterator for the result set
-	 * @return ArrayIterator
-	 */
-	public function getIterator()
-	{
-		return new \ArrayIterator($this->fetchAll());
-	}
-
-	/**
-	 * returns the result set of ActiveRecord instances for this query
-	 * @return Array
-	 */
-	public function fetchAll()
-	{
-		try {
-			if ($this->results === null) {
-				$this->execute();	
-			}
-
-			$entries = $this->results->fetchAll();
-			if ($entries === false) {
-				throw new ActiveRecordException(sprintf('Can not search non-existent entries from the `%s` table.', $this->table));
-			}
-
-			$typedResults = [];
-
-			foreach ($entries as $entry) {
-				$typedEntry = $this->type->newInstance();
-				$typedEntry->fill($entry);
-				$typedResults[] = $typedEntry;
-			}
-
-			return $typedResults;
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), 0, $e);
-		}
-	}
-
-	/**
-	 * Fetch one record from the database
-	 * @return AbstractActiveRecord 
-	 */
-	public function fetch()
-	{
-		try {
-			if ($this->results === null) 
-			{
-				$this->execute();
-			}
-
-			$typedResult = $this->type->newInstance();
-
-			$entry = $this->results->fetch();
-			if ($entry === false) {
-				throw new ActiveRecordException(sprintf('Can not search one non-existent entry from the `%s` table.', $this->table));
-			}
-
-			$typedResult->fill($entry);
-
-			return $typedResult;
-		} catch (\PDOException $e) {
-			throw new ActiveRecordException($e->getMessage(), 0, $e);
-		}
-	}
-
-
-	/**
-	 * Set the where condition
-	 *
-	 * @param QueryExpression $expression the query expression
-	 * @return $this
-	 * @see https://en.wikipedia.org/wiki/SQL#Operators
-	 * @see https://en.wikipedia.org/wiki/Where_(SQL)
-	 */
-	public function where(QueryExpression $expression)
-	{
-		$this->whereExpression = $expression;
-		return $this;
-	}
-
-	/**
-	 * Set an additional group by.
-	 *
-	 * @param string $column
-	 * @return $this
-	 * @see https://en.wikipedia.org/wiki/SQL#Queries
-	 */
-	public function groupBy($column)
-	{
-		$this->query->groupBy($column);
-		return $this;
-	}
-
-	/**
-	 * Set an additional order condition.
-	 *
-	 * @param string $column
-	 * @param string|null $order
-	 * @return $this
-	 * @see https://en.wikipedia.org/wiki/SQL#Queries
-	 * @see https://en.wikipedia.org/wiki/Order_by
-	 */
-	public function orderBy($column, $order = null)
-	{
-		$this->query->orderBy($column, $order);	
-		return $this;
-	}
-
-	/**
-	 * Set the limit.
-	 *
-	 * @param mixed $limit
-	 * @return $this
-	 */
-	public function limit($limit)
-	{
-		$this->query->limit($limit);
-		return $this;
-	}
-
-	/**
-	 * Set the offset.
-	 *
-	 * @param mixed $offset
- 	 * @return $this
-	 */
-	public function offset($offset)
-	{
-		$this->query->offset($offset);
-		return $this;
-	}
+    private $whereExpression = null;
+
+    /**
+     * Constructs a new Active Record Query
+     */
+    public function __construct(AbstractActiveRecord $instance, $table, Array $additionalWhereClauses)
+    {
+        $this->table = $table;
+        $this->query = new Query($instance->getPdo(), $table);
+        $this->type = $instance;
+        $this->clauses = $additionalWhereClauses;
+        $this->results = null;
+    }
+
+    /**
+     * Executes the query
+     */
+    private function execute()
+    {
+        $clauses = $this->clauses;
+
+        // Optionally add user concatenated where expression
+        if ($this->whereExpression !== null)
+        {
+            $clauses[] = $this->whereExpression;
+        }
+
+        // Construct where clause
+        if (count($clauses) == 1)
+        {
+            $this->query->where($clauses[0]);
+        } else if (count($clauses) >= 2)
+        {
+            $rest = array_slice($clauses, 1);
+            $this->query->where(Query::And($clauses[0], ...$rest));
+        }
+
+        $this->query->select();
+
+        $this->results = $this->query->execute();
+
+        return $this;
+    }
+
+    /**
+     * Returns an iterator for the result set
+     * @return ArrayIterator
+     */
+    public function getIterator()
+    {
+        return new \ArrayIterator($this->fetchAll());
+    }
+
+    /**
+     * returns the result set of ActiveRecord instances for this query
+     * @return Array
+     */
+    public function fetchAll()
+    {
+        try {
+            if ($this->results === null) {
+                $this->execute();	
+            }
+
+            $entries = $this->results->fetchAll();
+            if ($entries === false) {
+                throw new ActiveRecordException(sprintf('Can not search non-existent entries from the `%s` table.', $this->table));
+            }
+
+            $typedResults = [];
+
+            foreach ($entries as $entry) {
+                $typedEntry = $this->type->newInstance();
+                $typedEntry->fill($entry);
+                $typedResults[] = $typedEntry;
+            }
+
+            return $typedResults;
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), 0, $e);
+        }
+    }
+
+    /**
+     * Fetch one record from the database
+     * @return AbstractActiveRecord 
+     */
+    public function fetch()
+    {
+        try {
+            if ($this->results === null) 
+            {
+                $this->execute();
+            }
+
+            $typedResult = $this->type->newInstance();
+
+            $entry = $this->results->fetch();
+            if ($entry === false) {
+                throw new ActiveRecordException(sprintf('Can not search one non-existent entry from the `%s` table.', $this->table));
+            }
+
+            $typedResult->fill($entry);
+
+            return $typedResult;
+        } catch (\PDOException $e) {
+            throw new ActiveRecordException($e->getMessage(), 0, $e);
+        }
+    }
+
+
+    /**
+     * Set the where condition
+     *
+     * @param QueryExpression $expression the query expression
+     * @return $this
+     * @see https://en.wikipedia.org/wiki/SQL#Operators
+     * @see https://en.wikipedia.org/wiki/Where_(SQL)
+     */
+    public function where(QueryExpression $expression)
+    {
+        $this->whereExpression = $expression;
+        return $this;
+    }
+
+    /**
+     * Set an additional group by.
+     *
+     * @param string $column
+     * @return $this
+     * @see https://en.wikipedia.org/wiki/SQL#Queries
+     */
+    public function groupBy($column)
+    {
+        $this->query->groupBy($column);
+        return $this;
+    }
+
+    /**
+     * Set an additional order condition.
+     *
+     * @param string $column
+     * @param string|null $order
+     * @return $this
+     * @see https://en.wikipedia.org/wiki/SQL#Queries
+     * @see https://en.wikipedia.org/wiki/Order_by
+     */
+    public function orderBy($column, $order = null)
+    {
+        $this->query->orderBy($column, $order);	
+        return $this;
+    }
+
+    /**
+     * Set the limit.
+     *
+     * @param mixed $limit
+     * @return $this
+     */
+    public function limit($limit)
+    {
+        $this->query->limit($limit);
+        return $this;
+    }
+
+    /**
+     * Set the offset.
+     *
+     * @param mixed $offset
+     * @return $this
+     */
+    public function offset($offset)
+    {
+        $this->query->offset($offset);
+        return $this;
+    }
 }

src/ActiveRecordInterface.php

Indentation +60 added lines, -60 removed lines

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