Anax\DatabaseActiveRecord\ActiveRecordModel

Complexity

Total Complexity

23

Size/Duplication

Total Lines	346
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	findAllWhere()	0	10	2
A	setDb()	0	3	1
A	checkDb()	0	4	2
A	delete()	0	11	2
A	create()	0	13	1
A	findAll()	0	8	1
A	updateWhere()	0	15	2
A	saveWhere()	0	3	1
A	getProperties()	0	10	1
A	save()	0	7	2
A	find()	0	3	1
A	findById()	0	4	2
A	update()	0	13	1
A	deleteWhere()	0	9	2
A	findWhere()	0	11	2

<?php

namespace Anax\DatabaseActiveRecord;

use Anax\DatabaseActiveRecord\Exception\ActiveRecordException;
use Anax\DatabaseQueryBuilder\DatabaseQueryBuilder;

/**
 * An implementation of the Active Record pattern to be used as
 * base class for database driven models.
 */
class ActiveRecordModel
{
    /**
     * @var DatabaseQueryBuilder $db the object for persistent
     *                               storage.
     */
    protected $db = null;



    /**
     * @var string $tableName name of the database table.
     */
    protected $tableName = null;



    /**
     * @var string $tableIdColumn name of the id column in the database table.
     */
    protected $tableIdColumn = "id";



    /**
     * Set the database object to use for accessing storage.
     *
     * @param DatabaseQueryBuilder $db as database access object.
     *
     * @return void
     */
    public function setDb(DatabaseQueryBuilder $db)
    {
        $this->db = $db;
    }



    /**
     * Check if database is injected or throw an exception.
     *
     * @throws ActiveRecordException when database is not set.
     *
     * @return void
     */
    protected function checkDb()
    {
        if (!$this->db) {
            throw new ActiveRecordException("Missing \$db, did you forget to inject/set is?");
        }
    }



    /**
     * Get essential object properties.
     *
     * @return array with object properties.
     */
    protected function getProperties()
    {
        $properties = get_object_vars($this);
        unset(
            $properties['tableName'],
            $properties['db'],
            $properties['di'],
            $properties['tableIdColumn']
        );
        return $properties;
    }



    /**
     * Find and return first object found by search criteria and use
     * its data to populate this instance.
     *
     * @param string $column to use in where statement.
     * @param mixed  $value  to use in where statement.
     *
     * @return this
     */
    public function find($column, $value) : object
    {
        return $this->findWhere("$column = ?", $value);
    }



    /**
     * Find and return first object by its tableIdColumn and use
     * its data to populate this instance.
     *
     * @param integer $id to find or use $this->{$this->tableIdColumn}
     *                    as default.
     *
     * @return this
     */
    public function findById($id = null) : object
    {
        $id = $id ?: $this->{$this->tableIdColumn};
        return $this->findWhere("{$this->tableIdColumn} = ?", $id);
    }



    /**
     * Find and return first object found by search criteria and use
     * its data to populate this instance.
     *
     * The search criteria `$where` of can be set up like this:
     *  `id = ?`
     *  `id1 = ? and id2 = ?`
     *
     * The `$value` can be a single value or an array of values.
     *
     * @param string $where to use in where statement.
     * @param mixed  $value to use in where statement.
     *
     * @return this
     */
    public function findWhere($where, $value) : object
    {
        $this->checkDb();
        $params = is_array($value) ? $value : [$value];
        $this->db->connect()
                 ->select()
                 ->from($this ->tableName)
                 ->where($where)
                 ->execute($params)
                 ->fetchInto($this);
        return $this;
    }



    /**
     * Find and return all.
     *
     * @return array of object of this class
     */
    public function findAll()
    {
        $this->checkDb();
        return $this->db->connect()
                        ->select()
                        ->from($this->tableName)
                        ->execute()
                        ->fetchAllClass(get_class($this));
    }



    /**
     * Find and return all matching the search criteria.
     *
     * The search criteria `$where` of can be set up like this:
     *  `id = ?`
     *  `id IN [?, ?]`
     *
     * The `$value` can be a single value or an array of values.
     *
     * @param string $where to use in where statement.
     * @param mixed  $value to use in where statement.
     *
     * @return array of object of this class
     */
    public function findAllWhere($where, $value)
    {
        $this->checkDb();
        $params = is_array($value) ? $value : [$value];
        return $this->db->connect()
                        ->select()
                        ->from($this->tableName)
                        ->where($where)
                        ->execute($params)
                        ->fetchAllClass(get_class($this));
    }



    /**
     * Save current object/row, insert if id is missing and do an
     * update if the id exists.
     *
     * @return void
     */
    public function save()
    {
        if (isset($this->{$this->tableIdColumn})) {
            return $this->update();

Are you sure the usage of $this->update() targeting Anax\DatabaseActiveRecord\ActiveRecordModel::update() seems to always return null.

        }

        return $this->create();

Are you sure the usage of $this->create() targeting Anax\DatabaseActiveRecord\ActiveRecordModel::create() seems to always return null.

    }



    /**
     * Save/update current object/row using a custom where-statement.
     *
     * The criteria `$where` of can be set up like this:
     *  `id = ?`
     *  `id1 = ? AND id2 = ?`
     *
     * The `$value` can be a single value or an array of values.
     *
     * @param string $where to use in where statement.
     * @param mixed  $value to use in where statement.
     *
     * @return void
     */
    public function saveWhere($where, $value)
    {
        return $this->updateWhere($where, $value);

Are you sure the usage of $this->updateWhere($where, $value) targeting Anax\DatabaseActiveRecord\ActiveRecordModel::updateWhere() seems to always return null.

    }



    /**
     * Create new row.
     *
     * @return void
     */
    protected function create()
    {
        $this->checkDb();
        $properties = $this->getProperties();
        unset($properties[$this->tableIdColumn]);
        $columns = array_keys($properties);
        $values  = array_values($properties);

        $this->db->connect()
                 ->insert($this->tableName, $columns)
                 ->execute($values);

        $this->{$this->tableIdColumn} = $this->db->lastInsertId();
    }



    /**
     * Update row using $tableIdColumn as where.
     *
     * @return void
     */
    protected function update()
    {
        $this->checkDb();
        $properties = $this->getProperties();
        unset($properties[$this->tableIdColumn]);
        $columns = array_keys($properties);
        $values  = array_values($properties);
        $values[] = $this->{$this->tableIdColumn};

        $this->db->connect()
                 ->update($this->tableName, $columns)
                 ->where("{$this->tableIdColumn} = ?")
                 ->execute($values);
    }



    /**
     * Update row using a custom where-statement.
     *
     * The criteria `$where` of can be set up like this:
     *  `id = ?`
     *  `id1 = ? AND id2 = ?`
     *  `id IN (?, ?)`
     *
     * The `$value` can be a single value or an array of values.
     *
     * @param string $where to use in where statement.
     * @param mixed  $value to use in where statement.
     *
     * @return void
     */
    protected function updateWhere($where, $value)
    {
        $this->checkDb();
        $properties = $this->getProperties();
        $columns = array_keys($properties);
        $values  = array_values($properties);
        $values1 = is_array($value)
            ? $value
            : [$value];
        $values = array_merge($values, $values1);

        $this->db->connect()
                 ->update($this->tableName, $columns)
                 ->where($where)
                 ->execute($values);
    }



    /**
     * Update row using $tableIdColumn as where and clear value of
     * `$tableIdColumn`.
     *
     * @param integer $id to delete or use $this->{$this->tableIdColumn}
     *                    as default.
     *
     * @return void
     */
    public function delete($id = null)
    {
        $this->checkDb();
        $id = $id ?: $this->{$this->tableIdColumn};

        $this->db->connect()
                 ->deleteFrom($this->tableName)
                 ->where("{$this->tableIdColumn} = ?")
                 ->execute([$id]);

        $this->{$this->tableIdColumn} = null;
    }



    /**
     * Delete row using a custom where-statement and leave value of
     * `$tableIdColumn` as it is.
     *
     * The criteria `$where` of can be set up like this:
     *  `id = ?`
     *  `id1 = ? AND id2 = ?`
     *  `id IN (?, ?)`
     *
     * The `$value` can be a single value or an array of values.
     *
     * @param string $where to use in where statement.
     * @param mixed  $value to use in where statement.
     *
     * @return void
     */
    public function deleteWhere($where, $value)
    {
        $this->checkDb();
        $values = is_array($value) ? $value : [$value];

        $this->db->connect()
                 ->deleteFrom($this->tableName)
                 ->where($where)
                 ->execute($values);
    }
}