andela-tolotin / Potato-ORM

src/Database/DatabaseHandler.php

Doc Comments +7 added lines, -1 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,6 +36,7 @@ 
     /**
      * This method create a record and store it in a table row
      * @params associative array, string tablename
+     * @param string|false $tableName
      * @return boolean true or false
      */
     public function create($associative1DArray, $tableName, $dbConn = Null)
@@ -69,6 +71,7 @@ 
     /**
      * This method updates any table by supplying 3 parameter
      * @params: $updateParams, $tableName, $associative1DArray
+     * @param string|false $tableName
      * @return boolean true or false
      */
     public function update(array $updateParams, $tableName, $associative1DArray, $dbConn = Null)
@@ -101,6 +104,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)
@@ -131,6 +135,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)
@@ -163,7 +168,7 @@ 
   
   /**
    * This method returns sql query
-   * @param $sql
+   * @param string $sql
    * @return string
    */
   public function prepareUpdateQuery($sql)
@@ -204,6 +209,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/Model/BaseModel.php

Doc Comments +2 added lines, -2 removed lines

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