andela-iadeniyi / Potato-ORM

src/Helper/Inflector.php

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/Exceptions/EmptyDatabaseException.php

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

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/Helper/Model.php

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

@@ -46,7 +46,7 @@ 
      */
     public function tableName()
     {
-        if(isset($this->table)) {
+        if (isset($this->table)) {
             return $this->table;
         }
         return null;
@@ -105,7 +105,7 @@ 
         $sqlQuery = DatabaseQuery::selectAllQuery(self::getTableName($connection), self::fields());
         $query = $connection->prepare($sqlQuery);
         $query->execute();
-        if ( $query->rowCount() )
+        if ($query->rowCount())
         {
             return new GetData($query->fetchAll($connection::FETCH_ASSOC));
         }
@@ -126,7 +126,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));
         }
@@ -146,7 +146,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;
@@ -168,7 +168,7 @@ 
 
         $query = $this->insertQuery(self::getTableName($connection));
         $statement = $connection->prepare($query);
-        if( $statement->execute() )
+        if ($statement->execute())
         {
             return true;
         }
@@ -188,7 +188,7 @@ 
 
         $updateQuery = $this->updateQuery(self::getTableName($connection));
         $statement = $connection->prepare($updateQuery);
-        if( $statement->execute() )
+        if ($statement->execute())
         {
             return true;
         }
@@ -205,7 +205,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)

src/Exceptions/DataAlreadyExistException.php

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

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/Database/DBConfig.php

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/Database/DatabaseQuery.php

Doc Comments +10 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
@@ -98,7 +98,7 @@ 
      * checkColumn Check if column exist in table
      *
      * @param  $tableName
-     * @param  $columnName
+     * @param  string $columnName
      * @param  $con
      *
      * @return string
@@ -191,6 +191,8 @@ 
     /**
      * selectAllQuery
      *
+     * @param string $tableName
+     * @param string $field
      * @return string
      */
     public static function selectAllQuery($tableName, $field)
@@ -226,6 +228,9 @@ 
     /**
      * selectQuery
      *
+     * @param string $tableName
+     * @param string $fields
+     * @param string $connection
      * @return string
      */
     public static function selectQuery($tableName, $fields, $data, $condition, $connection)
@@ -253,6 +258,7 @@ 
     /**
      * insertQuery
      *
+     * @param string $tableName
      * @return string
      */
     public function insertQuery($tableName)
@@ -270,6 +276,7 @@ 
     /**
      * updateQuery
      *
+     * @param string $tableName
      * @return string
      */
     public function updateQuery($tableName)

Spacing +24 added lines, -24 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();
             }
@@ -152,11 +152,11 @@ 
         $columnNames = self::getColumns($getClassVars);
         $arraySize = count($columnNames);
 
-        foreach ( $columnNames as $key => $value )
+        foreach ($columnNames as $key => $value)
         {
             $counter++;
             $insertQuery .= self::sanitize($key);
-            if( $arraySize > $counter )
+            if ($arraySize > $counter)
                 $insertQuery .= ", ";
         }
 
@@ -177,11 +177,11 @@ 
         $columnNames = self::getColumns($getClassVars);
         $arraySize = count($columnNames);
 
-        foreach ( $columnNames as $key => $value )
+        foreach ($columnNames as $key => $value)
         {
             $counter++;
-            $insertQuery .= "'".self::sanitize($value) ."'";
-            if( $arraySize > $counter )
+            $insertQuery .= "'".self::sanitize($value)."'";
+            if ($arraySize > $counter)
                 $insertQuery .= ", ";
         }
         return $insertQuery;
@@ -200,12 +200,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 .= ", ";
             }
@@ -234,14 +234,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." ";
             }
         }
 
@@ -259,14 +259,14 @@ 
         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 $fields FROM $tableName WHERE $columnName";
+                $query = "SELECT $fields FROM $tableName WHERE $columnName";
             }
         } catch (PDOException $e) {
             $query = $e->getMessage();
@@ -282,7 +282,7 @@ 
      */
     public function insertQuery($tableName)
     {
-        $data = ( array )$this;
+        $data = (array)$this;
         array_shift($data);
 
         $columnNames = self::buildColumn($data);
@@ -298,11 +298,11 @@ 
      */
     public function updateQuery($tableName)
     {
-        $data = ( array ) $this;
+        $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/Helper/Upload.php

Doc Comments +22 added lines, -12 removed lines

@@ -62,8 +62,8 @@ 
     /**
      *@method bool ValidateExtension() returns whether the extension of file to be uploaded
      *    is allowable or not.
-     *@return true the extension is valid.
-     *@return false the extension is invalid.
+     *@return boolean the extension is valid.
+     *@return boolean the extension is invalid.
      */
     public function ValidateExtension()
     {
@@ -95,8 +95,8 @@ 
 
     /**
      *@method bool ValidateSize() returns whether the file size is acceptable.
-     *@return true the size is smaller than the alloted value.
-     *@return false the size is larger than the alloted value.
+     *@return boolean the size is smaller than the alloted value.
+     *@return boolean the size is larger than the alloted value.
      */
     public function ValidateSize()
     {
@@ -120,8 +120,8 @@ 
 
     /**
      *@method bool ValidateExistance() determins whether the file already exists. If so, rename $FileName.
-     *@return true can never be returned as all file names must be unique.
-     *@return false the file name does not exist.
+     *@return null|false can never be returned as all file names must be unique.
+     *@return null|false the file name does not exist.
      */
     public function ValidateExistance()
     {
@@ -142,8 +142,8 @@ 
 
     /**
      *@method bool ValidateDirectory()
-     *@return true the UploadDirectory exists, writable, and has a traling slash.
-     *@return false the directory was never set, does not exist, or is not writable.
+     *@return null|boolean the UploadDirectory exists, writable, and has a traling slash.
+     *@return null|boolean the directory was never set, does not exist, or is not writable.
      */
     public function ValidateDirectory()
     {
@@ -177,8 +177,8 @@ 
 
     /**
      *@method bool ValidateImage()
-     *@return true the image is smaller than the alloted dimensions.
-     *@return false the width and/or height is larger then the alloted dimensions.
+     *@return boolean the image is smaller than the alloted dimensions.
+     *@return boolean the width and/or height is larger then the alloted dimensions.
      */
     public function ValidateImage() {
         $MaximumWidth = $this->MaximumWidth;
@@ -206,8 +206,8 @@ 
 
     /**
      *@method bool UploadFile() uploads the file to the server after passing all the validations.
-     *@return true the file was uploaded.
-     *@return false the upload failed.
+     *@return null|boolean the file was uploaded.
+     *@return null|boolean the upload failed.
      */
     public function uploadFile()
     {
@@ -251,11 +251,18 @@ 
 
     #Accessors and Mutators beyond this point.
     #Siginificant documentation is not needed.
+
+    /**
+     * @param string $argv
+     */
     public function SetFileName($argv)
     {
         $this->FileName = $argv;
     }
 
+    /**
+     * @param string $argv
+     */
     public function SetUploadDirectory($argv)
     {
         $this->UploadDirectory = $argv;
@@ -310,6 +317,9 @@ 
         return $this->UploadDirectory;
     }
 
+    /**
+     * @return string
+     */
     public function GetTempName()
     {
         return $this->TempFileName;

Spacing +18 added lines, -18 removed lines

@@ -73,12 +73,12 @@ 
         $Extension = strtolower($FileParts['extension']);
         $ValidExtensions = $this->ValidExtensions;
 
-        if (!$FileName) {
+        if ( ! $FileName) {
             $this->SetMessage("ERROR: File name is empty.");
             return false;
         }
 
-        if (!$ValidExtensions) {
+        if ( ! $ValidExtensions) {
             $this->SetMessage("WARNING: All extensions are valid.");
             return true;
         }
@@ -104,7 +104,7 @@ 
         $TempFileName = $this->GetTempName();
         $TempFileSize = filesize($TempFileName);
 
-        if($MaximumFileSize == "") {
+        if ($MaximumFileSize == "") {
             $this->SetMessage("WARNING: There is no size restriction.");
             return true;
         }
@@ -127,11 +127,11 @@ 
     {
         $FileName = $this->FileName;
         $UploadDirectory = $this->UploadDirectory;
-        $File = $UploadDirectory . $FileName;
+        $File = $UploadDirectory.$FileName;
 
         if (file_exists($File)) {
             $this->SetMessage("Message: The file '$FileName' already exist.");
-            $UniqueName = rand() . $FileName;
+            $UniqueName = rand().$FileName;
             $this->SetFileName($UniqueName);
             $this->ValidateExistance();
         } else {
@@ -149,24 +149,24 @@ 
     {
         $UploadDirectory = $this->UploadDirectory;
 
-        if (!$UploadDirectory) {
+        if ( ! $UploadDirectory) {
             $this->SetMessage("ERROR: The directory variable is empty.");
             return false;
         }
 
-        if (!is_dir($UploadDirectory)) {
+        if ( ! is_dir($UploadDirectory)) {
             $this->SetMessage("ERROR: The directory '$UploadDirectory' does not exist.");
             return false;
         }
 
-        if (!is_writable($UploadDirectory)) {
+        if ( ! is_writable($UploadDirectory)) {
             $this->SetMessage("ERROR: The directory '$UploadDirectory' does not writable.");
             return false;
         }
 
         if (substr($UploadDirectory, -1) != "/") {
             $this->SetMessage("ERROR: The traling slash does not exist.");
-            $NewDirectory = $UploadDirectory . "/";
+            $NewDirectory = $UploadDirectory."/";
             $this->SetUploadDirectory($NewDirectory);
             $this->ValidateDirectory();
         } else {
@@ -185,9 +185,9 @@ 
         $MaximumHeight = $this->MaximumHeight;
         $TempFileName = $this->TempFileName;
 
-    if($Size = @getimagesize($TempFileName)) {
-        $Width = $Size[0];   //$Width is the width in pixels of the image uploaded to the server.
-        $Height = $Size[1];  //$Height is the height in pixels of the image uploaded to the server.
+    if ($Size = @getimagesize($TempFileName)) {
+        $Width = $Size[0]; //$Width is the width in pixels of the image uploaded to the server.
+        $Height = $Size[1]; //$Height is the height in pixels of the image uploaded to the server.
     }
 
         if ($Width > $MaximumWidth) {
@@ -212,11 +212,11 @@ 
     public function uploadFile()
     {
 
-        if (!$this->ValidateExtension()) {
+        if ( ! $this->ValidateExtension()) {
             die($this->GetMessage());
         } 
 
-        else if (!$this->ValidateSize()) {
+        else if ( ! $this->ValidateSize()) {
             die($this->GetMessage());
         }
 
@@ -224,11 +224,11 @@ 
             die($this->GetMessage());
         }
 
-        else if (!$this->ValidateDirectory()) {
+        else if ( ! $this->ValidateDirectory()) {
             die($this->GetMessage());
         }
 
-        else if ($this->IsImage && !$this->ValidateImage()) {
+        else if ($this->IsImage && ! $this->ValidateImage()) {
             die($this->GetMessage());
         }
 
@@ -239,7 +239,7 @@ 
             $UploadDirectory = $this->UploadDirectory;
 
             if (is_uploaded_file($TempFileName)) { 
-                move_uploaded_file($TempFileName, $UploadDirectory . $FileName);
+                move_uploaded_file($TempFileName, $UploadDirectory.$FileName);
                 return true;
             } else {
                 return false;
@@ -322,7 +322,7 @@ 
 
     public function GetMessage()
     {
-        if (!isset($this->Message)) {
+        if ( ! isset($this->Message)) {
             $this->SetMessage("No Message");
         }