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

src/Database/DatabaseHandler.php

Doc Comments +9 added lines, -1 removed lines

@@ -22,6 +22,7 @@ 
 
 	/**
 	 * This is a constructor; a default method  that will be called automatically during class instantiation
+	 * @param string|false $modelClassName
 	 */
 	public function __construct($modelClassName)
 	{
@@ -37,6 +38,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)
@@ -80,6 +82,10 @@ 
 	 * @params: $updateParams, $tableName, $associative1DArray
 	 * @return boolean true or false
 	 */
+
+	/**
+	 * @param string|false $tableName
+	 */
 	public function update(array $updateParams, $tableName, $associative1DArray, $dbConn = Null)
 	{
 		$counter = 0;
@@ -124,6 +130,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)
@@ -162,6 +169,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)
@@ -204,7 +212,7 @@ 
 
 	/**
 	 * This method returns sql query
-	 * @param $sql
+	 * @param string $sql
 	 * @return string
 	 */
 	private function prepareUpdateQuery($sql)

src/Database/DatabaseConnection.php

Indentation +3 added lines, -3 removed lines

@@ -15,9 +15,9 @@ 
 class DatabaseConnection extends \PDO
 {
 	private $databaseName;
-    private $databaseHost;
+	private $databaseHost;
 	private $databaseDriver;
-    private $databaseUsername;
+	private $databaseUsername;
 	private $databasePassword;
 	private $databaseHandle;
 
@@ -104,7 +104,7 @@ 
 
 			//$dotenv = new Dotenv($_SERVER['DOCUMENT_ROOT']);
 			$dotenv = new Dotenv(__DIR__.'/../../');
-		    $dotenv->load();
+			$dotenv->load();
 		}
 
 	}