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

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

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

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'];