Waca\DataObject

Complexity

Total Complexity

11

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

7.69%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
	save()	0	1	?
A	getId()	0	4	1
A	getDatabase()	0	4	1
A	delete()	0	23	3
A	getUpdateVersion()	0	4	1
A	setUpdateVersion()	0	4	1
A	isNew()	0	4	1
A	getById()	0	18	2
A	setDatabase()	0	4	1

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 *                                                                            *
 * All code in this file is released into the public domain by the ACC        *
 * Development Team. Please see team.json for a list of contributors.         *
 ******************************************************************************/

namespace Waca;

use Waca\Exceptions\OptimisticLockFailedException;

/**
 * DataObject is the base class for all the database access classes. Each
 * "DataObject" holds one record from the database, and provides functions to
 * allow loading from and saving to the database.
 *
 * Note: This requires the database tables to be named the same as the classes,
 * and the database tables must have an "id" column. Simple views can be used
 * as a way of aliasing to allow for a transition period.
 *
 * @author Simon Walker
 */
abstract class DataObject
{
    /** @var int ID of the object */
    protected $id = null;
    /** @var int update version for optimistic locking */
    protected $updateversion = 0;
    /**
     * @var PdoDatabase
     */
    protected $dbObject;

    /**
     * Retrieves a data object by it's row ID.
     *
     * @param int         $id
     * @param PdoDatabase $database
     *
     * @return DataObject|false
     */
    public static function getById($id, PdoDatabase $database)
    {
        $array = explode('\\', get_called_class());
        $realClassName = strtolower(end($array));

        $statement = $database->prepare("SELECT * FROM {$realClassName} WHERE id = :id LIMIT 1;");
        $statement->bindValue(":id", $id);

        $statement->execute();

        $resultObject = $statement->fetchObject(get_called_class());

        if ($resultObject != false) {
            $resultObject->setDatabase($database);
        }

        return $resultObject;
    }

    public function setDatabase(PdoDatabase $db)
    {
        $this->dbObject = $db;
    }

    /**
     * Gets the database associated with this data object.
     * @return PdoDatabase
     */
    public function getDatabase()
    {
        return $this->dbObject;
    }

    /**
     * Saves a data object to the database, either updating or inserting a record.
     *
     * @return void
     */
    abstract public function save();

    /**
     * Retrieves the ID attribute
     */
    public function getId()
    {
        return (int)$this->id;
    }

    /**
     * Deletes the object from the database
     */
    public function delete()
    {
        if ($this->id === null) {
            // wtf?
            return;
        }

        $array = explode('\\', get_called_class());
        $realClassName = strtolower(end($array));

        $deleteQuery = "DELETE FROM {$realClassName} WHERE id = :id AND updateversion = :updateversion LIMIT 1;";
        $statement = $this->dbObject->prepare($deleteQuery);

        $statement->bindValue(":id", $this->id);
        $statement->bindValue(":updateversion", $this->updateversion);
        $statement->execute();

        if ($statement->rowCount() !== 1) {
            throw new OptimisticLockFailedException();
        }

        $this->id = null;
    }

    /**
     * @return int
     */
    public function getUpdateVersion()
    {
        return $this->updateversion;
    }

    /**
     * Sets the update version.
     *
     * You should never call this to change the value of the update version. You should only call it when passing user
     * input through.
     *
     * @param int $updateVersion
     */
    public function setUpdateVersion($updateVersion)
    {
        $this->updateversion = $updateVersion;
    }

    /**
     * @return bool
     */
    public function isNew()
    {
        return $this->id === null;
    }
}