Added QueryLogger to log the execution of queries

Author: rkrx

src/Builder/QueryStatement.php

@@ -0,0 +1,71 @@
+<?php
+namespace Kir\MySQL\Builder;
+
+use Kir\MySQL\QueryLogger\QueryLoggers;
+use PDO;
+use PDOStatement;
+
+class QueryStatement {
+	/** @var PDOStatement */
+	private $statement;
+	/** @var QueryLoggers */
+	private $queryLoggers;
+	/** @var string */
+	private $query;
+
+	/**
+	 * @param PDOStatement $stmt
+	 * @param string $query
+	 * @param QueryLoggers $queryLoggers
+	 */
+	public function __construct(PDOStatement $stmt, $query, QueryLoggers $queryLoggers) {
+		$this->statement = $stmt;
+		$this->queryLoggers = $queryLoggers;
+		$this->query = $query;
+	}
+
+	/**
+	 * @return PDOStatement
+	 */
+	public function getStatement() {
+		return $this->statement;
+	}
+
+	/**
+	 * @param array $params
+	 * @return bool
+	 */
+	public function execute(array $params = []) {
+		$timer = microtime(true);
+		$response = $this->statement->execute($params);
+		$this->queryLoggers->log($this->query, microtime(true) - $timer);
+		return $response;
+	}
+
+	/**
+	 * @param int $fetchStyle
+	 * @return array
+	 */
+	public function fetchAll($fetchStyle = PDO::FETCH_ASSOC) {
+		$args = func_get_args();
+		return call_user_func_array([$this->statement, 'fetchAll'], $args);
+	}
+
+	/**
+	 * @param int $fetchStyle
+	 * @param int $cursorOrientation
+	 * @param int $cursorOffset
+	 * @return mixed
+	 */
+	public function fetch($fetchStyle = PDO::FETCH_ASSOC, $cursorOrientation = PDO::FETCH_ORI_NEXT, $cursorOffset = 0) {
+		return $this->statement->fetch($fetchStyle, $cursorOrientation, $cursorOffset);
+	}
+
+	/**
+	 * @param int $columnNo
+	 * @return mixed
+	 */
+	public function fetchColumn($columnNo = 0) {
+		return $this->statement->fetchColumn($columnNo);
+	}
+}

src/Builder/Statement.php

@@ -5,13 +5,9 @@
 use Kir\MySQL\Tools\AliasReplacer;
 
 abstract class Statement {
-	/**
-	 * @var Database
-	 */
+	/** @var Database */
 	private $db;
-	/**
-	 * @var AliasReplacer
-	 */
+	/** @var AliasReplacer */
 	private $aliasReplacer;
 
 	/**

src/Databases/MySQL.php

@@ -3,37 +3,45 @@
 
 use Kir\MySQL\Builder;
 use Kir\MySQL\Builder\Exception;
+use Kir\MySQL\Builder\QueryStatement;
+use Kir\MySQL\Builder\Statement;
 use Kir\MySQL\Database;
+use Kir\MySQL\QueryLogger\QueryLoggers;
 use Kir\MySQL\Tools\AliasRegistry;
+use Kir\MySQL\Tools\PDOStatementInterceptor;
+use PDO;
+use PDOStatement;
 use UnexpectedValueException;
 use Kir\MySQL\Builder\RunnableSelect;
 
 /**
  */
 class MySQL implements Database {
-	/**
-	 * @var array
-	 */
+	/** @var array */
 	private static $tableFields = array();
-	/**
-	 * @var PDO
-	 */
+	/** @var PDO */
 	private $pdo;
-	/**
-	 * @var AliasRegistry
-	 */
+	/** @var AliasRegistry */
 	private $aliasRegistry;
-	/**
-	 * @var int
-	 */
+	/** @var int */
 	private $transactionLevel = 0;
+	/** @var QueryLoggers */
+	private $queryLoggers = 0;
 
 	/**
-	 * @param \PDO $pdo
+	 * @param PDO $pdo
 	 */
-	public function __construct(\PDO $pdo) {
+	public function __construct(PDO $pdo) {
 		$this->pdo = $pdo;
 		$this->aliasRegistry = new AliasRegistry();
+		$this->queryLoggers = new QueryLoggers();
+	}
+
+	/**
+	 * @return QueryLoggers
+	 */
+	public function getQueryLoggers() {
+		return $this->queryLoggers;
 	}
 
 	/**
@@ -46,27 +54,29 @@ public function getAliasRegistry() {
 	/**
 	 * @param string $query
 	 * @throws Exception
-	 * @return \PDOStatement
+	 * @return QueryStatement
 	 */
 	public function query($query) {
 		$stmt = $this->pdo->query($query);
 		if(!$stmt) {
 			throw new Exception("Could not execute statement:\n{$query}");
 		}
-		return $stmt;
+		$stmtWrapper = new QueryStatement($stmt, $query, $this->queryLoggers);
+		return $stmtWrapper;
 	}
 
 	/**
 	 * @param string $query
 	 * @throws Exception
-	 * @return \PDOStatement
+	 * @return QueryStatement
 	 */
 	public function prepare($query) {
 		$stmt = $this->pdo->prepare($query);
 		if(!$stmt) {
 			throw new Exception("Could not execute statement:\n{$query}");
 		}
-		return $stmt;
+		$stmtWrapper = new QueryStatement($stmt, $query, $this->queryLoggers);
+		return $stmtWrapper;
 	}
 
 	/**
@@ -76,7 +86,9 @@ public function prepare($query) {
 	 */
 	public function exec($query, array $params = array()) {
 		$stmt = $this->pdo->prepare($query);
+		$timer = microtime(true);
 		$stmt->execute($params);
+		$this->queryLoggers->log($query, microtime(true) - $timer);
 		$result = $stmt->rowCount();
 		$stmt->closeCursor();
 		return $result;

src/QueryLogger/ClosureQueryLogger.php

@@ -0,0 +1,23 @@
+<?php
+namespace Kir\MySQL\QueryLogger;
+
+class ClosureQueryLogger implements QueryLogger {
+	/** @var callable */
+	private $fn;
+
+	/**
+	 * @param callable $fn
+	 */
+	function __construct($fn) {
+		$this->fn = $fn;
+	}
+
+	/**
+	 * @param string $query
+	 * @param float $duration Duration in seconds
+	 * @return void
+	 */
+	public function log($query, $duration) {
+		call_user_func($this->fn, $query, $duration);
+	}
+}

src/QueryLogger/LoggerInterfaceQueryLogger.php

@@ -0,0 +1,25 @@
+<?php
+namespace Kir\MySQL\QueryLogger;
+
+use Psr\Log\LoggerInterface;
+
+class LoggerInterfaceQueryLogger implements QueryLogger {
+	/** @var LoggerInterface */
+	private $logger;
+
+	/**
+	 * @param LoggerInterface $logger
+	 */
+	function __construct(LoggerInterface $logger) {
+		$this->logger = $logger;
+	}
+
+	/**
+	 * @param string $query
+	 * @param float $duration Duration in seconds
+	 * @return void
+	 */
+	public function log($query, $duration) {
+		$this->logger->info(sprintf("Query %s took %0.4f seconds", $query, $duration), ['query' => $query, 'duration' => $duration]);
+	}
+}

src/QueryLogger/QueryLogger.php

@@ -0,0 +1,11 @@
+<?php
+namespace Kir\MySQL\QueryLogger;
+
+interface QueryLogger {
+	/**
+	 * @param string $query
+	 * @param float $duration Duration in seconds
+	 * @return void
+	 */
+	public function log($query, $duration);
+}

src/QueryLogger/QueryLoggers.php

@@ -0,0 +1,28 @@
+<?php
+namespace Kir\MySQL\QueryLogger;
+
+class QueryLoggers {
+	/**
+	 * @var QueryLogger[]
+	 */
+	private $queryLoggers = [];
+
+	/**
+	 * @param QueryLogger $queryLogger
+	 */
+	public function add(QueryLogger $queryLogger) {
+		$this->queryLoggers[] = $queryLogger;
+	}
+
+	/**
+	 * @param string $query
+	 * @param float $duration
+	 * @return $this
+	 */
+	public function log($query, $duration) {
+		foreach($this->queryLoggers as $queryLogger) {
+			$queryLogger->log($query, $duration);
+		}
+		return $this;
+	}
+}

tests/Builder/InterceptionTest.php

@@ -0,0 +1,20 @@
+<?php
+namespace Kir\MySQL\Builder;
+
+use Kir\MySQL\Databases\TestDB;
+use Kir\MySQL\QueryLogger\ClosureQueryLogger;
+
+class InterceptionTest extends \PHPUnit_Framework_TestCase {
+	public function testQuery() {
+		$db = new TestDB();
+		$db->exec('USE mysql');
+		$queries = [];
+		$db->getQueryLoggers()->add(new ClosureQueryLogger(function ($query, $duration) use (&$queries) {
+			$queries[$query] = 1000;
+		}));
+		$stmt = $db->query('SHOW TABLES');
+		$stmt->execute();
+		$this->assertArrayHasKey('SHOW TABLES', $queries);
+		$this->assertEquals(1000, $queries['SHOW TABLES']);
+	}
+}