andela-tolotin / Potato-ORM

src/Helper/InflectorClass.php

Indentation +1 added lines, -1 removed lines

@@ -10,5 +10,5 @@
 
 class Inflector {
 	
-    use Inflector;
+	use Inflector;
 }

src/Model/BaseModel.php

Doc Comments +2 added lines, -2 removed lines

@@ -120,7 +120,7 @@ 
      *
      * @throws NoArgumentPassedToFunctionException
      *
-     * @return object
+     * @return BaseModel
      */
     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()
    {

Indentation +181 added lines, -181 removed lines

@@ -8,169 +8,169 @@ 
 
 class BaseModel implements BaseModelInterface
 {
-    // Inject the inflector trait
-    use Inflector;
-
-    // Private variable that contains instance of database
-    protected $databaseModel;
-
-    // Class variable holding class name pluralized
-    protected $tableName;
-
-    // Properties will later contain key, value pairs from the magic setter, getter methods
-    protected $properties = [];
-
-    public function __construct()
-    {
-        $this->tableName = $this->getClassName();
-
-        $this->databaseModel = new DatabaseHandler($this->tableName);
-
-        $this->properties['id'] = 0;
-    }
-
-    /**
-     * The magic getter method.
-     *
-     * @params key
-     *
-     * @return array key
-     */
-    public function __get($key)
-    {
-        $this->properties[$key];
-    }
-
-    /**
-     * The magic setter method.
-     *
-     * @params property, key
-     *
-     * @return array associative array properties
-     */
-    public function __set($property, $value)
-    {
-        $this->properties[$property] = $value;
-    }
-
-    /**
-     * This method gets all the record from a particular table.
-     *
-     * @params void
-     *
-     * @throws NoRecordFoundException
-     *
-     * @return associative array
-     */
-    public static function getAll()
-    {
-        $allData = DatabaseHandler::read($id = false, self::getClassName());
-
-        if (count($allData) > 0) {
-            return $allData;
-        }
-
-        throw NoRecordFoundException::create('There is no record to display');
-    }
-
-    /**
-     * This method create or update record in a database table.
-     *
-     * @params void
-     *
-     * @throws EmptyArrayException
-     * @throws NoRecordInsertionException
-     * @throws NoRecordUpdateException
-     *
-     * @return bool true or false;
-     */
-    public function save($dbConn = Null)
-    {
-        if (is_null($dbConn)) {
-            $dbConn = new DatabaseConnection();
-        }
-
-        $boolCommit = false;
-
-        if ($this->properties['id']) {
-
-            $allData = DatabaseHandler::read($this->properties['id'], self::getClassName(), $dbConn);
-
-            if ($this->checkIfRecordIsEmpty($allData)) {
-                $boolCommit = $this->databaseModel->update(['id' => $this->properties['id']], $this->tableName, $this->properties, $dbConn);
-
-                if ($boolCommit) {
-                    return true;
-                }
-
-                throw NoRecordUpdateException::create('Record not updated successfully');
-            }
-
-            throw EmptyArrayException::create("Value passed didn't match any record");
-        }
-
-        $boolCommit = $this->databaseModel->create($this->properties, $this->tableName, $dbConn);
-
-        if ($boolCommit) {
-            return true;
-        }
-
-        throw NoRecordInsertionException::create('Record not created successfully');
-    }
-
-    /**
-     * This method find a record by id.
-     *
-     * @params int id
-     *
-     * @throws NoArgumentPassedToFunctionException
-     *
-     * @return object
-     */
-    public static function find($id)
-    {
-        $num_args = (int) func_num_args(); // get number of arguments passed to this function
-        if ($num_args == 0 || $num_args > 1) {
-            throw NoArgumentPassedToFunctionException::create('Argument missing: only one argument is allowed');
-        }
-
-        if ($id == '') {
-            throw NullArgumentPassedToFunctionException::create('This function expect a value');
-        }
-
-        $staticFindInstance = new static();
-        $staticFindInstance->id = $id == '' ? false : $id;
-
-        return $staticFindInstance;
-    }
-
-    /**
-     * This method delete a row from the table by the row id.
-     *
-     * @params int id
-     *
-     * @throws NoRecordDeletionException;
-     *
-     * @return bool true or false
-     */
-    public static function destroy($id)
-    {
-        $boolDeleted = false;
-
-        $num_args = (int) func_num_args(); // get number of arguments passed to this function
-
-        if ($num_args == 0 || $num_args > 1) {
-            throw NoArgumentPassedToFunctionException::create('Argument missing: only one argument is allowed');
-        }
-
-        $boolDeleted = DatabaseHandler::delete($id, self::getClassName());
-
-        if ($boolDeleted) {
-            return true;
-        }
-
-        throw NoRecordDeletionException::create('Record deletion unsuccessful because id does not match any record');
-    }
+	// Inject the inflector trait
+	use Inflector;
+
+	// Private variable that contains instance of database
+	protected $databaseModel;
+
+	// Class variable holding class name pluralized
+	protected $tableName;
+
+	// Properties will later contain key, value pairs from the magic setter, getter methods
+	protected $properties = [];
+
+	public function __construct()
+	{
+		$this->tableName = $this->getClassName();
+
+		$this->databaseModel = new DatabaseHandler($this->tableName);
+
+		$this->properties['id'] = 0;
+	}
+
+	/**
+	 * The magic getter method.
+	 *
+	 * @params key
+	 *
+	 * @return array key
+	 */
+	public function __get($key)
+	{
+		$this->properties[$key];
+	}
+
+	/**
+	 * The magic setter method.
+	 *
+	 * @params property, key
+	 *
+	 * @return array associative array properties
+	 */
+	public function __set($property, $value)
+	{
+		$this->properties[$property] = $value;
+	}
+
+	/**
+	 * This method gets all the record from a particular table.
+	 *
+	 * @params void
+	 *
+	 * @throws NoRecordFoundException
+	 *
+	 * @return associative array
+	 */
+	public static function getAll()
+	{
+		$allData = DatabaseHandler::read($id = false, self::getClassName());
+
+		if (count($allData) > 0) {
+			return $allData;
+		}
+
+		throw NoRecordFoundException::create('There is no record to display');
+	}
+
+	/**
+	 * This method create or update record in a database table.
+	 *
+	 * @params void
+	 *
+	 * @throws EmptyArrayException
+	 * @throws NoRecordInsertionException
+	 * @throws NoRecordUpdateException
+	 *
+	 * @return bool true or false;
+	 */
+	public function save($dbConn = Null)
+	{
+		if (is_null($dbConn)) {
+			$dbConn = new DatabaseConnection();
+		}
+
+		$boolCommit = false;
+
+		if ($this->properties['id']) {
+
+			$allData = DatabaseHandler::read($this->properties['id'], self::getClassName(), $dbConn);
+
+			if ($this->checkIfRecordIsEmpty($allData)) {
+				$boolCommit = $this->databaseModel->update(['id' => $this->properties['id']], $this->tableName, $this->properties, $dbConn);
+
+				if ($boolCommit) {
+					return true;
+				}
+
+				throw NoRecordUpdateException::create('Record not updated successfully');
+			}
+
+			throw EmptyArrayException::create("Value passed didn't match any record");
+		}
+
+		$boolCommit = $this->databaseModel->create($this->properties, $this->tableName, $dbConn);
+
+		if ($boolCommit) {
+			return true;
+		}
+
+		throw NoRecordInsertionException::create('Record not created successfully');
+	}
+
+	/**
+	 * This method find a record by id.
+	 *
+	 * @params int id
+	 *
+	 * @throws NoArgumentPassedToFunctionException
+	 *
+	 * @return object
+	 */
+	public static function find($id)
+	{
+		$num_args = (int) func_num_args(); // get number of arguments passed to this function
+		if ($num_args == 0 || $num_args > 1) {
+			throw NoArgumentPassedToFunctionException::create('Argument missing: only one argument is allowed');
+		}
+
+		if ($id == '') {
+			throw NullArgumentPassedToFunctionException::create('This function expect a value');
+		}
+
+		$staticFindInstance = new static();
+		$staticFindInstance->id = $id == '' ? false : $id;
+
+		return $staticFindInstance;
+	}
+
+	/**
+	 * This method delete a row from the table by the row id.
+	 *
+	 * @params int id
+	 *
+	 * @throws NoRecordDeletionException;
+	 *
+	 * @return bool true or false
+	 */
+	public static function destroy($id)
+	{
+		$boolDeleted = false;
+
+		$num_args = (int) func_num_args(); // get number of arguments passed to this function
+
+		if ($num_args == 0 || $num_args > 1) {
+			throw NoArgumentPassedToFunctionException::create('Argument missing: only one argument is allowed');
+		}
+
+		$boolDeleted = DatabaseHandler::delete($id, self::getClassName());
+
+		if ($boolDeleted) {
+			return true;
+		}
+
+		throw NoRecordDeletionException::create('Record deletion unsuccessful because id does not match any record');
+	}
 
    /**
     * This method return the current class name
@@ -180,26 +180,26 @@ 
     */
    public static function getClassName()
    {
-       $tableName = preg_split('/(?=[A-Z])/', get_called_class());
+	   $tableName = preg_split('/(?=[A-Z])/', get_called_class());
 
-       $className = end($tableName);
+	   $className = end($tableName);
 
-       return self::pluralize(strtolower($className));
+	   return self::pluralize(strtolower($className));
    }
 
-    /**
-     * This method check if the argument passed to this function is an array.
-     *
-     * @param $arrayOfRecord
-     *
-     * @return bool
-     */
-    public function checkIfRecordIsEmpty($arrayOfRecord)
-    {
-        if (count($arrayOfRecord) > 0) {
-            return true;
-        }
-
-        return false;
-    }
+	/**
+	 * This method check if the argument passed to this function is an array.
+	 *
+	 * @param $arrayOfRecord
+	 *
+	 * @return bool
+	 */
+	public function checkIfRecordIsEmpty($arrayOfRecord)
+	{
+		if (count($arrayOfRecord) > 0) {
+			return true;
+		}
+
+		return false;
+	}
 }

src/Exceptions/TableFieldUndefinedException.php

Indentation +5 added lines, -5 removed lines

@@ -10,10 +10,10 @@
 
 class TableFieldUndefinedException extends Exception
 {
-    public static function create($unExpectedFields, $message)
-    {
-        $fields = implode(', ', $unExpectedFields);
+	public static function create($unExpectedFields, $message)
+	{
+		$fields = implode(', ', $unExpectedFields);
 
-        return new static($fields.' '.$message);
-    }
+		return new static($fields.' '.$message);
+	}
 }

src/Exceptions/NullArgumentPassedToFunctionException.php

Indentation +4 added lines, -4 removed lines

@@ -10,8 +10,8 @@
 
 class NullArgumentPassedToFunctionException extends Exception
 {
-    public static function create($message)
-    {
-        return new static ($message);
-    }
+	public static function create($message)
+	{
+		return new static ($message);
+	}
 }

src/Exceptions/NoRecordDeletionException.php

Indentation +4 added lines, -4 removed lines

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

src/Exceptions/NoRecordInsertionException.php

Indentation +4 added lines, -4 removed lines

@@ -10,8 +10,8 @@
 
 class NoRecordInsertionException extends Exception
 {
-    public static function create($mesaage)
-    {
-        return new static($mesaage);
-    }
+	public static function create($mesaage)
+	{
+		return new static($mesaage);
+	}
 }

src/Helper/Inflector.php

Indentation +57 added lines, -57 removed lines

@@ -37,62 +37,62 @@
 
 trait Inflector
 {
-    /**
-     * Pluralizes English nouns.
-     *
-     * @static
-     *
-     * @param string $word English noun to pluralize
-     *
-     * @return string Plural noun
-     */
-    public static function pluralize($word)
-    {
-        $plural = [
-            '/(quiz)$/i'                     => '$1zes',
-            '/^(ox)$/i'                      => '$1en',
-            '/([m|l])ouse$/i'                => '$1ice',
-            '/(matr|vert|ind)ix|ex$/i'       => '$1ices',
-            '/(x|ch|ss|sh)$/i'               => '$1es',
-            '/([^aeiouy]|qu)y$/i'            => '$1ies',
-            '/(hive)$/i'                     => '$1s',
-            '/(?:([^f])fe|([lr])f)$/i'       => '$1$2ves',
-            '/(shea|lea|loa|thie)f$/i'       => '$1ves',
-            '/sis$/i'                        => 'ses',
-            '/([ti])um$/i'                   => '$1a',
-            '/(tomat|potat|ech|her|vet)o$/i' => '$1oes',
-            '/(bu)s$/i'                      => '$1ses',
-            '/(alias)$/i'                    => '$1es',
-            '/(octop)us$/i'                  => '$1i',
-            '/(ax|test)is$/i'                => '$1es',
-            '/(us)$/i'                       => '$1es',
-            '/s$/i'                          => 's',
-            '/$/'                            => 's',
-        ];
-        $uncountable = ['equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep'];
-        $irregular = [
-            'person' => 'people',
-            'man'    => 'men',
-            'child'  => 'children',
-            'sex'    => 'sexes',
-            'move'   => 'moves', ];
-        $lowercased_word = strtolower($word);
-        foreach ($uncountable as $_uncountable) {
-            if (substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable) {
-                return $word;
-            }
-        }
-        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);
-            }
-        }
-        foreach ($plural as $rule => $replacement) {
-            if (preg_match($rule, $word)) {
-                return preg_replace($rule, $replacement, $word);
-            }
-        }
+	/**
+	 * Pluralizes English nouns.
+	 *
+	 * @static
+	 *
+	 * @param string $word English noun to pluralize
+	 *
+	 * @return string Plural noun
+	 */
+	public static function pluralize($word)
+	{
+		$plural = [
+			'/(quiz)$/i'                     => '$1zes',
+			'/^(ox)$/i'                      => '$1en',
+			'/([m|l])ouse$/i'                => '$1ice',
+			'/(matr|vert|ind)ix|ex$/i'       => '$1ices',
+			'/(x|ch|ss|sh)$/i'               => '$1es',
+			'/([^aeiouy]|qu)y$/i'            => '$1ies',
+			'/(hive)$/i'                     => '$1s',
+			'/(?:([^f])fe|([lr])f)$/i'       => '$1$2ves',
+			'/(shea|lea|loa|thie)f$/i'       => '$1ves',
+			'/sis$/i'                        => 'ses',
+			'/([ti])um$/i'                   => '$1a',
+			'/(tomat|potat|ech|her|vet)o$/i' => '$1oes',
+			'/(bu)s$/i'                      => '$1ses',
+			'/(alias)$/i'                    => '$1es',
+			'/(octop)us$/i'                  => '$1i',
+			'/(ax|test)is$/i'                => '$1es',
+			'/(us)$/i'                       => '$1es',
+			'/s$/i'                          => 's',
+			'/$/'                            => 's',
+		];
+		$uncountable = ['equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep'];
+		$irregular = [
+			'person' => 'people',
+			'man'    => 'men',
+			'child'  => 'children',
+			'sex'    => 'sexes',
+			'move'   => 'moves', ];
+		$lowercased_word = strtolower($word);
+		foreach ($uncountable as $_uncountable) {
+			if (substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable) {
+				return $word;
+			}
+		}
+		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);
+			}
+		}
+		foreach ($plural as $rule => $replacement) {
+			if (preg_match($rule, $word)) {
+				return preg_replace($rule, $replacement, $word);
+			}
+		}
 
-        return false;
-    }
+		return false;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -78,7 +78,7 @@
             'move'   => 'moves', ];
         $lowercased_word = strtolower($word);
         foreach ($uncountable as $_uncountable) {
-            if (substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable) {
+            if (substr($lowercased_word, (-1*strlen($_uncountable))) == $_uncountable) {
                 return $word;
             }
         }

src/Exceptions/NoRecordFoundException.php

Indentation +4 added lines, -4 removed lines

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

src/Exceptions/NoArgumentPassedToFunctionException.php

Indentation +4 added lines, -4 removed lines

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