andela-tolotin / Potato-ORM

src/Database/DatabaseHandler.php

Doc Comments +8 added 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)
 	{
@@ -36,6 +37,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)
 	{
 		$counter = 0;
@@ -122,6 +128,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)
@@ -156,6 +163,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")

Indentation +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
 	private
 		$tableFields,
 		$dbHelperInstance,
-        $dbConnection;
+		$dbConnection;
 
 	/**
 	 * This is a constructor; a default method  that will be called automatically during class instantiation

Spacing +17 added lines, -17 removed lines

@@ -12,7 +12,7 @@ 
 use Laztopaz\potatoORM\DatabaseHelper;
 use Laztopaz\potatoORM\TableFieldUndefinedException;
 
-class DatabaseHandler  {
+class DatabaseHandler {
 
 	private
 		$tableFields,
@@ -40,11 +40,11 @@ 
 	 */
 	public function create($associative1DArray, $tableName, $dbConn = Null)
 	{
-		$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($this->tableFields,$associative1DArray);
+		$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($this->tableFields, $associative1DArray);
 
 		if (count($unexpectedFields) > 0)
 		{
-			throw TableFieldUndefinedException::fieldsNotDefinedException($unexpectedFields,"needs to be created as table field");
+			throw TableFieldUndefinedException::fieldsNotDefinedException($unexpectedFields, "needs to be created as table field");
 		}
 
 		unset($this->tableFields[0]);
@@ -57,7 +57,7 @@ 
 
 		$insertQuery = 'INSERT INTO '.$tableName;
 
-		$TableValues = implode(',',array_keys($associative1DArray));
+		$TableValues = implode(',', array_keys($associative1DArray));
 
 		foreach ($associative1DArray as $field => $value) {
 
@@ -65,13 +65,13 @@ 
 		}
 		$splittedTableValues = implode(',', $FormValues);
 
-		$insertQuery.= ' ('.$TableValues.')';
+		$insertQuery .= ' ('.$TableValues.')';
 
-		$insertQuery.= ' VALUES ('.$splittedTableValues.')';
+		$insertQuery .= ' VALUES ('.$splittedTableValues.')';
 
 		$executeQuery = $dbConn->exec($insertQuery);
 
-		return $executeQuery ? : false;
+		return $executeQuery ?: false;
 
 	}
 
@@ -84,11 +84,11 @@ 
 	{
 		$counter = 0;
 
-		$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($this->tableFields,$associative1DArray);
+		$unexpectedFields = self::checkIfMagicSetterContainsIsSameAsClassModel($this->tableFields, $associative1DArray);
 
 		if (count($unexpectedFields) > 0)
 		{
-			throw TableFieldUndefinedException::fieldsNotDefinedException($unexpectedFields,"needs to be created as table field");
+			throw TableFieldUndefinedException::fieldsNotDefinedException($unexpectedFields, "needs to be created as table field");
 		}
 
 		unset($this->tableFields[0]);
@@ -99,13 +99,13 @@ 
 
 			if ($counter == 0) {
 
-				$sql = sprintf( $sql." %s = '%s' ", "`$field`" , get_magic_quotes_gpc() ? $value: addslashes($value)) or die(PDO::ERRMODE_EXCEPTION);
+				$sql = sprintf($sql." %s = '%s' ", "`$field`", get_magic_quotes_gpc() ? $value : addslashes($value)) or die(PDO::ERRMODE_EXCEPTION);
 
 				$counter++;
 
 			} else {
 
-				$sql = sprintf( $sql.", %s = '%s' ", "`$field`" ,get_magic_quotes_gpc() ? $value: addslashes($value)) or die(PDO::ERRMODE_EXCEPTION);
+				$sql = sprintf($sql.", %s = '%s' ", "`$field`", get_magic_quotes_gpc() ? $value : addslashes($value)) or die(PDO::ERRMODE_EXCEPTION);
 			}
 		} // end foreach
 		foreach ($updateParams as $key => $val) {
@@ -115,7 +115,7 @@ 
 
 		$boolResponse = $this->dbConnection->exec($sql);
 
-		return $boolResponse ? : false;
+		return $boolResponse ?: false;
 
 	}
 
@@ -128,7 +128,7 @@ 
 	{
 		$tableData = array();
 
-		$sql = $id  ? 'SELECT * FROM '.$tableName.' WHERE id = '.$id : 'SELECT * FROM '.$tableName;
+		$sql = $id ? 'SELECT * FROM '.$tableName.' WHERE id = '.$id : 'SELECT * FROM '.$tableName;
 
 		try {
 
@@ -146,7 +146,7 @@ 
 		}
 		$results = $stmt->fetchAll(PDO::FETCH_ASSOC);
 
-		foreach($results as $result) {
+		foreach ($results as $result) {
 			array_push($tableData, $result);
 		}
 
@@ -158,7 +158,7 @@ 
 	 * @params int id, string tableName
 	 * @return boolean true or false
 	 */
-	public static function delete($id,$tableName,$dbConn = "Null")
+	public static function delete($id, $tableName, $dbConn = "Null")
 	{
 
 		if (is_null($dbConn)) {
@@ -171,7 +171,7 @@ 
 
 		$boolResponse = $dbConn->exec($sql);
 
-		return $boolResponse ? : false;
+		return $boolResponse ?: false;
 	}
 
 	/**
@@ -186,7 +186,7 @@ 
 
 		foreach ($userSetterArray as $key => $val)
 		{
-			if (!in_array($key,$tableColumn)) {
+			if (!in_array($key, $tableColumn)) {
 
 				$unexpectedFields[] = $key;
 			}

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;
 

Spacing +8 added lines, -8 removed lines

@@ -20,13 +20,13 @@ 
 
 class BaseClass  implements InterfaceBaseClass
 {
-	protected $databaseModel;   // Private variable that contains instance of database
+	protected $databaseModel; // Private variable that contains instance of database
 
-	protected $tableName;       // Class variable holding class name pluralized
+	protected $tableName; // Class variable holding class name pluralized
 
 	protected $properties = []; // Properties will later contain key, value pairs from the magic setter, getter methods
 
-	use Inflector;              // Inject the inflector trait
+	use Inflector; // Inject the inflector trait
 
 	public function  __construct()
 	{
@@ -53,7 +53,7 @@ 
 	 * @params property, key
 	 * @return array associative array properties
 	 */
-	public function  __set($property,$value)
+	public function  __set($property, $value)
 	{
 		$this->properties[$property] = $value;
 	}
@@ -126,7 +126,7 @@ 
 	{
 		$num_args = (int) func_num_args(); // get number of arguments passed to
 
-		if ($num_args == 0 ||  $num_args > 1) {
+		if ($num_args == 0 || $num_args > 1) {
 
 			throw NoArgumentPassedToFunctionException::noArgumentPassedToFunction("Argument missing: only one argument is allowed");
 		}
@@ -153,12 +153,12 @@ 
 
 		$num_args = (int) func_num_args(); // get number of arguments passed to
 
-		if ($num_args == 0 ||  $num_args > 1) {
+		if ($num_args == 0 || $num_args > 1) {
 
 			throw NoArgumentPassedToFunctionException::noArgumentPassedToFunction("Argument missing: only one argument is allowed");
 		}
 
-		$boolDeleted = DatabaseHandler::delete($id,self::getClassName());
+		$boolDeleted = DatabaseHandler::delete($id, self::getClassName());
 
 		if ($boolDeleted) {
 
@@ -189,7 +189,7 @@ 
 	 */
 	public function checkIfRecordIsEmpty($arrayOfRecord)
 	{
-		if (count($arrayOfRecord) > 0 ) {
+		if (count($arrayOfRecord) > 0) {
 
 			return true;
 		}

src/Database/DatabaseConnection.php

Indentation +6 added lines, -6 removed lines

@@ -17,11 +17,11 @@ 
 	private
 		$databaseName,
 		$databaseHost,
-	    $databaseDriver,
-	    $databaseUsername,
-	    $databasePassword,
-	    $databaseHandle,
-        $envFileLoader;
+		$databaseDriver,
+		$databaseUsername,
+		$databasePassword,
+		$databaseHandle,
+		$envFileLoader;
 
 	public  function  __construct()
 	{
@@ -106,7 +106,7 @@ 
 
 			//$dotenv = new Dotenv($_SERVER['DOCUMENT_ROOT']);
 			$dotenv = new Dotenv(__DIR__.'/../../');
-		    $dotenv->load();
+			$dotenv->load();
 		}
 
 	}

Spacing +10 added lines, -10 removed lines

@@ -29,11 +29,11 @@ 
 
 		$this->databaseHandle   = $this->connect(); // database connection handle
 
-		$this->databaseName     =  getenv('databaseName');
-		$this->databaseHost     =  getenv('databaseHost');
-		$this->databaseDriver   =  getenv('databaseDriver');
-		$this->databaseUsername =  getenv('databaseUsername');
-		$this->databasePassword =  getenv('databasePassword');
+		$this->databaseName     = getenv('databaseName');
+		$this->databaseHost     = getenv('databaseHost');
+		$this->databaseDriver   = getenv('databaseDriver');
+		$this->databaseUsername = getenv('databaseUsername');
+		$this->databasePassword = getenv('databasePassword');
 	}
 
 	/**
@@ -54,7 +54,7 @@ 
 
 			$databaseHandle = new PDO($this->getDatabaseDriver(), $this->databaseUsername, $this->databasePassword, $options);
 
-		} catch(PDOException $e) {
+		} catch (PDOException $e) {
 
 			return $e->getMessage();
 
@@ -78,21 +78,21 @@ 
 			case 'mysql':
 
 				// Set DSN
-				$dsn = 'mysql:host='.    $this->databaseHost. ';dbname='. $this->databaseName;
+				$dsn = 'mysql:host='.$this->databaseHost.';dbname='.$this->databaseName;
 				break;
 			case 'sqlite':
 
 				// Set DSN
-				$dsn = 'sqlite:host='.   $this->databaseHost. ';dbname='. $this->databaseName;
+				$dsn = 'sqlite:host='.$this->databaseHost.';dbname='.$this->databaseName;
 				break;
 			case 'pgsql':
 
 				// Set DSN
-				$dsn = 'pgsqlsql:host='. $this->databaseHost. ';dbname='. $this->databaseName;
+				$dsn = 'pgsqlsql:host='.$this->databaseHost.';dbname='.$this->databaseName;
 				break;
 			default:
 				// Set DSN
-				$dsn = 'mysql:host='.    $this->databaseHost. ';dbname='. $this->databaseName;
+				$dsn = 'mysql:host='.$this->databaseHost.';dbname='.$this->databaseName;
 		}
 		return $dsn;
 	}

src/Database/DatabaseHelper.php

Spacing +4 added lines, -4 removed lines

@@ -38,7 +38,7 @@ 
 
 			$sql = 'CREATE TABLE IF NOT EXISTS '.$tableName.'(';
 
-			$sql.= ' id INT( 11 ) AUTO_INCREMENT PRIMARY KEY, name VARCHAR( 100 ), gender VARCHAR( 10 ), alias VARCHAR( 150 ) NOT NULL, class VARCHAR( 150 ), stack VARCHAR( 50 ) )';
+			$sql .= ' id INT( 11 ) AUTO_INCREMENT PRIMARY KEY, name VARCHAR( 100 ), gender VARCHAR( 10 ), alias VARCHAR( 150 ) NOT NULL, class VARCHAR( 150 ), stack VARCHAR( 50 ) )';
 
 			return $conn->exec($sql);
 
@@ -53,7 +53,7 @@ 
 	 * @param $table
 	 * @return array
 	 */
-	public function getColumnNames($table, $conn = Null){
+	public function getColumnNames($table, $conn = Null) {
 
 		$tableFields = [];
 
@@ -72,7 +72,7 @@ 
 
 			$results = $stmt->fetchAll(PDO::FETCH_ASSOC);
 
-			foreach($results as $result) {
+			foreach ($results as $result) {
 				array_push($tableFields, $result['Field']);
 			}
 
@@ -80,7 +80,7 @@ 
 
 		} catch (PDOException $e) {
 
-			trigger_error('Could not connect to MySQL database. ' . $e->getMessage() , E_USER_ERROR);
+			trigger_error('Could not connect to MySQL database. '.$e->getMessage(), E_USER_ERROR);
 		}
 	}
 

src/Helper/Inflector.php

Spacing +9 added lines, -9 removed lines

@@ -74,14 +74,14 @@ 
 			'sex' => 'sexes',
 			'move' => 'moves');
 		$lowercased_word = strtolower($word);
-		foreach ($uncountable as $_uncountable){
-			if(substr($lowercased_word,(-1*strlen($_uncountable))) == $_uncountable){
+		foreach ($uncountable as $_uncountable) {
+			if (substr($lowercased_word, (-1*strlen($_uncountable))) == $_uncountable) {
 				return $word;
 			}
 		}
-		foreach ($irregular as $_plural=> $_singular){
+		foreach ($irregular as $_plural=> $_singular) {
 			if (preg_match('/('.$_plural.')$/i', $word, $arr)) {
-				return preg_replace('/('.$_plural.')$/i', substr($arr[0],0,1).substr($_singular,1), $word);
+				return preg_replace('/('.$_plural.')$/i', substr($arr[0], 0, 1).substr($_singular, 1), $word);
 			}
 		}
 		foreach ($plural as $rule => $replacement) {
@@ -101,7 +101,7 @@ 
 	 */
 	public function singularize($word)
 	{
-		$singular = array (
+		$singular = array(
 			'/(quiz)zes$/i'             => "$1",
 			'/(matr)ices$/i'            => "$1ix",
 			'/(vert|ind)ices$/i'        => "$1ex",
@@ -139,14 +139,14 @@ 
 			'sex' => 'sexes',
 			'move' => 'moves');
 		$lowercased_word = strtolower($word);
-		foreach ($uncountable as $_uncountable){
-			if(substr($lowercased_word,(-1*strlen($_uncountable))) == $_uncountable){
+		foreach ($uncountable as $_uncountable) {
+			if (substr($lowercased_word, (-1*strlen($_uncountable))) == $_uncountable) {
 				return $word;
 			}
 		}
-		foreach ($irregular as $_plural=> $_singular){
+		foreach ($irregular as $_plural=> $_singular) {
 			if (preg_match('/('.$_singular.')$/i', $word, $arr)) {
-				return preg_replace('/('.$_singular.')$/i', substr($arr[0],0,1).substr($_plural,1), $word);
+				return preg_replace('/('.$_singular.')$/i', substr($arr[0], 0, 1).substr($_plural, 1), $word);
 			}
 		}
 		foreach ($singular as $rule => $replacement) {

src/Exception/TableFieldUndefinedException.php

Spacing +3 added lines, -3 removed lines

@@ -12,11 +12,11 @@
 
 class TableFieldUndefinedException extends Exception {
 
-	public static function fieldsNotDefinedException($fieldsNotDefined,$message)
+	public static function fieldsNotDefinedException($fieldsNotDefined, $message)
 	{
-		$splittedArray = implode(",",$fieldsNotDefined);
+		$splittedArray = implode(",", $fieldsNotDefined);
 
-		return new static ($splittedArray."  ".$message );
+		return new static ($splittedArray."  ".$message);
 	}
 
 }
\ No newline at end of file

src/Exception/NullArgumentPassedToFunctionException.php

Spacing +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
 
 use Exception;
 
-class NullArgumentPassedToFunction  extends  Exception{
+class NullArgumentPassedToFunction  extends  Exception {
 
 	public static function nullArgumentPassedToFunction($message)
 	{