andela-tolotin / Potato-ORM

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 +7 added lines, -7 removed lines

@@ -51,7 +51,7 @@ 
         $unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($tableFields, $associative1DArray);
       
         if (count($unexpectedFields) > 0) {
-            throw TableFieldUndefinedException::reportUnknownTableField($unexpectedFields,"needs to be created as a table field");
+            throw TableFieldUndefinedException::reportUnknownTableField($unexpectedFields, "needs to be created as a table field");
         }
 
         unset($associative1DArray[0]);
@@ -76,7 +76,7 @@ 
     {
         $insertQuery = 'INSERT INTO '.$tableName;
 
-        $TableValues = implode(',',array_keys($associative1DArray));
+        $TableValues = implode(',', array_keys($associative1DArray));
 
         foreach ($associative1DArray as $field => $value) {
             $FormValues[] = "'".trim(addslashes($value))."'";
@@ -84,8 +84,8 @@ 
 
         $splittedTableValues = implode(',', $FormValues);
 
-        $insertQuery.= ' ('.$TableValues.')';
-        $insertQuery.= ' VALUES ('.$splittedTableValues.')';
+        $insertQuery .= ' ('.$TableValues.')';
+        $insertQuery .= ' VALUES ('.$splittedTableValues.')';
 
         $executeQuery = $dbConn->exec($insertQuery);
 
@@ -216,7 +216,7 @@ 
       $unexpectedFields = [];
 
       foreach ($userSetterArray as $key => $val) {
-          if (!in_array($key,$tableColumn)) {
+          if (!in_array($key, $tableColumn)) {
               $unexpectedFields[] = $key;
           }
       }
@@ -232,11 +232,11 @@ 
    */
   public function prepareUpdateQuery($sql)
   {
-      $splittedQuery = explode(",",$sql);
+      $splittedQuery = explode(",", $sql);
 
       array_pop($splittedQuery);
 
-      $mergeData = implode(",",$splittedQuery);
+      $mergeData = implode(",", $splittedQuery);
 
       return $mergeData;
 

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

src/Model/BaseModel.php

Doc Comments +2 added lines, -2 removed lines

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

src/Database/DatabaseConnection.php

Spacing +7 added lines, -7 removed lines

@@ -24,11 +24,11 @@ 
     {
         $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 = [
@@ -38,7 +38,7 @@ 
 
         parent::__construct($this->getDatabaseDriver(), $this->databaseUsername, $this->databasePassword, $options);
             
-        } catch(PDOException $e) {
+        } catch (PDOException $e) {
             return $e->getMessage();
 
         }
@@ -78,7 +78,7 @@ 
       */
      public function loadEnv()
      {
-        if (! getenv("APP_ENV")) {
+        if (!getenv("APP_ENV")) {
             $dotenv = new Dotenv(__DIR__.'/../../');
             $dotenv->load();
         }

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

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;