vzlogger/backend/lib/model/databaseobject.php

<?php
/*
 * Copyright (c) 2010 by Justin Otherguy <justin@justinotherguy.org>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License (either version 2 or
 * version 3) as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * For more information on the GPL, please go to:
 * http://www.gnu.org/copyleft/gpl.html
 */

abstract class DatabaseObject {
	protected $dbh;				// database handle for all queries in DBObject subclasses

	private $dirty;				// do we need to update the database?
	private $data = array();

	static private $instances = array();	// singletons of objects

	/*
	 * magic functions
	 */
	final public function __construct($object) {
		$this->dbh = Database::getConnection();
		$this->data = $object;
	}

	public function __get($key) {
		if (!isset($this->data[$key]) && $this->id) {
			$this->load();
		}

		return $this->data[$key];
	}

	public function __set($key, $value) {	// TODO untested
		if ($key == 'id' || $key == 'uuid') {
			throw new DatabaseException($key . ' will be generated automatically');
		}
		
		$this->data[$key] = $value;
		$this->dirty = true;
	}

	final public function __sleep() {
		$this->save();
		return array('id');
	}

	final public function __wakeup() {
		$this->dbh = Database::getConnection();
	}

	final public function __isset($key) {
		return isset($this->data[$key]);
	}

	/*
	 * insert oder update the database representation of the object
	 */
	public function save() {
		if (isset($this->id)) {	// just update
			$this->update();
		}
		else {				// insert new row
			$this->insert();
		}
	}

	private function insert() {
		$this->uuid = Uuid::mint();
		
		$sql = 'INSERT INTO ' . static::table . ' (' . implode(', ', array_keys($this->data)) . ') VALUES (' . implode(', ', array_map(array($this->dbh, 'escape'), $this->data)) . ')';
		$this->dbh->execute($sql);
		$this->id = $this->dbh->lastInsertId();
		
		$this->dirty = false;
	}

	private function update() {
		foreach ($this->data as $column => $value) {
			if ($column != 'id') {
				$columns[] = $column . ' = ' . $this->dbh->escape($value);
			}
		}

		$sql = 'UPDATE ' . static::table . ' SET ' . implode(', ', $columns) . ' WHERE id = ' . (int) $this->id;
		$this->dbh->execute($sql);
		
		$this->dirty = false;
	}

	/*
	 * loads all columns from the database and caches them in $this->data
	 */
	private function load() {
		$result = $this->dbh->query('SELECT * FROM ' . static::table . ' WHERE id = ' . (int) $this->id, 1)->current();
			
		if ($result == false) {
			unset($this->data['id']);
			return false;
		}
		else {
			$this->data = $result;
			$this->loaded = true;
			return true;
		}
	}

	/*
	 * deletes database representation of this object, but leaves object members.
	 * by calling $this->save() you can easily reinsert the object with a new id
	 */
	public function delete() {
		$this->dbh->execute('DELETE FROM ' . static::table . ' WHERE id = ' . (int) $this->id);	// delete from database
		unset($this->data['id']);
	}

	/*
	 * simple self::getByFilter() wrapper
	 */
	public static function getByUuid($uuid) {
		$obj = current(self::getByFilter(array('uuid' => $uuid)));

		if ($obj === false) {
			throw new InvalidArgumentException('No such object!');
		}

		return $obj;
	}
	
	static protected function factory($object) {
		if (!isset(self::$instances[static::table])) {
			self::$instances[static::table] = array();
		}
		
		if (!isset(self::$instances[static::table][$object['id']])) {
			self::$instances[static::table][$object['id']] = new static($object);	// create singleton instance of database object
		}
		
		return self::$instances[static::table][$object['id']];	// return singleton instance of database object
	}

	/*
	 * data filtering
	 */
	static public function getByFilter($filters = array(), $conjunction = true) {
		$sql = static::buildFilterQuery($filters, $conjunction);
		$result = Database::getConnection()->query($sql);

		$instances = array();
		foreach ($result as $object) {
			$instances[$object['id']] = static::factory($object);
		}

		return $instances;
	}

	static protected function buildFilterQuery($filters, $conjunction) {
		return 'SELECT ' . static::table . '.* FROM ' . static::table . static::buildFilterCondition($filters, $conjunction);
	}

	static protected function buildFilterCondition($filters, $conjunction) {
		$dbh = Database::getConnection();

		$where = array();
		foreach ($filters as $column => $value) {
			if (is_array($value)) {
				$where[] = $column . ' IN (' . implode(', ', array_map(array(Database::getConnection(), 'escape'), $value)) . ')';
			}
			else {
				$where[] = $column . ' = ' . $dbh->escape($value);
			}
		}

		if (count($where) > 0) {
			return ' WHERE ' . implode(($conjunction === true) ? ' && ' : ' || ', $where);
		}
	}
}

?>