andela-tolotin / Potato-ORM

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/DatabaseHelper.php

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");

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;
      }

src/Model/BaseModel.php

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()
    {

src/Database/DatabaseHandler.php

Doc Comments +7 added lines, -1 removed lines

@@ -21,6 +21,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)
      {
@@ -35,6 +36,7 @@ 
     /**
      * This method create a record and store it in a table row
      * @params associative array, string tablename
+     * @param string|false $tableName
      * @return boolean true or false
      */
     public function create($associative1DArray, $tableName, $dbConn = Null)
@@ -69,6 +71,7 @@ 
     /**
      * This method updates any table by supplying 3 parameter
      * @params: $updateParams, $tableName, $associative1DArray
+     * @param string|false $tableName
      * @return boolean true or false
      */
     public function update(array $updateParams, $tableName, $associative1DArray, $dbConn = Null)
@@ -101,6 +104,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)
@@ -131,6 +135,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)
@@ -163,7 +168,7 @@ 
   
   /**
    * This method returns sql query
-   * @param $sql
+   * @param string $sql
    * @return string
    */
   public function prepareUpdateQuery($sql)
@@ -204,6 +209,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 +14 added lines, -14 removed lines

@@ -42,9 +42,9 @@ 
      */
     public function create($associative1DArray, $tableName, $dbConn = Null) {
     	$tableFields = $this->getColumnNames($this->model, $this->dbConnection);
-    	$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($tableFields,$associative1DArray);
+    	$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($tableFields, $associative1DArray);
     	if (count($unexpectedFields) > 0) {
-    	    throw TableFieldUndefinedException::reportUnknownTableField($unexpectedFields,"needs to be created as table field");
+    	    throw TableFieldUndefinedException::reportUnknownTableField($unexpectedFields, "needs to be created as table field");
     	}
       unset($associative1DArray[0]);
     	if (is_null($dbConn)) {
@@ -55,13 +55,13 @@ 
     
     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);
 
       if ($executeQuery) {
@@ -85,12 +85,12 @@ 
     	}
     	$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::reportUnknownTableField($unexpectedFields, "needs to be created as table field");
     	}
-    	foreach($associative1DArray as $field => $value) {
+    	foreach ($associative1DArray as $field => $value) {
     	    $sql .= "`$field` = '$value'".",";
     	}
     	
@@ -123,7 +123,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);
@@ -135,7 +135,7 @@ 
    	}
    	$results = $stmt->fetchAll(PDO::FETCH_ASSOC);
    	
-   	foreach($results as $result) {
+   	foreach ($results as $result) {
    	    array_push($tableData, $result);
    	}
    	return $tableData;
@@ -174,7 +174,7 @@ 
   {
       $unexpectedFields = [];
       foreach ($userSetterArray as $key => $val) {
-          if (!in_array($key,$tableColumn)) {
+          if (!in_array($key, $tableColumn)) {
               $unexpectedFields[] = $key;
           }
       }
@@ -188,9 +188,9 @@ 
    */
   public function prepareUpdateQuery($sql)
   {
-      $splittedQuery = explode(",",$sql);
+      $splittedQuery = explode(",", $sql);
       array_pop($splittedQuery);
-      $mergeData = implode(",",$splittedQuery);
+      $mergeData = implode(",", $splittedQuery);
       return $mergeData;
   }
   
@@ -215,7 +215,7 @@ 
           $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");
   }
@@ -239,7 +239,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/Exceptions/TableFieldUndefinedException.php

Spacing +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 
 	public static function reportUnknownTableField($unExpectedFields, $message)
 	{
-		$fields = implode(", ",$unExpectedFields);
+		$fields = implode(", ", $unExpectedFields);
 
 		//var_dump($fields);
 

src/Helper/Inflector.php

Spacing +4 added lines, -4 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) {