andela-tolotin / Potato-ORM

src/Model/BaseModel.php

Doc Comments +2 added lines, -2 removed lines

@@ -119,7 +119,7 @@ 
 	/**
 	 * This method find a record by id
 	 * @params int id
-	 * @return Object
+	 * @return BaseClass
 	 * @throws NoArgumentPassedToFunctionException
 	 */
 	public static function find($id)
@@ -171,7 +171,7 @@ 
 	/**
 	 * This method return the current class name
 	 * $params void
-	 * @return classname
+	 * @return string|false
 	 */
 	public static function getClassName()
 	{

Unused Use Statements -1 removed lines

@@ -14,7 +14,6 @@
 use Laztopaz\potatoORM\NoRecordFoundException;
 use Laztopaz\potatoORM\NoRecordInsertionException;
 use Laztopaz\potatoORM\NullArgumentPassedToFunction;
-use Laztopaz\potatoORM\WrongArgumentException;
 use Laztopaz\potatoORM\NoArgumentPassedToFunctionException;
 use Laztopaz\potatoORM\EmptyArrayException;
 

src/Database/DatabaseHandler.php

Unused Use Statements -1 removed lines

@@ -9,7 +9,6 @@
 namespace Laztopaz\potatoORM;
 
 use PDO;
-use Laztopaz\potatoORM\DatabaseHelper;
 use Laztopaz\potatoORM\TableFieldUndefinedException;
 use Laztopaz\potatoORM\EmptyArrayException;
 

Doc Comments +11 added lines, -2 removed lines

@@ -21,6 +21,7 @@ 
     
     /**
      * This is a constructor; a default method  that will be called automatically during class instantiation
+     * @param string|false $modelClassName
      */
      public function __construct($modelClassName, $dbConn = Null)
      {
@@ -35,7 +36,8 @@ 
     /**
       * This method create a record and store it in a table row
       * @params associative array, string tablename
-      * @return boolean true or false
+      * @param string|false $tableName
+      * @return boolean|null true or false
       */
     public function create($associative1DArray, $tableName, $dbConn = Null)
     {
@@ -72,6 +74,10 @@ 
      * @params: $updateParams, $tableName, $associative1DArray
      * @return boolean true or false
      */
+
+    /**
+     * @param string|false $tableName
+     */
     public function update(array $updateParams, $tableName, $associative1DArray, $dbConn = Null)
     {
     	$sql = "";
@@ -102,6 +108,7 @@ 
   /**
     * This method retrieves record from a table
     * @params int id, string tableName
+    * @param string|false $tableName
     * @return array
     */
    public static function read($id, $tableName, $dbConn = Null)
@@ -132,6 +139,7 @@ 
    /**
      * This method deletes a record  from a table row
      * @params int id, string tableName
+     * @param string|false $tableName
      * @return boolean true or false
      */
   public static function delete($id, $tableName, $dbConn = Null)
@@ -164,7 +172,7 @@ 
   
   /**
     * This method returns sql query
-    * @param $sql
+    * @param string $sql
     * @return string
     */
   public function prepareUpdateQuery($sql)
@@ -206,6 +214,7 @@ 
     * This method returns column fields of a particular table
     * @param $table
     * @param $conn
+    * @param DatabaseConnection $dbConn
     * @return array
     */
  public function getColumnNames($table, $dbConn = Null) {

src/Database/DatabaseHelper.php

Unused Use Statements -1 removed lines

@@ -8,7 +8,6 @@
 
 namespace Laztopaz\potatoORM;
 
-use PDO;
 use Laztopaz\potatoORM\TableNotCreatedException;
 
 class DatabaseHelper {