Библиотека для cis, online, cms1

creole/contrib/DebugConnection.php

@@ -0,0 +1,268 @@
+<?php
+
+/**
+ * Debug implementation of Connection.
+ *
+ * This is a Connection that implements the decorator pattern, wrapping around
+ * the true Connection object (stored in $childConnection). This Connection
+ * tracks information about queries executed and makes that information available
+ * for debugging purposes. The information tracked is the last query executed
+ * on the connection (getLastExecutedQuery()) and the total number of
+ * queries executed on the connection thus far (getNumQueriesExecuted()).
+ *
+ * To use this debug connection, you need to register it as a new Creole
+ * driver that handles all connection types. To do this, call the following
+ * before calling Creole::getConnection():
+ *
+ * <code>
+ * Creole::registerDriver('*', 'creole.drivers.debug.DebugConnection');
+ * </code>
+ *
+ * The next call to Creole::getConnection() will return an instance of
+ * DebugConnection.
+ *
+ * @author Michael Sims
+ * @package creole.drivers.debug
+ */
+class DebugConnection implements Connection {
+
+	/** @var Connection */
+	private $childConnection = null;
+	
+	/** @var int */
+	private $numQueriesExecuted = 0;
+	
+	/** @var string */
+	private $lastExecutedQuery = '';
+
+	/**
+	 * @var object Instance of PEAR Log (or other class with log() method).
+	 */
+	private $logger;
+	
+	/**
+	 * Sets a Logger class (e.g. PEAR Log) to use for logging.
+	 * The logger class must have a log() method.  All messages are logged at default log level.
+	 * @param object $logger
+	 */
+	public function setLogger($logger)
+	{
+		$this->logger = $logger;
+	}
+	
+	/**
+	 * Returns the number of queries executed on this connection so far
+	 *
+	 * @return int
+	 */
+	public function getNumQueriesExecuted()
+	{
+		return $this->numQueriesExecuted;
+	}
+	
+	/**
+	 * Returns the last query executed on this connection
+	 *
+	 * @return string
+	 */
+	public function getLastExecutedQuery()
+	{
+		return $this->lastExecutedQuery;
+	}
+	
+	/**
+	 * connect()
+	 */
+	public function connect($dsninfo, $flags = 0)
+	{
+		if (!($driver = Creole::getDriver($dsninfo['phptype']))) {
+			throw new SQLException("No driver has been registered to handle connection type: $type");
+		}		
+		$connectionClass = Creole::import($driver);
+		$this->childConnection = new $connectionClass();
+		$this->log("connect(): DSN: ". var_export($dsninfo, true) . ", FLAGS: " . var_export($flags, true));
+		return $this->childConnection->connect($dsninfo, $flags);
+	}
+	
+	/**
+	 * @see Connection::getDatabaseInfo()
+	 */
+	public function getDatabaseInfo()
+	{
+		return $this->childConnection->getDatabaseInfo();
+	}
+	
+	/**
+	 * @see Connection::getIdGenerator()
+	 */
+	public function getIdGenerator()
+	{
+		return $this->childConnection->getIdGenerator();
+	}
+	
+	/**
+	 * @see Connection::isConnected()
+	 */
+	public function isConnected()
+	{
+		return $this->childConnection->isConnected();
+	}
+	
+	/**
+	 * @see Connection::prepareStatement()
+	 */
+	public function prepareStatement($sql)
+	{
+		$this->log("prepareStatement(): $sql");
+		$obj = $this->childConnection->prepareStatement($sql);
+		$objClass = get_class($obj);		
+		return new $objClass($this, $sql);
+	}
+	
+	/**
+	 * @see Connection::createStatement()
+	 */
+	public function createStatement()
+	{
+		$obj = $this->childConnection->createStatement();
+		$objClass = get_class($obj);		
+		return new $objClass($this);
+	}
+	
+	/**
+	 * @see Connection::applyLimit()
+	 */
+	public function applyLimit(&$sql, $offset, $limit)
+	{
+		$this->log("applyLimit(): $sql, offset: $offset, limit: $limit");
+		return $this->childConnection->applyLimit($sql, $offset, $limit);
+	}
+	
+	/**
+	 * @see Connection::close()
+	 */
+	public function close()
+	{
+		$this->log("close(): Closing connection.");
+		return $this->childConnection->close();
+	}
+	
+	/**
+	 * @see Connection::executeQuery()
+	 */
+	public function executeQuery($sql, $fetchmode = null)
+	{
+		$this->log("executeQuery(): $sql");
+		$this->lastExecutedQuery = $sql;
+		$this->numQueriesExecuted++;
+		return $this->childConnection->executeQuery($sql, $fetchmode);	
+	}
+	
+	/**
+	 * @see Connection::executeUpdate()
+	 */
+	public function executeUpdate($sql)
+	{
+		$this->log("executeUpdate(): $sql");
+		$this->lastExecutedQuery = $sql;
+		$this->numQueriesExecuted++;
+		return $this->childConnection->executeUpdate($sql);	
+	}
+	
+	/**
+	 * @see Connection::getUpdateCount()
+	 */
+	public function getUpdateCount()
+	{
+		return $this->childConnection->getUpdateCount();
+	}
+	
+	/**
+	 * @see Connection::prepareCall()
+	 **/
+	public function prepareCall($sql)
+	{
+		$this->log("prepareCall(): $sql");
+		return $this->childConnection->prepareCall($sql);
+	}
+	
+	/**
+	 * @see Connection::getResource()
+	 */
+	public function getResource()
+	{
+		return $this->childConnection->getResource();
+	}
+	
+	/**
+	 * @see Connection::connect()
+	 */
+	public function getDSN()
+	{
+		return $this->childConnection->getDSN();
+	}
+	
+	/**
+	 * @see Connection::getFlags()
+	 */
+	public function getFlags()
+	{
+		return $this->childConnection->getFlags();
+	}
+	
+	/**
+	 * @see Connection::begin()
+	 */
+	public function begin()
+	{
+		$this->log("Beginning transaction.");
+		return $this->childConnection->begin();
+	}
+	
+	/**
+	 * @see Connection::commit()
+	 */
+	public function commit()
+	{
+		$this->log("Committing transaction.");
+		return $this->childConnection->commit();
+	}
+	
+	/**
+	 * @see Connection::rollback()
+	 */
+	public function rollback()
+	{
+		$this->log("Rolling back transaction.");
+		return $this->childConnection->rollback();
+	}
+	
+	/**
+	 * @see Connection::setAutoCommit()
+	 */
+	public function setAutoCommit($bit)
+	{
+		$this->log("Setting autocommit to: " . var_export($bit, true));
+		return $this->childConnection->setAutoCommit($bit);
+	}
+	
+	/**
+	 * @see Connection::getAutoCommit()
+	 */
+	public function getAutoCommit()
+	{
+		return $this->childConnection->getAutoCommit();
+	}
+	
+	/**
+	 * Private function that logs message using specified logger (if provided).
+	 * @param string $msg Message to log.
+	 */
+	private function log($msg)
+	{
+		if ($this->logger) {
+			$this->logger->log($msg);
+		}
+	}
+
+}