andela-iadeniyi / Potato-ORM

src/Database/DatabaseQuery.php

Doc Comments +11 added lines, -4 removed lines

@@ -82,6 +82,7 @@ 
     /**
      * getTableName()
      *
+     * @param string $connection
      * @return string
      */
     protected function getTableName($connection)
@@ -122,7 +123,7 @@ 
      * @param  $tablename
      * @param  $con
      *
-     * @return bool
+     * @return boolean|null
      */
     public function checkTableExist($table, $con=NULL)
     {
@@ -137,7 +138,7 @@ 
     /**
      * checkTableName Return the table name
      *
-     * @param  $tablename
+     * @param  string $tablename
      * @param  $con
      *
      * @return string
@@ -158,7 +159,7 @@ 
      * checkColumn Check if column exist in table
      *
      * @param  $tableName
-     * @param  $columnName
+     * @param  string $columnName
      * @param  $con
      *
      * @return string
@@ -315,6 +316,9 @@ 
     /**
      * selectQuery
      *
+     * @param string $tableName
+     * @param string $fields
+     * @param string $connection
      * @return string
      */
     public static function selectQuery($tableName, $fields, $data, $condition, $connection)
@@ -342,6 +346,7 @@ 
     /**
      * insertQuery
      *
+     * @param string $tableName
      * @return string
      */
     public function insertQuery($tableName)
@@ -358,6 +363,7 @@ 
     /**
      * updateQuery
      *
+     * @param string $tableName
      * @return string
      */
     public function updateQuery($tableName)
@@ -375,7 +381,8 @@ 
      * query($query, $dbCOnnection)
      * Raw sql query
      *
-     * @return object
+     * @param string $query
+     * @return GetData
      */
     public function query($query, $con = NULL)
     {

Spacing +16 added lines, -16 removed lines

@@ -124,11 +124,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;
         }
@@ -142,12 +142,12 @@ 
      *
      * @return string
      */
-    protected static function checkTableName($tableName, $con=NULL)
+    protected 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;
         }
@@ -163,13 +163,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();
             }
@@ -216,7 +216,7 @@ 
         {
             $counter++;
             $insertQuery .= self::sanitize($key);
-            if($arraySize > $counter)
+            if ($arraySize > $counter)
                 $insertQuery .= ", ";
         }
 
@@ -240,8 +240,8 @@ 
         foreach ($columnNames as $key => $value)
         {
             $counter++;
-            $insertQuery .= "'".self::sanitize($value) ."'";
-            if($arraySize > $counter)
+            $insertQuery .= "'".self::sanitize($value)."'";
+            if ($arraySize > $counter)
                 $insertQuery .= ", ";
         }
         return $insertQuery;
@@ -264,7 +264,7 @@ 
         {
             $counter++;
             $columnName = self::checkColumn($tableName, self::sanitize($key));
-            $updateQuery .= $columnName ." = '".self::sanitize($value)."'";
+            $updateQuery .= $columnName." = '".self::sanitize($value)."'";
             if ($arraySize > $counter)
             {
                 $updateQuery .= ", ";
@@ -299,10 +299,10 @@ 
             {
                 $counter++;
                 $columnName = self::checkColumn($tableName, self::sanitize($key));
-                $where .= $tableName.'.'.$columnName ." = '".self::sanitize($value)."'";
+                $where .= $tableName.'.'.$columnName." = '".self::sanitize($value)."'";
                 if ($arraySize > $counter)
                 {
-                    $where .= " " . $condition . " ";
+                    $where .= " ".$condition." ";
                 }
             }
         } else {
@@ -323,14 +323,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();
@@ -362,11 +362,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;
     }

Braces +7 added lines, -6 removed lines

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

src/Helper/Model.php

Doc Comments +3 added lines, -3 removed lines

@@ -25,7 +25,7 @@ 
      * getALL()
      * Get all record from the database
      *
-     * @return object
+     * @return GetData
      */
     public function getAll($dbConnection = NULL)
     {
@@ -44,7 +44,7 @@ 
      * where($data, $condition)
      * Get data from database where $data = $condition
      *
-     * @return object
+     * @return GetData
      */
     public function where($data, $condition = NULL, $dbConnection = NULL)
     {
@@ -64,7 +64,7 @@ 
      * find($value)
      * Find data from database where id = $value
      *
-     * @return array
+     * @return Model
      */
     public static function find($value, $dbConnection = NULL)
     {

Spacing +2 added lines, -2 removed lines

@@ -94,7 +94,7 @@ 
 
         $query = $this->insertQuery(self::getTableName($connection));
         $statement = $connection->prepare($query);
-        if($statement->execute()) {
+        if ($statement->execute()) {
             return true;
         }
         throw new  DataAlreadyExistException();
@@ -129,7 +129,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/Helper/Relationships.php

Doc Comments +3 added lines

@@ -41,6 +41,9 @@
         return $output;
     }
 
+    /**
+     * @param string $con
+     */
     public function whereClause($data = null, $condition = null, $con = null)
     {
     	$joinClause = self::joinClause();

Indentation +21 added lines, -21 removed lines

@@ -25,36 +25,36 @@
         $i = 0;
 
         if ($data[0]->REFERENCED_TABLE_NAME !== null) {
-			$arraySize  = count($data);
-
-	        foreach($data as $key => $value) {
-	        	$output .= ' JOIN '.$value->REFERENCED_TABLE_NAME;
-	        }
-	        foreach($data as $key => $value) {
-	        	$i++;
-	        	$whereAnd = $i > 1 ? 'AND' : 'WHERE';
-	        	$output .= ' '.$whereAnd.' '.self::getTableName($connection).'.'.$value->COLUMN_NAME.'='.$value->REFERENCED_TABLE_NAME.'.'.$value->REFERENCED_COLUMN_NAME.' ';
-	        }
-	     } else {
-	     	$output = false;
-	     }
+            $arraySize  = count($data);
+
+            foreach($data as $key => $value) {
+                $output .= ' JOIN '.$value->REFERENCED_TABLE_NAME;
+            }
+            foreach($data as $key => $value) {
+                $i++;
+                $whereAnd = $i > 1 ? 'AND' : 'WHERE';
+                $output .= ' '.$whereAnd.' '.self::getTableName($connection).'.'.$value->COLUMN_NAME.'='.$value->REFERENCED_TABLE_NAME.'.'.$value->REFERENCED_COLUMN_NAME.' ';
+            }
+            } else {
+                $output = false;
+            }
         return $output;
     }
 
     public function whereClause($data = null, $condition = null, $con = null)
     {
-    	$joinClause = self::joinClause();
+        $joinClause = self::joinClause();
         $connection = self::checkConnection($con);
         $tableName  = self::getTableName($connection);
         $columnName = self::whereAndClause($tableName, $data, $condition);
 
-    	$query = 'SELECT * FROM '.$tableName;
+        $query = 'SELECT * FROM '.$tableName;
 
-    	if (! $joinClause) {
-    		$query .= ' WHERE '.$columnName;
-    	} else {
-    		$query .= ($data === null) ? $joinClause : $joinClause .' AND '.$columnName;
-    	}
-    	return $query;
+        if (! $joinClause) {
+            $query .= ' WHERE '.$columnName;
+        } else {
+            $query .= ($data === null) ? $joinClause : $joinClause .' AND '.$columnName;
+        }
+        return $query;
     }
 }
\ No newline at end of file

Spacing +5 added lines, -5 removed lines

@@ -25,12 +25,12 @@ 
         $i = 0;
 
         if ($data[0]->REFERENCED_TABLE_NAME !== null) {
-			$arraySize  = count($data);
+			$arraySize = count($data);
 
-	        foreach($data as $key => $value) {
+	        foreach ($data as $key => $value) {
 	        	$output .= ' JOIN '.$value->REFERENCED_TABLE_NAME;
 	        }
-	        foreach($data as $key => $value) {
+	        foreach ($data as $key => $value) {
 	        	$i++;
 	        	$whereAnd = $i > 1 ? 'AND' : 'WHERE';
 	        	$output .= ' '.$whereAnd.' '.self::getTableName($connection).'.'.$value->COLUMN_NAME.'='.$value->REFERENCED_TABLE_NAME.'.'.$value->REFERENCED_COLUMN_NAME.' ';
@@ -50,10 +50,10 @@ 
 
     	$query = 'SELECT * FROM '.$tableName;
 
-    	if (! $joinClause) {
+    	if ( ! $joinClause) {
     		$query .= ' WHERE '.$columnName;
     	} else {
-    		$query .= ($data === null) ? $joinClause : $joinClause .' AND '.$columnName;
+    		$query .= ($data === null) ? $joinClause : $joinClause.' AND '.$columnName;
     	}
     	return $query;
     }

src/Helper/Upload.php

Doc Comments +13 added lines, -10 removed lines

@@ -83,8 +83,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()
     {
@@ -115,8 +115,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()
     {
@@ -140,8 +140,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($uploadDirectory)
     {
@@ -161,8 +161,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($uploadDirectory)
     {
@@ -194,8 +194,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;
@@ -311,6 +311,9 @@ 
         return $this->UploadDirectory;
     }
 
+    /**
+     * @return string
+     */
     public function GetTempName()
     {
         return $this->output['tmp_name'];

Spacing +13 added lines, -13 removed lines

@@ -94,12 +94,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;
         }
@@ -124,7 +124,7 @@ 
         $TempFileName = $this->GetTempName();
         $TempFileSize = filesize($TempFileName);
 
-        if($MaximumFileSize == "") {
+        if ($MaximumFileSize == "") {
             $this->SetMessage("WARNING: There is no size restriction.");
             return true;
         }
@@ -146,11 +146,11 @@ 
     public function ValidateExistance($uploadDirectory)
     {
         $FileName = $this->GetFileName();
-        $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($uploadDirectory);
         } else {
@@ -166,24 +166,24 @@ 
      */
     public function ValidateDirectory($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($uploadDirectory);
         } else {
@@ -202,9 +202,9 @@ 
         $MaximumHeight = $this->MaximumHeight;
         $TempFileName = $this->GetTempName();
 
-        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) {
@@ -323,7 +323,7 @@ 
 
     public function GetMessage()
     {
-        if (!isset($this->Message)) {
+        if ( ! isset($this->Message)) {
             $this->SetMessage("No Message");
         }
 

src/Interface/RelationshipsInterface.php

Indentation +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
 
 interface RelationshipsInterface
 {
-	public function joinClause();
+    public function joinClause();
 
     public function whereClause($data, $condition);
 }
\ No newline at end of file