andela-tolotin / Potato-ORM

src/Model/BaseModel.php

Doc Comments +2 added lines, -2 removed lines

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

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;
 

src/Helper/Inflector.php

Spacing +9 added lines, -9 removed lines

@@ -74,14 +74,14 @@ 
 			'sex' => 'sexes',
 			'move' => 'moves');
 		$lowercased_word = strtolower($word);
-		foreach ($uncountable as $_uncountable){
-			if(substr($lowercased_word,(-1*strlen($_uncountable))) == $_uncountable){
+		foreach ($uncountable as $_uncountable) {
+			if (substr($lowercased_word, (-1*strlen($_uncountable))) == $_uncountable) {
 				return $word;
 			}
 		}
-		foreach ($irregular as $_plural=> $_singular){
+		foreach ($irregular as $_plural=> $_singular) {
 			if (preg_match('/('.$_plural.')$/i', $word, $arr)) {
-				return preg_replace('/('.$_plural.')$/i', substr($arr[0],0,1).substr($_singular,1), $word);
+				return preg_replace('/('.$_plural.')$/i', substr($arr[0], 0, 1).substr($_singular, 1), $word);
 			}
 		}
 		foreach ($plural as $rule => $replacement) {
@@ -101,7 +101,7 @@ 
 	 */
 	public function singularize($word)
 	{
-		$singular = array (
+		$singular = array(
 			'/(quiz)zes$/i'             => "$1",
 			'/(matr)ices$/i'            => "$1ix",
 			'/(vert|ind)ices$/i'        => "$1ex",
@@ -139,14 +139,14 @@ 
 			'sex' => 'sexes',
 			'move' => 'moves');
 		$lowercased_word = strtolower($word);
-		foreach ($uncountable as $_uncountable){
-			if(substr($lowercased_word,(-1*strlen($_uncountable))) == $_uncountable){
+		foreach ($uncountable as $_uncountable) {
+			if (substr($lowercased_word, (-1*strlen($_uncountable))) == $_uncountable) {
 				return $word;
 			}
 		}
-		foreach ($irregular as $_plural=> $_singular){
+		foreach ($irregular as $_plural=> $_singular) {
 			if (preg_match('/('.$_singular.')$/i', $word, $arr)) {
-				return preg_replace('/('.$_singular.')$/i', substr($arr[0],0,1).substr($_plural,1), $word);
+				return preg_replace('/('.$_singular.')$/i', substr($arr[0], 0, 1).substr($_plural, 1), $word);
 			}
 		}
 		foreach ($singular as $rule => $replacement) {

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;
 

src/Database/DatabaseHandler.php

Unused Use Statements -1 removed lines

@@ -9,7 +9,6 @@
 namespace Laztopaz\potatoORM;
 
 use PDO;
-use Laztopaz\potatoORM\DatabaseHelper;
 use Laztopaz\potatoORM\TableFieldUndefinedException;
 use Laztopaz\potatoORM\EmptyArrayException;
 

Doc Comments +11 added lines, -2 removed lines

@@ -22,6 +22,7 @@ 
 
 	/**
 	 * This is a constructor; a default method  that will be called automatically during class instantiation
+	 * @param string|false $modelClassName
 	 */
 	public function __construct($modelClassName, $dbConn = Null)
 	{
@@ -36,7 +37,8 @@ 
 	/**
 	 * This method create a record and store it in a table row
 	 * @params associative array, string tablename
-	 * @return boolean true or false
+	 * @param string|false $tableName
+	 * @return boolean|null true or false
 	 */
 	public function create($associative1DArray, $tableName, $dbConn = Null)
 	{
@@ -79,6 +81,10 @@ 
 	 * @params: $updateParams, $tableName, $associative1DArray
 	 * @return boolean true or false
 	 */
+
+	/**
+	 * @param string|false $tableName
+	 */
 	public function update(array $updateParams, $tableName, $associative1DArray, $dbConn = Null)
 	{
 		$sql = "";
@@ -112,6 +118,7 @@ 
 	/**
 	 * This method retrieves record from a table
 	 * @params int id, string tableName
+	 * @param string|false $tableName
 	 * @return array
 	 */
 	public static function read($id, $tableName, $dbConn = Null)
@@ -143,6 +150,7 @@ 
 	/**
 	 * This method deletes a record  from a table row
 	 * @params int id, string tableName
+	 * @param string|false $tableName
 	 * @return boolean true or false
 	 */
 	public static function delete($id, $tableName, $dbConn = Null)
@@ -177,7 +185,7 @@ 
 
 	/**
 	 * This method returns sql query
-	 * @param $sql
+	 * @param string $sql
 	 * @return string
 	 */
 	public function prepareUpdateQuery($sql)
@@ -219,6 +227,7 @@ 
 	 * This method returns column fields of a particular table
 	 * @param $table
 	 * @param $conn
+	 * @param DatabaseConnection $dbConn
 	 * @return array
 	 */
 	public function getColumnNames($table, $dbConn = Null) {

Spacing +17 added lines, -17 removed lines

@@ -42,10 +42,10 @@ 
 	{
 		$tableFields = $this->getColumnNames($this->model, $this->dbConnection);
 
-		$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($tableFields,$associative1DArray);
+		$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($tableFields, $associative1DArray);
 
 		if (count($unexpectedFields) > 0) {
-			throw TableFieldUndefinedException::fieldsNotDefinedException($unexpectedFields,"needs to be created as table field");
+			throw TableFieldUndefinedException::fieldsNotDefinedException($unexpectedFields, "needs to be created as table field");
 		}
 		unset($tableFields[0]);
 
@@ -60,17 +60,17 @@ 
 	private function  insertRecord($dbConn, $tableName, $associative1DArray) {
 
 		$insertQuery = 'INSERT INTO '.$tableName;
-		$TableValues = implode(',',array_keys($associative1DArray));
+		$TableValues = implode(',', array_keys($associative1DArray));
 		foreach ($associative1DArray as $field => $value) {
 
 			$FormValues[] = "'".trim(addslashes($value))."'";
 		}
 		$splittedTableValues = implode(',', $FormValues);
-		$insertQuery.= ' ('.$TableValues.')';
-		$insertQuery.= ' VALUES ('.$splittedTableValues.')';
+		$insertQuery .= ' ('.$TableValues.')';
+		$insertQuery .= ' VALUES ('.$splittedTableValues.')';
 		$executeQuery = $dbConn->exec($insertQuery);
 
-		return $executeQuery ? : false;
+		return $executeQuery ?: false;
 	}
 
 	/*
@@ -87,13 +87,13 @@ 
 
 		$updateSql = "UPDATE `$tableName` SET ";
 		unset($associative1DArray['id']);
-		$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($this->getColumnNames($this->model, $this->dbConnection),$associative1DArray);
+		$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($this->getColumnNames($this->model, $this->dbConnection), $associative1DArray);
 
 		if (count($unexpectedFields) > 0) {
 			throw TableFieldUndefinedException::fieldsNotDefinedException($unexpectedFields, "needs to be created as table field");
 		}
 
-		foreach($associative1DArray as $field => $value) {
+		foreach ($associative1DArray as $field => $value) {
 			$sql .= "`$field` = '$value'".",";
 		}
 
@@ -105,7 +105,7 @@ 
 		$stmt = $dbConn->prepare($updateSql);
 		$boolResponse = $stmt->execute();
 
-		return $boolResponse ?  : false;
+		return $boolResponse ?: false;
 	}
 
 	/**
@@ -120,7 +120,7 @@ 
 		if (is_null($dbConn)) {
 			$dbConn = new DatabaseConnection();
 		}
-		$sql = $id  ? 'SELECT * FROM '.$tableName.' WHERE id = '.$id : 'SELECT * FROM '.$tableName;
+		$sql = $id ? 'SELECT * FROM '.$tableName.' WHERE id = '.$id : 'SELECT * FROM '.$tableName;
 
 		try {
 			$stmt = $dbConn->prepare($sql);
@@ -132,7 +132,7 @@ 
 		}
 		$results = $stmt->fetchAll(PDO::FETCH_ASSOC);
 
-		foreach($results as $result) {
+		foreach ($results as $result) {
 			array_push($tableData, $result);
 		}
 
@@ -152,7 +152,7 @@ 
 		$sql = 'DELETE FROM '.$tableName.' WHERE id = '.$id;
 		$boolResponse = $dbConn->exec($sql);
 
-		return $boolResponse ? : false;
+		return $boolResponse ?: false;
 	}
 
 	/**
@@ -166,7 +166,7 @@ 
 		$unexpectedFields = [];
 
 		foreach ($userSetterArray as $key => $val) {
-			if (!in_array($key,$tableColumn)) {
+			if (!in_array($key, $tableColumn)) {
 
 				$unexpectedFields[] = $key;
 			}
@@ -181,9 +181,9 @@ 
 	 */
 	public function prepareUpdateQuery($sql)
 	{
-		$splittedQuery = explode(",",$sql);
+		$splittedQuery = explode(",", $sql);
 		array_pop($splittedQuery);
-		$mergeData = implode(",",$splittedQuery);
+		$mergeData = implode(",", $splittedQuery);
 
 		return $mergeData;
 	}
@@ -208,7 +208,7 @@ 
 			$statement = $dbConn->prepare($sql);
 			$statement->execute();
 			$returnedRowNumbers = $statement->rowCount();
-			return $returnedRowNumbers  ? true : false;
+			return $returnedRowNumbers ? true : false;
 		}
 
 		throw EmptyArrayException::checkEmptyArrayException("Array Expected: parameter passed to this function is not an array");
@@ -234,7 +234,7 @@ 
 		$stmt->execute();
 		$results = $stmt->fetchAll(PDO::FETCH_ASSOC);
 
-		foreach($results as $result) {
+		foreach ($results as $result) {
 			array_push($tableFields, $result['Field']);
 		}
 			return $tableFields;

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 @@
 			$conn = $this->dbConn;
 		}
 		$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);
 

src/Exceptions/NoRecordDeletionException.php

Indentation +4 added lines, -4 removed lines

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

src/Database/DatabaseConnection.php

Indentation +3 added lines, -3 removed lines

@@ -21,8 +21,8 @@ 
 
 	public  function  __construct() 
 	{
-	    $this->loadEnv(); // load the environment variables
-	    $this->databaseName     =  getenv('databaseName');
+		$this->loadEnv(); // load the environment variables
+		$this->databaseName     =  getenv('databaseName');
 		$this->databaseHost     =  getenv('databaseHost');
 		$this->databaseDriver   =  getenv('databaseDriver');
 		$this->databaseUsername =  getenv('databaseUsername');
@@ -78,7 +78,7 @@ 
 	{
 		if (!getenv("APP_ENV")) {
 			$dotenv = new Dotenv(__DIR__.'/../../');
-		    $dotenv->load();
+			$dotenv->load();
 		}
 
 	}

Spacing +10 added lines, -10 removed lines

@@ -22,11 +22,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 = [
@@ -34,7 +34,7 @@ 
 			PDO::ATTR_ERRMODE       => PDO::ERRMODE_EXCEPTION
 			];
 			parent::__construct($this->getDatabaseDriver(), $this->databaseUsername, $this->databasePassword, $options);
-			} catch(PDOException $e) {
+			} catch (PDOException $e) {
 
 			return $e->getMessage();
 		}
@@ -53,20 +53,20 @@ 
 		{
 			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;
 	}