Laztopaz\potatoORM\BaseModel

Complexity

Total Complexity

22

Size/Duplication

Total Lines	178
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes	1
Bugs	1	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	__get()	0	5	1
A	__set()	0	5	1
A	getAll()	0	12	2
B	save()	0	29	5
B	find()	0	18	5
A	destroy()	0	19	4
A	getClassName()	0	9	1
A	checkIfRecordIsEmpty()	0	9	2

<?php

/**
 * @package  Laztopaz\potato-ORM
 * @author   Temitope Olotin <temitope.olotin@andela.com>
 * @license  <https://opensource.org/license/MIT> MIT
 */

namespace Laztopaz\potatoORM;

use Laztopaz\potatoORM\DatabaseHandler;
use Laztopaz\potatoORM\InterfaceBaseClass;
use Laztopaz\potatoORM\NoRecordDeletionException;
use Laztopaz\potatoORM\NoRecordFoundException;
use Laztopaz\potatoORM\NoRecordInsertionException;
use Laztopaz\potatoORM\NullArgumentPassedToFunction;
use Laztopaz\potatoORM\WrongArgumentException;
use Laztopaz\potatoORM\NoArgumentPassedToFunctionException;
use Laztopaz\potatoORM\EmptyArrayException;

class BaseModel  implements InterfaceBaseClass

Expected 1 space after class name; 2 found

Expected 1 space before implements keyword; 2 found

{
    protected $databaseModel; // Private variable that contains instance of database
    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

    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
     * @return associative array
     * @throws NoRecordFoundException
     */
    public static function getAll()
    {
        $allData = DatabaseHandler::read($id = false, self::getClassName());

        if (count($allData) > 0) {
            return $allData;

The return type of return $allData; (array) is incompatible with the return type declared by the interface Laztopaz\potatoORM\InterfaceBaseClass::getAll of type Laztopaz\potatoORM\associative.

        }

        throw NoRecordFoundException::checkNoRecordFoundException("There is no record to display");

    }
    
    /**
     * This method create or update record in a database table
     * @params void
     * @return bool true or false;
     * @throws EmptyArrayException
     * @throws NoRecordInsertionException
     * @throws NoRecordUpdateException
     */
    public function save()
    {
        $boolCommit = false;

$boolCommit is not used, you could remove the assignment.

        if ($this->properties['id']) {
            $allData = DatabaseHandler::read($id = $this->properties['id'], self::getClassName());

            if ($this->checkIfRecordIsEmpty($allData)) {
                $boolCommit = $this->databaseModel->update(['id' => $this->properties['id']], $this->tableName, $this->properties);

                if ($boolCommit) {
                    return true;

                }

                throw NoRecordUpdateException::checkNoRecordUpdateException("Record not updated successfully");
            }

            throw EmptyArrayException::checkEmptyArrayException("Value passed didn't match any record");
        }

        $boolCommit = $this->databaseModel->create($this->properties, $this->tableName);

        if ($boolCommit) {
            return true;
        }

        throw NoRecordInsertionException::checkNoRecordAddedException("Record not created successfully");
    }

    /**
     * This method find a record by id
     * @params int id
     * @return Object
     * @throws NoArgumentPassedToFunctionException
     */
    public static function find($id)
    {
        $num_args = (int) func_num_args(); // get number of arguments passed to

        if ($num_args == 0 || $num_args > 1) {
            throw NoArgumentPassedToFunctionException::checkNoArgumentPassedToFunction("Argument missing: only one argument is allowed");
        }

        if ($id == "") {
            throw NullArgumentPassedToFunction::checkNullArgumentPassedToFunction("This function expect a value");
        }

        $staticFindInstance = new static();
        $staticFindInstance->id = $id == "" ? false : $id;

The property id does not exist on object<Laztopaz\potatoORM\BaseModel>. Since you implemented __set, maybe consider adding a @property annotation.

        return $staticFindInstance;
        
    }
    
    /**
     * This method delete a row from the table by the row id
     * @params int id
     * @return boolean true or false
     * @throws NoRecordDeletionException;
     */
    public static function destroy($id)
    {
        $boolDeleted = false;

$boolDeleted is not used, you could remove the assignment.

        $num_args = (int) func_num_args(); // get number of arguments passed to
        
        if ($num_args == 0 || $num_args > 1) {
            throw NoArgumentPassedToFunctionException::checkNoArgumentPassedToFunction("Argument missing: only one argument is allowed");
        }

        $boolDeleted = DatabaseHandler::delete($id, self::getClassName());

        if ($boolDeleted) {
            return true;

        }

        throw NoRecordDeletionException::checkNoRecordUpdateException("Record deletion unsuccessful because id does not match any record");

The method checkNoRecordUpdateException() does not seem to exist on object<Laztopaz\potatoORM\NoRecordDeletionException>.

    }

   /**
    * This method return the current class name
    * $params void
    * @return classname
    */
   public static function getClassName()
   {
       $tableName = preg_split('/(?=[A-Z])/', get_called_class());
       
       $className = end($tableName);

       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;
    }

}