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/Exceptions/NoRecordDeletionException.php

Indentation +4 added lines, -4 removed lines

@@ -12,8 +12,8 @@
 
 class NoRecordDeletionException extends  Exception
 {
-    public static function checkNoRecordUpdateException($message)
-    {
-        return new static($message);
-    }
+	public static function checkNoRecordUpdateException($message)
+	{
+		return new static($message);
+	}
 }

src/Database/DatabaseHandler.php

Doc Comments +11 added lines, -2 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, $dbConn = Null)
 	{
@@ -36,7 +37,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)
 	{
@@ -79,6 +81,10 @@ 
 	 * @params: $updateParams, $tableName, $associative1DArray
 	 * @return boolean true or false
 	 */
+
+	/**
+	 * @param string|false $tableName
+	 */
 	public function update(array $updateParams, $tableName, $associative1DArray, $dbConn = Null)
 	{
 		$sql = "";
@@ -112,6 +118,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)
@@ -143,6 +150,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)
@@ -177,7 +185,7 @@ 
 
 	/**
 	 * This method returns sql query
-	 * @param $sql
+	 * @param string $sql
 	 * @return string
 	 */
 	public function prepareUpdateQuery($sql)
@@ -219,6 +227,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/DatabaseConnection.php

Indentation +3 added lines, -3 removed lines

@@ -21,8 +21,8 @@ 
 
 	public  function  __construct() 
 	{
-	    $this->loadEnv(); // load the environment variables
-	    $this->databaseName     =  getenv('databaseName');
+		$this->loadEnv(); // load the environment variables
+		$this->databaseName     =  getenv('databaseName');
 		$this->databaseHost     =  getenv('databaseHost');
 		$this->databaseDriver   =  getenv('databaseDriver');
 		$this->databaseUsername =  getenv('databaseUsername');
@@ -78,7 +78,7 @@ 
 	{
 		if (!getenv("APP_ENV")) {
 			$dotenv = new Dotenv(__DIR__.'/../../');
-		    $dotenv->load();
+			$dotenv->load();
 		}
 
 	}