andela-iadeniyi / Potato-ORM

src/Database/DatabaseQuery.php

Doc Comments +8 added lines, -3 removed lines

@@ -62,7 +62,7 @@ 
      * @param  $tablename
      * @param  $con
      *
-     * @return bool
+     * @return boolean|null
      */
     public function checkTableExist($table, $con=NULL)
     {
@@ -77,7 +77,7 @@ 
     /**
      * checkTableName Return the table name
      *
-     * @param  $tablename
+     * @param  string|false $tablename
      * @param  $con
      *
      * @return string
@@ -101,7 +101,7 @@ 
      * checkColumn Check if column exist in table
      *
      * @param  $tableName
-     * @param  $columnName
+     * @param  string $columnName
      * @param  $con
      *
      * @return string
@@ -194,6 +194,7 @@ 
     /**
      * selectAllQuery
      *
+     * @param string $tableName
      * @return string
      */
     public static function selectAllQuery($tableName)
@@ -229,6 +230,8 @@ 
     /**
      * selectQuery
      *
+     * @param string $tableName
+     * @param string $connection
      * @return string
      */
     public static function selectQuery($tableName, $data, $condition, $connection)
@@ -256,6 +259,7 @@ 
     /**
      * insertQuery
      *
+     * @param string $tableName
      * @return string
      */
     public function insertQuery($tableName)
@@ -273,6 +277,7 @@ 
     /**
      * updateQuery
      *
+     * @param string $tableName
      * @return string
      */
     public function updateQuery($tableName)

Unused Use Statements -1 removed lines

@@ -13,7 +13,6 @@
 use PDOException;
 use Ibonly\PotatoORM\DatabaseQueryInterface;
 use Ibonly\PotatoORM\ColumnNotExistExeption;
-use Ibonly\PotatoORM\InvalidConnectionException;
 use Ibonly\PotatoORM\TableDoesNotExistException;
 
 class DatabaseQuery implements DatabaseQueryInterface

Indentation +7 added lines, -7 removed lines

@@ -1,12 +1,12 @@
 <?php
 /**
- * This class handles building sql query statement and check
- * that the table exist in the database.
- *
- * @package Ibonly\PotatoORM\DatabaseQuery
- * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
- * @license MIT <https://opensource.org/licenses/MIT>
- */
+     * This class handles building sql query statement and check
+     * that the table exist in the database.
+     *
+     * @package Ibonly\PotatoORM\DatabaseQuery
+     * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
+     * @license MIT <https://opensource.org/licenses/MIT>
+     */
 
 namespace Ibonly\PotatoORM;
 

Braces +7 added lines, -6 removed lines

@@ -136,8 +136,9 @@ 
         {
             $counter++;
             $insertQuery .= self::sanitize($key);
-            if( $arraySize > $counter )
-                $insertQuery .= ", ";
+            if( $arraySize > $counter ) {
+                            $insertQuery .= ", ";
+            }
         }
         return $insertQuery;
     }
@@ -159,8 +160,9 @@ 
         {
             $counter++;
             $insertQuery .= "'".self::sanitize($value) ."'";
-            if( $arraySize > $counter )
-                $insertQuery .= ", ";
+            if( $arraySize > $counter ) {
+                            $insertQuery .= ", ";
+            }
         }
         return $insertQuery;
     }
@@ -240,8 +242,7 @@ 
             if( $arraySize > 1 && $condition == NULL)
             {
                 $query = "Please Supply the condition";
-            }
-            else
+            } else
             {
                 $columnName = self::whereAndClause($tableName, $data, $condition);
                 $query =  "SELECT * FROM $tableName WHERE $columnName";

Spacing +26 added lines, -26 removed lines

@@ -49,7 +49,7 @@ 
      */
     protected static function checkConnection($con)
     {
-        if( $con === null )
+        if ($con === null)
         {
             $con = self::connect();
         }
@@ -64,11 +64,11 @@ 
      *
      * @return bool
      */
-    public function checkTableExist($table, $con=NULL)
+    public function checkTableExist($table, $con = NULL)
     {
         $connection = $this->checkConnection($con);
         $query = $connection->query("SELECT 1 FROM {$table} LIMIT 1");
-        if( $query !== false )
+        if ($query !== false)
         {
             return true;
         }
@@ -82,12 +82,12 @@ 
      *
      * @return string
      */
-    public static function checkTableName($tableName, $con=NULL)
+    public static function checkTableName($tableName, $con = NULL)
     {
         $connection = self::checkConnection($con);
 
         $query = $connection->query("SELECT 1 FROM {$tableName} LIMIT 1");
-        if( $query !== false )
+        if ($query !== false)
         {
             return $tableName;
         }
@@ -103,13 +103,13 @@ 
      *
      * @return string
      */
-    protected static function checkColumn($tableName, $columnName, $con=NULL)
+    protected static function checkColumn($tableName, $columnName, $con = NULL)
     {
         $connection = self::checkConnection($con);
 
             $result = $connection->prepare("SELECT {$columnName} FROM {$tableName}");
             $result->execute();
-            if ( ! $result->columnCount() )
+            if ( ! $result->columnCount())
             {
                 throw new ColumnNotExistExeption();
             }
@@ -129,11 +129,11 @@ 
         $insertQuery = "";
         $arraySize = count($data);
 
-        foreach ( $data as $key => $value )
+        foreach ($data as $key => $value)
         {
             $counter++;
             $insertQuery .= self::sanitize($key);
-            if( $arraySize > $counter )
+            if ($arraySize > $counter)
                 $insertQuery .= ", ";
         }
         return $insertQuery;
@@ -152,11 +152,11 @@ 
         $insertQuery = "";
         $arraySize = count($data);
 
-        foreach ( $data as $key => $value )
+        foreach ($data as $key => $value)
         {
             $counter++;
-            $insertQuery .= "'".self::sanitize($value) ."'";
-            if( $arraySize > $counter )
+            $insertQuery .= "'".self::sanitize($value)."'";
+            if ($arraySize > $counter)
                 $insertQuery .= ", ";
         }
         return $insertQuery;
@@ -175,12 +175,12 @@ 
         $updateQuery = "";
         $arraySize = count($data);
 
-        foreach ( $data as $key => $value )
+        foreach ($data as $key => $value)
         {
             $counter++;
             $columnName = self::checkColumn($tableName, self::sanitize($key));
-            $updateQuery .= $columnName ." = '".self::sanitize($value)."'";
-            if ( $arraySize > $counter )
+            $updateQuery .= $columnName." = '".self::sanitize($value)."'";
+            if ($arraySize > $counter)
             {
                 $updateQuery .= ", ";
             }
@@ -209,14 +209,14 @@ 
         $counter = 0;
         $arraySize = count($data);
 
-        foreach ( $data as $key => $value )
+        foreach ($data as $key => $value)
         {
             $counter++;
             $columnName = self::checkColumn($tableName, self::sanitize($key));
-            $where .= $columnName ." = '".self::sanitize($value)."'";
-            if ( $arraySize > $counter )
+            $where .= $columnName." = '".self::sanitize($value)."'";
+            if ($arraySize > $counter)
             {
-                $where .= " " . $condition . " ";
+                $where .= " ".$condition." ";
             }
         }
 
@@ -234,16 +234,16 @@ 
         try
         {
             $arraySize = count($data);
-            if( $arraySize > 1 && $condition == NULL)
+            if ($arraySize > 1 && $condition == NULL)
             {
                 $query = "Please Supply the condition";
             }
             else
             {
                 $columnName = self::whereAndClause($tableName, $data, $condition);
-                $query =  "SELECT * FROM $tableName WHERE $columnName";
+                $query = "SELECT * FROM $tableName WHERE $columnName";
             }
-        } catch ( PDOException $e ) {
+        } catch (PDOException $e) {
             $query = $e->getMessage();
         }
 
@@ -257,7 +257,7 @@ 
      */
     public function insertQuery($tableName)
     {
-        $data = ( array )$this;
+        $data = (array)$this;
         array_shift($data);
 
         $columnNames = self::buildColumn($data);
@@ -274,11 +274,11 @@ 
      */
     public function updateQuery($tableName)
     {
-        $data = ( array ) $this;
-        $data = array_slice ($data, 2);
+        $data = (array)$this;
+        $data = array_slice($data, 2);
 
         $values = self::buildClause($tableName, $data);
-        $updateQuery = "UPDATE $tableName SET {$values} WHERE id = ". self::sanitize($this->id);
+        $updateQuery = "UPDATE $tableName SET {$values} WHERE id = ".self::sanitize($this->id);
 
         return $updateQuery;
     }

src/Database/DBConfig.php

Braces +2 added lines, -4 removed lines

@@ -42,12 +42,10 @@
             if ($this->driver === 'pgsql' || $this->driver === 'postgres')
             {
                 parent::__construct($this->pgsqlConnectionString());
-            }
-            elseif ($this->driver === 'mysql')
+            } elseif ($this->driver === 'mysql')
             {
                 parent::__construct($this->mysqlConnectionString(), $this->user, $this->password);
-            }
-            elseif($this->driver === 'sqlite')
+            } elseif($this->driver === 'sqlite')
             {
                 parent::__construct($this->sqlitConnectionString());
             }

Spacing +5 added lines, -5 removed lines

@@ -47,7 +47,7 @@ 
             {
                 parent::__construct($this->mysqlConnectionString(), $this->user, $this->password);
             }
-            elseif($this->driver === 'sqlite')
+            elseif ($this->driver === 'sqlite')
             {
                 parent::__construct($this->sqlitConnectionString());
             }
@@ -63,7 +63,7 @@ 
      */
     protected function pgsqlConnectionString()
     {
-        return $this->driver . ':host=' . $this->host . ';port=' . $this->port . ';dbname=' . $this->dbname . ';user=' . $this->user . ';password=' . $this->password;
+        return $this->driver.':host='.$this->host.';port='.$this->port.';dbname='.$this->dbname.';user='.$this->user.';password='.$this->password;
     }
 
     /**
@@ -73,7 +73,7 @@ 
      */
     protected function mysqlConnectionString()
     {
-        return $this->driver . ':host=' . $this->host . ';dbname=' . $this->dbname . ';charset=utf8mb4';
+        return $this->driver.':host='.$this->host.';dbname='.$this->dbname.';charset=utf8mb4';
     }
 
     /**
@@ -83,7 +83,7 @@ 
      */
     protected function sqlitConnectionString()
     {
-        return $this->driver . ':' . $this->sqlitePath;
+        return $this->driver.':'.$this->sqlitePath;
     }
 
     /**
@@ -91,7 +91,7 @@ 
      */
     protected function loadEnv()
     {
-        if( ! getenv("APP_ENV"))
+        if ( ! getenv("APP_ENV"))
         {
             $dotenv = new Dotenv($_SERVER['DOCUMENT_ROOT']);
             $dotenv->load();

src/Exceptions/ColumnNotExistExeption.php

Indentation +6 added lines, -6 removed lines

@@ -1,11 +1,11 @@
 <?php
 /**
- * Exception for user not found
- *
- * @package Ibonly\PotatoORM\ColumnNotExistExeption
- * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
- * @license MIT <https://opensource.org/licenses/MIT>
- */
+     * Exception for user not found
+     *
+     * @package Ibonly\PotatoORM\ColumnNotExistExeption
+     * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
+     * @license MIT <https://opensource.org/licenses/MIT>
+     */
 
 namespace Ibonly\PotatoORM;
 

src/Exceptions/EmptyDatabaseException.php

Indentation +6 added lines, -6 removed lines

@@ -1,11 +1,11 @@
 <?php
 /**
- * Exception for no records in database
- *
- * @package Ibonly\PotatoORM\EmptyDatabaseException
- * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
- * @license MIT <https://opensource.org/licenses/MIT>
- */
+     * Exception for no records in database
+     *
+     * @package Ibonly\PotatoORM\EmptyDatabaseException
+     * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
+     * @license MIT <https://opensource.org/licenses/MIT>
+     */
 
 namespace Ibonly\PotatoORM;
 

Spacing +1 added lines, -1 removed lines

@@ -25,6 +25,6 @@
      */
     public function errorMessage()
     {
-        return "Error: " . $this->getMessage();
+        return "Error: ".$this->getMessage();
     }
 }
\ No newline at end of file

src/Exceptions/ErrorInsertingException.php

Indentation +6 added lines, -6 removed lines

@@ -1,11 +1,11 @@
 <?php
 /**
- * Exception for user already exist
- *
- * @package Ibonly\PotatoORM\ErrorInsertingException
- * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
- * @license MIT <https://opensource.org/licenses/MIT>
- */
+     * Exception for user already exist
+     *
+     * @package Ibonly\PotatoORM\ErrorInsertingException
+     * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
+     * @license MIT <https://opensource.org/licenses/MIT>
+     */
 
 namespace Ibonly\PotatoORM;
 

Spacing +1 added lines, -1 removed lines

@@ -25,6 +25,6 @@
      */
     public function errorMessage()
     {
-        return "Error: " . $this->getMessage();
+        return "Error: ".$this->getMessage();
     }
 }
\ No newline at end of file

src/Exceptions/InvalidConnectionException.php

Indentation +6 added lines, -6 removed lines

@@ -1,11 +1,11 @@
 <?php
 /**
- * Exception for user not found
- *
- * @package Ibonly\PotatoORM\InvalidConnectionException
- * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
- * @license MIT <https://opensource.org/licenses/MIT>
- */
+     * Exception for user not found
+     *
+     * @package Ibonly\PotatoORM\InvalidConnectionException
+     * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
+     * @license MIT <https://opensource.org/licenses/MIT>
+     */
 
 namespace Ibonly\PotatoORM;
 

src/Exceptions/TableDoesNotExistException.php

Indentation +6 added lines, -6 removed lines

@@ -1,11 +1,11 @@
 <?php
 /**
- * Exception for user not found
- *
- * @package Ibonly\PotatoORM\TableDoesNotExistException
- * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
- * @license MIT <https://opensource.org/licenses/MIT>
- */
+     * Exception for user not found
+     *
+     * @package Ibonly\PotatoORM\TableDoesNotExistException
+     * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
+     * @license MIT <https://opensource.org/licenses/MIT>
+     */
 
 namespace Ibonly\PotatoORM;
 

src/Helper/Inflector.php

Indentation +14 added lines, -14 removed lines

@@ -39,13 +39,13 @@ 
 trait Inflector
 {
     /**
-    * Pluralizes English nouns.
-    *
-    * @access public
-    * @static
-    * @param    string    $word    English noun to pluralize
-    * @return string Plural noun
-    */
+     * Pluralizes English nouns.
+     *
+     * @access public
+     * @static
+     * @param    string    $word    English noun to pluralize
+     * @return string Plural noun
+     */
     public static function pluralize($word)
     {
         $plural = array(
@@ -102,13 +102,13 @@ 
     }
 
     /**
-    * Singularizes English nouns.
-    *
-    * @access public
-    * @static
-    * @param    string    $word    English noun to singularize
-    * @return string Singular noun.
-    */
+     * Singularizes English nouns.
+     *
+     * @access public
+     * @static
+     * @param    string    $word    English noun to singularize
+     * @return string Singular noun.
+     */
     public function singularize($word)
     {
         $singular = array (

Spacing +9 added lines, -9 removed lines

@@ -81,15 +81,15 @@ 
 
         $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);
             }
         }
 
@@ -111,7 +111,7 @@ 
     */
     public function singularize($word)
     {
-        $singular = array (
+        $singular = array(
             '/(quiz)zes$/i'             => "$1",
             '/(matr)ices$/i'            => "$1ix",
             '/(vert|ind)ices$/i'        => "$1ex",
@@ -152,15 +152,15 @@ 
         '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);
             }
         }
 

src/Helper/Model.php

Indentation +6 added lines, -6 removed lines

@@ -1,11 +1,11 @@
 <?php
 /**
- * PotatoORM manages the persistence of database CRUD operations.
- *
- * @package Ibonly\PotatoORM\Model
- * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
- * @license MIT <https://opensource.org/licenses/MIT>
- */
+     * PotatoORM manages the persistence of database CRUD operations.
+     *
+     * @package Ibonly\PotatoORM\Model
+     * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
+     * @license MIT <https://opensource.org/licenses/MIT>
+     */
 
 namespace Ibonly\PotatoORM;
 

Unused Use Statements -5 removed lines

@@ -9,17 +9,12 @@
 
 namespace Ibonly\PotatoORM;
 
-use PDO;
-use Exception;
-use PDOException;
 use Ibonly\PotatoORM\GetData;
 use Ibonly\PotatoORM\DatabaseQuery;
 use Ibonly\PotatoORM\ModelInterface;
 use Ibonly\PotatoORM\UserNotFoundException;
 use Ibonly\PotatoORM\EmptyDatabaseException;
 use Ibonly\PotatoORM\SaveUserExistException;
-use Ibonly\PotatoORM\ColumnNotExistExeption;
-use Ibonly\PotatoORM\InvalidConnectionException;
 
 class Model extends DatabaseQuery implements ModelInterface
 {

Doc Comments +4 added lines, -3 removed lines

@@ -51,6 +51,7 @@ 
     /**
      * getTableName()
      *
+     * @param string $connection
      * @return string
      */
     public static function getTableName($connection)
@@ -62,7 +63,7 @@ 
      * getALL()
      * Get all record from the database
      *
-     * @return object
+     * @return GetData
      */
     public function getALL($dbConnection = NULL)
     {
@@ -82,7 +83,7 @@ 
      * where($data, $condition)
      * Get data from database where $data = $condition
      *
-     * @return object
+     * @return GetData
      */
     public function where($data, $condition = NULL, $dbConnection = NULL)
     {
@@ -103,7 +104,7 @@ 
      * find($value)
      * Find data from database where id = $value
      *
-     * @return array
+     * @return Model
      */
     public static function find($value, $dbConnection = NULL)
     {

Spacing +6 added lines, -6 removed lines

@@ -71,7 +71,7 @@ 
         $sqlQuery = DatabaseQuery::selectAllQuery(self::getTableName($connection));
         $query = $connection->prepare($sqlQuery);
         $query->execute();
-        if ( $query->rowCount() )
+        if ($query->rowCount())
         {
             return new GetData($query->fetchAll($connection::FETCH_ASSOC));
         }
@@ -92,7 +92,7 @@ 
         $sqlQuery = $databaseQuery->selectQuery(self::getTableName($connection), $data, $condition, $connection);
         $query = $connection->prepare($sqlQuery);
         $query->execute();
-        if ( $query->rowCount() )
+        if ($query->rowCount())
         {
             return new GetData($query->fetchAll($connection::FETCH_ASSOC));
         }
@@ -112,7 +112,7 @@ 
         $sqlQuery = DatabaseQuery::selectQuery(self::getTableName($connection), ['id' => $value], NULL, $connection);
         $query = $connection->prepare($sqlQuery);
         $query->execute();
-        if ( $query->rowCount() )
+        if ($query->rowCount())
         {
             $found = new static;
             $found->id = $value;
@@ -134,7 +134,7 @@ 
 
         $query = $this->insertQuery(self::getTableName($connection));
         $statement = $connection->prepare($query);
-        if( $statement->execute() )
+        if ($statement->execute())
         {
             return true;
         }
@@ -154,7 +154,7 @@ 
 
         $updateQuery = $this->updateQuery(self::getTableName($connection));
         $statement = $connection->prepare($updateQuery);
-        if( $statement->execute() )
+        if ($statement->execute())
         {
             return true;
         }
@@ -171,7 +171,7 @@ 
     {
         $connection = DatabaseQuery::checkConnection($dbConnection);
 
-        $query = $connection->prepare('DELETE FROM ' . self::getTableName($connection) . ' WHERE id = '.$value);
+        $query = $connection->prepare('DELETE FROM '.self::getTableName($connection).' WHERE id = '.$value);
         $query->execute();
         $check = $query->rowCount();
         if ($check)