andela-tolotin / Potato-ORM

src/Model/BaseModel.php

Unused Use Statements -1 removed lines

@@ -14,7 +14,6 @@
 use Laztopaz\potatoORM\NoRecordFoundException;
 use Laztopaz\potatoORM\NoRecordInsertionException;
 use Laztopaz\potatoORM\NullArgumentPassedToFunction;
-use Laztopaz\potatoORM\WrongArgumentException;
 use Laztopaz\potatoORM\NoArgumentPassedToFunctionException;
 use Laztopaz\potatoORM\EmptyArrayException;
 

Doc Comments +2 added lines, -2 removed lines

@@ -99,7 +99,7 @@ 
     /**
      * This method find a record by id
      * @params int id
-     * @return Object
+     * @return BaseClass
      * @throws NoArgumentPassedToFunctionException
      */
     public static function find($id)
@@ -142,7 +142,7 @@ 
    /**
     * This method return the current class name
     * $params void
-    * @return classname
+    * @return string|false
     */
    public static function getClassName()
    {

Indentation +115 added lines, -115 removed lines

@@ -20,124 +20,124 @@ 
 
 class BaseClass  implements InterfaceBaseClass
 {
-    protected $databaseModel; // Private variable that contains instance of database
-    protected $tableName; // Class variable holding class name pluralized
-    protected $properties = []; // Properties will later contain key, value pairs from the magic setter, getter methods
-    use Inflector; // Inject the inflector trait
+	protected $databaseModel; // Private variable that contains instance of database
+	protected $tableName; // Class variable holding class name pluralized
+	protected $properties = []; // Properties will later contain key, value pairs from the magic setter, getter methods
+	use Inflector; // Inject the inflector trait
 
-    public function  __construct()
-    {
-        $this->tableName = $this->getClassName();
-        $this->databaseModel = new DatabaseHandler($this->tableName);
-        $this->properties['id'] = 0;
-    }
+	public function  __construct()
+	{
+		$this->tableName = $this->getClassName();
+		$this->databaseModel = new DatabaseHandler($this->tableName);
+		$this->properties['id'] = 0;
+	}
     
-    /**
-     * The magic getter method
-     * @params key
-     * @return array key
-     */
-    public function __get($key)
-    {
-    	$this->properties[$key];
-    }
+	/**
+	 * The magic getter method
+	 * @params key
+	 * @return array key
+	 */
+	public function __get($key)
+	{
+		$this->properties[$key];
+	}
     
-    /**
-     * The magic setter method
-     * @params property, key
-     * @return array associative array properties
-     */
-    public function  __set($property, $value)
-    {
-    	$this->properties[$property] = $value;
-    }
+	/**
+	 * The magic setter method
+	 * @params property, key
+	 * @return array associative array properties
+	 */
+	public function  __set($property, $value)
+	{
+		$this->properties[$property] = $value;
+	}
     
-    /**
-     * This method gets all the record from a particular table
-     * @params void
-     * @return associative array
-     * @throws NoRecordFoundException
-     */
-    public static function getAll()
-    {
-    	$allData = DatabaseHandler::read($id = false, self::getClassName());
-    	if (count($allData) > 0) {
-    	    return $allData;
-    	}
-    	throw NoRecordFoundException::checkNoRecordFoundException("There is no record to display");
-    }
+	/**
+	 * This method gets all the record from a particular table
+	 * @params void
+	 * @return associative array
+	 * @throws NoRecordFoundException
+	 */
+	public static function getAll()
+	{
+		$allData = DatabaseHandler::read($id = false, self::getClassName());
+		if (count($allData) > 0) {
+			return $allData;
+		}
+		throw NoRecordFoundException::checkNoRecordFoundException("There is no record to display");
+	}
     
-    /**
-     * This method create or update record in a database table
-     * @params void
-     * @return bool true or false;
-     * @throws EmptyArrayException
-     * @throws NoRecordInsertionException
-     * @throws NoRecordUpdateException
-     */
-    public function save()
-    {
-    	$boolCommit = false;
-    	if ($this->properties['id']) {
-    	    $allData = DatabaseHandler::read($id = $this->properties['id'], self::getClassName());
-    	    if ($this->checkIfRecordIsEmpty($allData)) {
-    	    	$boolCommit = $this->databaseModel->update(['id' => $this->properties['id']], $this->tableName, $this->properties);
-    	    	if ($boolCommit) {
-    	    	    return true;
-    	    	}
-    	    	throw NoRecordUpdateException::checkNoRecordUpdateException("Record not updated successfully");
-    	    }
-    	    throw EmptyArrayException::checkEmptyArrayException("Value passed didn't match any record");
-    	}
-    	$boolCommit = $this->databaseModel->create($this->properties, $this->tableName);
-    	if ($boolCommit) {
-    	    return true;
-    	}
-    	throw NoRecordInsertionException::checkNoRecordAddedException("Record not created successfully");
-    }
+	/**
+	 * This method create or update record in a database table
+	 * @params void
+	 * @return bool true or false;
+	 * @throws EmptyArrayException
+	 * @throws NoRecordInsertionException
+	 * @throws NoRecordUpdateException
+	 */
+	public function save()
+	{
+		$boolCommit = false;
+		if ($this->properties['id']) {
+			$allData = DatabaseHandler::read($id = $this->properties['id'], self::getClassName());
+			if ($this->checkIfRecordIsEmpty($allData)) {
+				$boolCommit = $this->databaseModel->update(['id' => $this->properties['id']], $this->tableName, $this->properties);
+				if ($boolCommit) {
+					return true;
+				}
+				throw NoRecordUpdateException::checkNoRecordUpdateException("Record not updated successfully");
+			}
+			throw EmptyArrayException::checkEmptyArrayException("Value passed didn't match any record");
+		}
+		$boolCommit = $this->databaseModel->create($this->properties, $this->tableName);
+		if ($boolCommit) {
+			return true;
+		}
+		throw NoRecordInsertionException::checkNoRecordAddedException("Record not created successfully");
+	}
 
-    /**
-     * This method find a record by id
-     * @params int id
-     * @return Object
-     * @throws NoArgumentPassedToFunctionException
-     */
-    public static function find($id)
-    {
-    	$num_args = (int) func_num_args(); // get number of arguments passed to
-    	if ($num_args == 0 || $num_args > 1) {
-    	    throw NoArgumentPassedToFunctionException::checkNoArgumentPassedToFunction("Argument missing: only one argument is allowed");
-    	}
-    	if ($id == "") {
-    		throw NullArgumentPassedToFunction::checkNullArgumentPassedToFunction("This function expect a value");
-    	}
-    	$staticFindInstance = new static();
-    	$staticFindInstance->id = $id == "" ? false : $id;
-    	return $staticFindInstance;
+	/**
+	 * This method find a record by id
+	 * @params int id
+	 * @return Object
+	 * @throws NoArgumentPassedToFunctionException
+	 */
+	public static function find($id)
+	{
+		$num_args = (int) func_num_args(); // get number of arguments passed to
+		if ($num_args == 0 || $num_args > 1) {
+			throw NoArgumentPassedToFunctionException::checkNoArgumentPassedToFunction("Argument missing: only one argument is allowed");
+		}
+		if ($id == "") {
+			throw NullArgumentPassedToFunction::checkNullArgumentPassedToFunction("This function expect a value");
+		}
+		$staticFindInstance = new static();
+		$staticFindInstance->id = $id == "" ? false : $id;
+		return $staticFindInstance;
     	
-    }
+	}
     
-    /**
-     * This method delete a row from the table by the row id
-     * @params int id
-     * @return boolean true or false
-     * @throws NoRecordDeletionException;
-     */
-    public static function destroy($id)
-    {
-    	$boolDeleted = false;
-    	$num_args = (int) func_num_args(); // get number of arguments passed to
+	/**
+	 * This method delete a row from the table by the row id
+	 * @params int id
+	 * @return boolean true or false
+	 * @throws NoRecordDeletionException;
+	 */
+	public static function destroy($id)
+	{
+		$boolDeleted = false;
+		$num_args = (int) func_num_args(); // get number of arguments passed to
     	
-    	if ($num_args == 0 || $num_args > 1) {
-    	    throw NoArgumentPassedToFunctionException::checkNoArgumentPassedToFunction("Argument missing: only one argument is allowed");
-    	}
-    	$boolDeleted = DatabaseHandler::delete($id, self::getClassName());
-    	if ($boolDeleted) {
-    	    return true;
-    	}
-    	throw NoRecordDeletionException::checkNoRecordUpdateException("Record deletion unsuccessful because id does not match any record");
+		if ($num_args == 0 || $num_args > 1) {
+			throw NoArgumentPassedToFunctionException::checkNoArgumentPassedToFunction("Argument missing: only one argument is allowed");
+		}
+		$boolDeleted = DatabaseHandler::delete($id, self::getClassName());
+		if ($boolDeleted) {
+			return true;
+		}
+		throw NoRecordDeletionException::checkNoRecordUpdateException("Record deletion unsuccessful because id does not match any record");
     	
-    }
+	}
 
    /**
     * This method return the current class name
@@ -156,12 +156,12 @@ 
     * @param $arrayOfRecord
     * @return bool
     */
-    public function checkIfRecordIsEmpty($arrayOfRecord)
-    {
-    	if (count($arrayOfRecord) > 0) {
-    	    return true;
-    	}
-    	return false;
-    }
+	public function checkIfRecordIsEmpty($arrayOfRecord)
+	{
+		if (count($arrayOfRecord) > 0) {
+			return true;
+		}
+		return false;
+	}
 
 }

src/Exceptions/NoRecordInsertionException.php

Spacing +1 added lines, -1 removed lines

@@ -6,7 +6,7 @@
  * @license  <https://opensource.org/license/MIT> MIT
  */
 
-namespace Laztopaz\potatoORM	;
+namespace Laztopaz\potatoORM;
 
 use Exception;
 

Indentation +4 added lines, -4 removed lines

@@ -12,8 +12,8 @@
 
 class NoRecordInsertionException extends Exception {
 
-    public static function checkNoRecordAddedException($mesaage)
-    {
-    	return new static($mesaage);
-    }
+	public static function checkNoRecordAddedException($mesaage)
+	{
+		return new static($mesaage);
+	}
 }

src/Database/DatabaseHelper.php

Unused Use Statements -1 removed lines

@@ -8,7 +8,6 @@
 
 namespace Laztopaz\potatoORM;
 
-use PDO;
 use Laztopaz\potatoORM\TableNotCreatedException;
 
 class DatabaseHelper {

Spacing +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
    	}
    	
    	$sql = 'CREATE TABLE IF NOT EXISTS '.$tableName.'(';
-   	$sql.= ' id INT( 11 ) AUTO_INCREMENT PRIMARY KEY, name VARCHAR( 100 ), gender VARCHAR( 10 ), alias VARCHAR( 150 ) NOT NULL, class VARCHAR( 150 ), stack VARCHAR( 50 ) )';
+   	$sql .= ' id INT( 11 ) AUTO_INCREMENT PRIMARY KEY, name VARCHAR( 100 ), gender VARCHAR( 10 ), alias VARCHAR( 150 ) NOT NULL, class VARCHAR( 150 ), stack VARCHAR( 50 ) )';
    	
    	return $conn->exec($sql);
    	throw TableNotCreatedException::tableNotCreatedException("Check your database connection");

Indentation +14 added lines, -14 removed lines

@@ -13,25 +13,25 @@
 
 class DatabaseHelper {
 	
-    public $dbConn;
+	public $dbConn;
     
-    /**
-     * This is a constructor; a default method  that will be called automatically during class instantiation
-     */
-    public function __construct($dbConnect)
-    {
-    	$this->dbConn = $dbConnect;
-    }
+	/**
+	 * This is a constructor; a default method  that will be called automatically during class instantiation
+	 */
+	public function __construct($dbConnect)
+	{
+		$this->dbConn = $dbConnect;
+	}
     
-    /**
-     * This method creates a particular table
-     * @param tableName
-     * $return boolean true or false
-     */
+	/**
+	 * This method creates a particular table
+	 * @param tableName
+	 * $return boolean true or false
+	 */
    public function createTable($tableName, $conn = NULL)
    {
    	if (is_null($conn)) {
-   	    $conn = $this->dbConn;
+   		$conn = $this->dbConn;
    	}
    	
    	$sql = 'CREATE TABLE IF NOT EXISTS '.$tableName.'(';

src/Exceptions/EmptyArrayException.php

Indentation +4 added lines, -4 removed lines

@@ -12,9 +12,9 @@
 
 class EmptyArrayException extends Exception {
 	
-    public static function checkEmptyArrayException($message)
-    {
-    	return new static($message);
-    }
+	public static function checkEmptyArrayException($message)
+	{
+		return new static($message);
+	}
 
 }

src/Exceptions/NoArgumentPassedToFunctionException.php

Indentation +4 added lines, -4 removed lines

@@ -12,9 +12,9 @@
 
 class NoArgumentPassedToFunctionException extends Exception {
 	
-    public static function checkNoArgumentPassedToFunction($message)
-    {
-    	return new static($message);
-    }
+	public static function checkNoArgumentPassedToFunction($message)
+	{
+		return new static($message);
+	}
 
 }

src/Exceptions/NoRecordUpdateException.php

Indentation +4 added lines, -4 removed lines

@@ -12,9 +12,9 @@
 
 class NoRecordUpdateException extends  Exception {
 	
-    public static function checkNoRecordUpdateException($message)
-    {
-    	return new static($message);
-    }
+	public static function checkNoRecordUpdateException($message)
+	{
+		return new static($message);
+	}
 
 }

src/Exceptions/WrongArgumentException.php

Indentation +4 added lines, -4 removed lines

@@ -12,9 +12,9 @@
 
 class WrongArgumentException extends Exception {
 
-    public function checkWrongArgumentException($message)
-    {
-    	return new static ($message);
-    }
+	public function checkWrongArgumentException($message)
+	{
+		return new static ($message);
+	}
 
 }

src/Database/DatabaseConnection.php

Spacing +10 added lines, -10 removed lines

@@ -23,11 +23,11 @@ 
     public  function  __construct() 
     {
     	$this->loadEnv(); // load the environment variables
-    	$this->databaseName     =  getenv('databaseName');
-    	$this->databaseHost     =  getenv('databaseHost');
-    	$this->databaseDriver   =  getenv('databaseDriver');
-    	$this->databaseUsername =  getenv('databaseUsername');
-    	$this->databasePassword =  getenv('databasePassword');
+    	$this->databaseName     = getenv('databaseName');
+    	$this->databaseHost     = getenv('databaseHost');
+    	$this->databaseDriver   = getenv('databaseDriver');
+    	$this->databaseUsername = getenv('databaseUsername');
+    	$this->databasePassword = getenv('databasePassword');
     	
     	try {
     	    $options = [
@@ -36,7 +36,7 @@ 
     	    	];
     	    	parent::__construct($this->getDatabaseDriver(), $this->databaseUsername, $this->databasePassword, $options);
     		
-    	} catch(PDOException $e) {
+    	} catch (PDOException $e) {
     	    return $e->getMessage();
     	}
     	
@@ -55,19 +55,19 @@ 
      	{
      	    case 'mysql':
      	    // Set DSN
-     	    $dsn = 'mysql:host='.$this->databaseHost.';dbname='. $this->databaseName;
+     	    $dsn = 'mysql:host='.$this->databaseHost.';dbname='.$this->databaseName;
      	    break;
      	    case 'sqlite':
      	    // Set DSN
-     	    $dsn = 'sqlite:host='.$this->databaseHost.';dbname='. $this->databaseName;
+     	    $dsn = 'sqlite:host='.$this->databaseHost.';dbname='.$this->databaseName;
      	    break;
      	    case 'pgsql':
      	    // Set DSN
-     	    $dsn = 'pgsqlsql:host='.$this->databaseHost.';dbname='. $this->databaseName;
+     	    $dsn = 'pgsqlsql:host='.$this->databaseHost.';dbname='.$this->databaseName;
      	    break;
      	    default:
      	    // Set DSN
-     	    $dsn = 'mysql:host='.$this->databaseHost.';dbname='. $this->databaseName;
+     	    $dsn = 'mysql:host='.$this->databaseHost.';dbname='.$this->databaseName;
      	}
      	return $dsn;
      }

Indentation +61 added lines, -61 removed lines

@@ -14,73 +14,73 @@
 
 class DatabaseConnection extends \PDO {
 	
-    private $databaseName;
-    private $databaseHost;
-    private $databaseDriver;
-    private $databaseUsername;
-    private $databasePassword;
+	private $databaseName;
+	private $databaseHost;
+	private $databaseDriver;
+	private $databaseUsername;
+	private $databasePassword;
     
-    public  function  __construct() 
-    {
-    	$this->loadEnv(); // load the environment variables
-    	$this->databaseName     =  getenv('databaseName');
-    	$this->databaseHost     =  getenv('databaseHost');
-    	$this->databaseDriver   =  getenv('databaseDriver');
-    	$this->databaseUsername =  getenv('databaseUsername');
-    	$this->databasePassword =  getenv('databasePassword');
+	public  function  __construct() 
+	{
+		$this->loadEnv(); // load the environment variables
+		$this->databaseName     =  getenv('databaseName');
+		$this->databaseHost     =  getenv('databaseHost');
+		$this->databaseDriver   =  getenv('databaseDriver');
+		$this->databaseUsername =  getenv('databaseUsername');
+		$this->databasePassword =  getenv('databasePassword');
     	
-    	try {
-    	    $options = [
-    	    	PDO::ATTR_PERSISTENT    => true,
-    	    	PDO::ATTR_ERRMODE       => PDO::ERRMODE_EXCEPTION
-                ];
-    	    	parent::__construct($this->getDatabaseDriver(), $this->databaseUsername, $this->databasePassword, $options);
+		try {
+			$options = [
+				PDO::ATTR_PERSISTENT    => true,
+				PDO::ATTR_ERRMODE       => PDO::ERRMODE_EXCEPTION
+				];
+				parent::__construct($this->getDatabaseDriver(), $this->databaseUsername, $this->databasePassword, $options);
     		
-    	} catch(PDOException $e) {
-    	    return $e->getMessage();
-    	}
+		} catch(PDOException $e) {
+			return $e->getMessage();
+		}
     	
-    }
+	}
 
-    /**
-     * This method determines the driver to be used for appropriate database server
-     * @params void
-     * @return string dsn
-     */
-     public function getDatabaseDriver()
-     {
-     	$dsn = "";
+	/**
+	 * This method determines the driver to be used for appropriate database server
+	 * @params void
+	 * @return string dsn
+	 */
+	 public function getDatabaseDriver()
+	 {
+	 	$dsn = "";
      	
-     	switch ($this->databaseDriver)
-     	{
-            case 'mysql':
-     	    // Set DSN
-     	    $dsn = 'mysql:host='.$this->databaseHost.';dbname='. $this->databaseName;
-     	    break;
-     	    case 'sqlite':
-     	    // Set DSN
-     	    $dsn = 'sqlite:host='.$this->databaseHost.';dbname='. $this->databaseName;
-     	    break;
-     	    case 'pgsql':
-     	    // Set DSN
-     	    $dsn = 'pgsqlsql:host='.$this->databaseHost.';dbname='. $this->databaseName;
-     	    break;
-     	    default:
-     	    // Set DSN
-     	    $dsn = 'mysql:host='.$this->databaseHost.';dbname='. $this->databaseName;
-     	}
-     	return $dsn;
-     }
+	 	switch ($this->databaseDriver)
+	 	{
+			case 'mysql':
+	 		// Set DSN
+	 		$dsn = 'mysql:host='.$this->databaseHost.';dbname='. $this->databaseName;
+	 		break;
+	 		case 'sqlite':
+	 		// Set DSN
+	 		$dsn = 'sqlite:host='.$this->databaseHost.';dbname='. $this->databaseName;
+	 		break;
+	 		case 'pgsql':
+	 		// Set DSN
+	 		$dsn = 'pgsqlsql:host='.$this->databaseHost.';dbname='. $this->databaseName;
+	 		break;
+	 		default:
+	 		// Set DSN
+	 		$dsn = 'mysql:host='.$this->databaseHost.';dbname='. $this->databaseName;
+	 	}
+	 	return $dsn;
+	 }
 
-     /**
-      * Load Dotenv to grant getenv() access to environment variables in .env file
-      */
-     public function loadEnv()
-     {
-     	if (!getenv("APP_ENV")) {
-     	    $dotenv = new Dotenv(__DIR__.'/../../');
-     	    $dotenv->load();
-     	}
-     }
+	 /**
+	  * Load Dotenv to grant getenv() access to environment variables in .env file
+	  */
+	 public function loadEnv()
+	 {
+	 	if (!getenv("APP_ENV")) {
+	 		$dotenv = new Dotenv(__DIR__.'/../../');
+	 		$dotenv->load();
+	 	}
+	 }
 
 }

src/Interface/InterfaceBaseClass.php

Indentation +6 added lines, -6 removed lines

@@ -10,12 +10,12 @@
 
 interface InterfaceBaseClass {
 
-    /**
-     * This method gets all the record from a particular table
-     * @params void
-     * @return associative array
-     */
-    public static function getAll();
+	/**
+	 * This method gets all the record from a particular table
+	 * @params void
+	 * @return associative array
+	 */
+	public static function getAll();
    
    /**
     * This method create or update record in a database table