andela-araimi / potato-orm

src/Model/DataBaseModel.php

<?php

/**
 * Class DataBaseModel:
 * This is an abstract class which stands as a model
 * to another class e.g User class which can inherit from
 * all its methods. This class stands as a middle man
 * between the User class and the DataBaseQuery class.
 *
 * @author: Raimi Ademola <ademola.raimi@andela.com>
 * @copyright: 2016 Andela
 */
namespace Demo;

use Doctrine\Common\Inflector\Inflector;
use Demo\DataBaseConnection;

abstract class DataBaseModel implements DataBaseModelInterface
{
    protected $tableName;
    protected $dataBaseQuery;
    protected $arrayField;

    /**
     * This is a constructor; a default method  that will be called automatically during class instantiation.
     */
    public function __construct()
    {
        $this->tableName = self::getClassName();
        $this->dataBaseQuery = new DataBaseQuery();
        $this->arrayField['id'] = 0;
    }

    /**
     * The magic setter method.
     *
     * @param $properties
     * @param $values
     *
     * @return array associative array properties
     */
    public function __set($properties, $values)
    {
        $this->arrayField[$properties] = $values;
    }

    /**
     * The magic getter method.
     *
     * @param $properties
     *
     * @return array key
     */
    public function __get($properties)
    {
        return $this->arrayField[$properties];
    }

    /**
     * This method gets all the record from a particular table
     * by accessing the read method from the DataBaseQuery class.
     *
     *
     * @return associative array
     */
    public static function getAll($dbConn = null)
    {
        if (is_null($dbConn)) {
            $dbConn = new DatabaseConnection();
        }

        $sqlData = DataBaseQuery::read($id = false, self::getClassName(), $dbConn);

        if (count($sqlData) > 0) {
            return $sqlData;
        }

        self::throwNoDataFoundException();
    }
    
    /**
     * This method either create or update record in a database table
     * by calling either the read method or create method in the
     * DataBaseQuery class.
     *
     * @throws NoRecordUpdateException
     * @throws EmptyArrayException
     * @throws NoRecordCreatedException
     *
     * @return bool true or false;
     */
    public function save($dbConn = null)
    {
        if (is_null($dbConn)) {
            $dbConn = new DatabaseConnection();
        }

        if ($this->arrayField['id']) {
            $sqlData = DataBaseQuery::read($this->arrayField['id'], self::getClassName(), $dbConn);

            if ($this->checkIfRecordIsEmpty($sqlData)) {
                $boolCommit = $this->dataBaseQuery->update(['id' => $this->arrayField['id']], $this->arrayField, self::getClassName());
    
                if ($boolCommit) {
                    return true;
                }

                $this->throwNoRecordUpdatedException();
            }

            $this->throwEmptyArrayException();
        } else {

            $boolCommit = $this->dataBaseQuery->create($this->arrayField, self::getClassName());

            if ($boolCommit) {
                return true;
            }

            $this->throwNoRecordCreatedException();
        }
    }

    /**
     * This method find a record by id.
     *
     * @param $id
     *
     * @throws ArgumentNumberIncorrectException
     * @throws ArgumentNotFoundException
     *
     * @return object
     */
    public static function findById($id)
    {
        $numArgs = func_num_args();

        if ($numArgs > 1) {
            throw new ArgumentNumberIncorrectException('Please input just one Argument');
        }

        if ($id == '') {
            throw new ArgumentNotFoundException('No Argument found, please input an argument');
        }

        $staticFindInstance = new static();

        $staticFindInstance->id = $id;

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

        return $staticFindInstance;
    }

    /**
     * This method find a record by id and returns
     * all the data present in the id.
     *
     *
     * @return associative array
     */
    public function getById()
    {
        if ($this->arrayField['id']) {
            $sqlData = DataBaseQuery::read($this->arrayField['id'], self::getClassName());
            
            return $sqlData;
        }
    }

    /**
     * This method delete a row from the table by the row id.
     *
     * @param $id
     *
     * @throws ArgumentNumberIncorrectException;
     * @throws ArgumentNotFoundException;
     *
     * @return bool true
     */
    public static function destroy($id, $dbConn = null)
    {
        if (is_null($dbConn)) {
            $dbConn = new DatabaseConnection();
        }

        $numArgs = func_num_args();

        if ($numArgs > 2) {
            throw new ArgumentNumberIncorrectException('Please input just one Argument');
        }

        if ($numArgs == ' ') {
            throw new ArgumentNotFoundException('No Argument found, please input an argument');
        }

        DataBaseQuery::delete($id, self::getClassName(), $dbConn);

        return true;
    }

    public static function getClassName()
    {
        $tableName = explode('\\', get_called_class());
        
        return Inflector::pluralize(strtolower(end($tableName)));
    }

    /**
     * This method check if the argument passed to this function is an array.
     *
     * @param $arrayOfRecord
     *
     * @return bool true
     */
    public function checkIfRecordIsEmpty($arrayOfRecord)
    {
        if (count($arrayOfRecord) > 0) {
            return true;
        }

        return false;
    }

    /**
     * This method throws exception if record is not updated succesfully.
     *
     * @throws $NoRecordUpdatedException
     */
    public function throwNoRecordUpdatedException()
    {
        $message = "oops, your record did not update succesfully";
        throw new NoRecordUpdatedException($message);
    }

    /**
     * This method throws exception if data did not match any record.
     *
     * @throws $EmptyArrayException
     */
    public function throwEmptyArrayException()
    {
        $message = "data passed didn't match any record";
        throw new EmptyArrayException($message);
    }

    /**
     * This method throws exception if record did not create successfully.
     *
     * @throws $NoRecordCreatedException
     */
    public function throwNoRecordCreatedException()
    {
        $message = "oops,your record did not create succesfully";
        throw new NoRecordCreatedException($message);
    }

    /**
     * This method throws exception if no data is found.
     *
     * @throws $NoDataFoundException
     */
    public static function throwNoDataFoundException()
    {
        $message = "oops, no data found in the table";
        throw new NoDataFoundException($message);
    }
}