andela-iadeniyi / Potato-ORM

src/Interface/DatabaseQueryInterface.php

Indentation +6 added lines, -6 removed lines

@@ -1,11 +1,11 @@
 <?php
 /**
- * Defining Interface for class DatabaseQueryInterface.
- *
- * @package Ibonly\PotatoORM\DatabaseQueryInterface
- * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
- * @license MIT <https://opensource.org/licenses/MIT>
- */
+     * Defining Interface for class DatabaseQueryInterface.
+     *
+     * @package Ibonly\PotatoORM\DatabaseQueryInterface
+     * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
+     * @license MIT <https://opensource.org/licenses/MIT>
+     */
 
 namespace Ibonly\PotatoORM;
 

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

Braces +5 added lines, -15 removed lines

@@ -214,25 +214,15 @@
 
         if (!$this->ValidateExtension()) {
             die($this->GetMessage());
-        } 
-
-        else if (!$this->ValidateSize()) {
+        } else if (!$this->ValidateSize()) {
             die($this->GetMessage());
-        }
-
-        else if ($this->ValidateExistance()) {
+        } else if ($this->ValidateExistance()) {
             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());
-        }
-
-        else {
+        } else {
 
             $FileName = $this->FileName;
             $TempFileName = $this->TempFileName;

src/Interface/GetDataInterface.php

Indentation +8 added lines, -8 removed lines

@@ -1,17 +1,17 @@ 
 <?php
 /**
- * Defining Interface for class GetData.
- *
- * @package Ibonly\PotatoORM\ModelInterface
- * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
- * @license MIT <https://opensource.org/licenses/MIT>
- */
+     * Defining Interface for class GetData.
+     *
+     * @package Ibonly\PotatoORM\ModelInterface
+     * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
+     * @license MIT <https://opensource.org/licenses/MIT>
+     */
 
 namespace Ibonly\PotatoORM;
 
 interface GetDataInterface
 {
-	public function all();
+    public function all();
 	
     public function allDESC($limit);
 
@@ -23,5 +23,5 @@ 
 
     public function first();
 
-   public function getCount();
+    public function getCount();
 }

src/Database/DatabaseQuery.php

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

Spacing +13 added lines, -13 removed lines

@@ -25,13 +25,13 @@ 
      *
      * @return array
      */
-    public function field($type, $fieldName, $length=NULL)
+    public function field($type, $fieldName, $length = NULL)
     {
-        if($length === null){
-             $this->fieldDescription[] = $type ." ".$fieldName;
-        }else
+        if ($length === null) {
+             $this->fieldDescription[] = $type." ".$fieldName;
+        } else
         {
-         $this->fieldDescription[] = $type ." ".$fieldName." ".$length;
+         $this->fieldDescription[] = $type." ".$fieldName." ".$length;
         }
 
     }
@@ -51,12 +51,12 @@ 
             $fields = explode(" ", $fieldName);
          
             $constrain = $fields[0];
-            if(count($fields) == 2)
+            if (count($fields) == 2)
             {
-                $query .= $this->$constrain($fields[1], 20) .", ".PHP_EOL;
-            }else
+                $query .= $this->$constrain($fields[1], 20).", ".PHP_EOL;
+            } else
             {
-                    $query .= $this->$constrain($fields[1], $fields[2]) .", ".PHP_EOL;
+                    $query .= $this->$constrain($fields[1], $fields[2]).", ".PHP_EOL;
             }
         };
         array_walk($this->fieldDescription, $callback);
@@ -90,11 +90,11 @@ 
         {
             $sqlQuery = self::sanitizeQuery($tablename);
             $query = $connection->prepare($sqlQuery);
-            if($query->execute())
+            if ($query->execute())
             {
                 return true;
             }
-        }catch(PDOException $e){
+        } catch (PDOException $e) {
             return $e->getMessage();
         }
     }
@@ -116,7 +116,7 @@ 
      */
     public function strings($value, $length)
     {
-        return $value ." varchar (".$length.") NOT NULL";
+        return $value." varchar (".$length.") NOT NULL";
     }
 
     /**
@@ -202,6 +202,6 @@ 
                     $apend = 'timestamp';
                 break;
         }
-        return $value . " " . $apend . " NOT NULL";
+        return $value." ".$apend." NOT NULL";
     }
 }
\ No newline at end of file