miBadger / miBadger.ActiveRecord

src/Traits/Password.php

Indentation +180 added lines, -180 removed lines

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

src/Traits/ManyToManyRelation.php

Indentation +104 added lines, -104 removed lines

@@ -9,110 +9,110 @@
 
 Trait ManyToManyRelation
 {
-	// These variables are relevant for internal bookkeeping (constraint generation etc)
-
-	/** @var string The name of the left column of the relation. */
-	private $_leftColumnName;
-
-	/** @var string The name of the right column of the relation. */
-	private $_rightColumnName;
-
-	/** @var string The name of the left table of the relation. */
-	private $_leftEntityTable;
-
-	/** @var string The name of the right table of the relation. */
-	private $_rightEntityTable;
-
-	/** @var \PDO The PDO object. */
-	protected $pdo;
-	/**
-	 * Initializes the the ManyToManyRelation trait on the included object
-	 * 
-	 * @param AbstractActiveRecord $leftEntity The left entity of the relation
-	 * @param int $leftVariable The reference to the variable where the id for the left entity will be stored
-	 * @param AbstractActiveRecord $rightEntity The left entity of the relation
-	 * @param int $leftVariable The reference to the variable where the id for the right entity will be stored
-	 * @return void
-	 */
-	protected function initManyToManyRelation(AbstractActiveRecord $leftEntity, &$leftVariable, AbstractActiveRecord $rightEntity, &$rightVariable)
-	{
-		$this->_leftEntityTable = $leftEntity->getTableName();
-		$this->_rightEntityTable = $rightEntity->getTableName();
-
-		if (get_class($leftEntity) === get_class($rightEntity)) {
-			$this->_leftColumnName = sprintf("id_%s_left", $leftEntity->getTableName());
-			$this->_rightColumnName = sprintf("id_%s_right", $rightEntity->getTableName());
-		} else {
-			$this->_leftColumnName = sprintf("id_%s", $leftEntity->getTableName());
-			$this->_rightColumnName = sprintf("id_%s", $rightEntity->getTableName());
-		}
-
-		$this->extendTableDefinition($this->_leftColumnName, [
-			'value' => &$leftVariable,
-			'validate' => null,
-			'type' => AbstractActiveRecord::COLUMN_TYPE_ID,
-			'properties' => ColumnProperty::NOT_NULL
-		]);
-
-		$this->extendTableDefinition($this->_rightColumnName, [
-			'value' => &$rightVariable,
-			'validate' => null,
-			'type' => AbstractActiveRecord::COLUMN_TYPE_ID,
-			'properties' => ColumnProperty::NOT_NULL
-		]);
-	}
-
-	/**
-	 * Build the constraints for the many-to-many relation table
-	 * @return void
-	 */
-	public function createTableConstraints()
-	{
-		$childTable = $this->getTableName();
-
-		$leftParentTable = $this->_leftEntityTable;
-		$rightParentTable = $this->_rightEntityTable;
-
-		$leftConstraint = SchemaBuilder::buildConstraintOnDeleteCascade($leftParentTable, 'id', $childTable, $this->_leftColumnName);
-		$rightConstraint = SchemaBuilder::buildConstraintOnDeleteCascade($rightParentTable, 'id', $childTable, $this->_rightColumnName);
-
-		$this->pdo->query($leftConstraint);
-		$this->pdo->query($rightConstraint);
-	}
-
-	/**
-	 * @return void
-	 */	
-	abstract public function getTableName();
-
-	/**
-	 * @return void
-	 */
-	abstract protected function extendTableDefinition(string $columnName, $definition);
+    // These variables are relevant for internal bookkeeping (constraint generation etc)
+
+    /** @var string The name of the left column of the relation. */
+    private $_leftColumnName;
+
+    /** @var string The name of the right column of the relation. */
+    private $_rightColumnName;
+
+    /** @var string The name of the left table of the relation. */
+    private $_leftEntityTable;
+
+    /** @var string The name of the right table of the relation. */
+    private $_rightEntityTable;
+
+    /** @var \PDO The PDO object. */
+    protected $pdo;
+    /**
+     * Initializes the the ManyToManyRelation trait on the included object
+     * 
+     * @param AbstractActiveRecord $leftEntity The left entity of the relation
+     * @param int $leftVariable The reference to the variable where the id for the left entity will be stored
+     * @param AbstractActiveRecord $rightEntity The left entity of the relation
+     * @param int $leftVariable The reference to the variable where the id for the right entity will be stored
+     * @return void
+     */
+    protected function initManyToManyRelation(AbstractActiveRecord $leftEntity, &$leftVariable, AbstractActiveRecord $rightEntity, &$rightVariable)
+    {
+        $this->_leftEntityTable = $leftEntity->getTableName();
+        $this->_rightEntityTable = $rightEntity->getTableName();
+
+        if (get_class($leftEntity) === get_class($rightEntity)) {
+            $this->_leftColumnName = sprintf("id_%s_left", $leftEntity->getTableName());
+            $this->_rightColumnName = sprintf("id_%s_right", $rightEntity->getTableName());
+        } else {
+            $this->_leftColumnName = sprintf("id_%s", $leftEntity->getTableName());
+            $this->_rightColumnName = sprintf("id_%s", $rightEntity->getTableName());
+        }
+
+        $this->extendTableDefinition($this->_leftColumnName, [
+            'value' => &$leftVariable,
+            'validate' => null,
+            'type' => AbstractActiveRecord::COLUMN_TYPE_ID,
+            'properties' => ColumnProperty::NOT_NULL
+        ]);
+
+        $this->extendTableDefinition($this->_rightColumnName, [
+            'value' => &$rightVariable,
+            'validate' => null,
+            'type' => AbstractActiveRecord::COLUMN_TYPE_ID,
+            'properties' => ColumnProperty::NOT_NULL
+        ]);
+    }
+
+    /**
+     * Build the constraints for the many-to-many relation table
+     * @return void
+     */
+    public function createTableConstraints()
+    {
+        $childTable = $this->getTableName();
+
+        $leftParentTable = $this->_leftEntityTable;
+        $rightParentTable = $this->_rightEntityTable;
+
+        $leftConstraint = SchemaBuilder::buildConstraintOnDeleteCascade($leftParentTable, 'id', $childTable, $this->_leftColumnName);
+        $rightConstraint = SchemaBuilder::buildConstraintOnDeleteCascade($rightParentTable, 'id', $childTable, $this->_rightColumnName);
+
+        $this->pdo->query($leftConstraint);
+        $this->pdo->query($rightConstraint);
+    }
+
+    /**
+     * @return void
+     */	
+    abstract public function getTableName();
+
+    /**
+     * @return void
+     */
+    abstract protected function extendTableDefinition(string $columnName, $definition);
 	
-	/**
-	 * @return void
-	 */
-	abstract protected function registerSearchHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerDeleteHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerUpdateHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerReadHook(string $columnName, $fn);
-
-	/**
-	 * @return void
-	 */
-	abstract protected function registerCreateHook(string $columnName, $fn);
+    /**
+     * @return void
+     */
+    abstract protected function registerSearchHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerDeleteHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerUpdateHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerReadHook(string $columnName, $fn);
+
+    /**
+     * @return void
+     */
+    abstract protected function registerCreateHook(string $columnName, $fn);
 
 }

src/ActiveRecordInterface.php

Indentation +66 added lines, -66 removed lines

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