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)

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;
 

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;
 

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;
 

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 (

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;
 

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

src/Helper/Schema.php

Indentation +8 added lines, -8 removed lines

@@ -1,11 +1,11 @@ 
 <?php
 /**
- * SugarORM\Schema manages the creation of database table.
- *
- * @package Ibonly\SugarORM\Schema
- * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
- * @license MIT <https://opensource.org/licenses/MIT>
- */
+     * SugarORM\Schema manages the creation of database table.
+     *
+     * @package Ibonly\SugarORM\Schema
+     * @author  Ibraheem ADENIYI <ibonly01@gmail.com>
+     * @license MIT <https://opensource.org/licenses/MIT>
+     */
 
 namespace Ibonly\PotatoORM;
 
@@ -28,10 +28,10 @@ 
     public function field($type, $fieldName, $length=NULL)
     {
         if(is_null($length)){
-             $this->fieldDescription[] = $type ." ".$fieldName;
+                $this->fieldDescription[] = $type ." ".$fieldName;
         }else
         {
-         $this->fieldDescription[] = $type ." ".$fieldName." ".$length;
+            $this->fieldDescription[] = $type ." ".$fieldName." ".$length;
         }
 
     }