SQLLogger.php 864 Bytes
Newer Older
1 2 3 4 5 6
<?php

namespace Doctrine\DBAL\Logging;

/**
 * Interface for SQL loggers.
7
 *
Benjamin Morel's avatar
Benjamin Morel committed
8 9 10 11 12 13
 * @link   www.doctrine-project.org
 * @since  2.0
 * @author Benjamin Eberlei <kontakt@beberlei.de>
 * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
 * @author Jonathan Wage <jonwage@gmail.com>
 * @author Roman Borschel <roman@code-factory.org>
14 15 16 17 18 19
 */
interface SQLLogger
{
    /**
     * Logs a SQL statement somewhere.
     *
Benjamin Morel's avatar
Benjamin Morel committed
20 21 22 23
     * @param string     $sql    The SQL to be executed.
     * @param array|null $params The SQL parameters.
     * @param array|null $types  The SQL parameter types.
     *
24
     * @return void
25
     */
26 27 28
    public function startQuery($sql, array $params = null, array $types = null);

    /**
Benjamin Morel's avatar
Benjamin Morel committed
29
     * Marks the last started query as stopped. This can be used for timing of queries.
30 31 32 33
     *
     * @return void
     */
    public function stopQuery();
Benjamin Eberlei's avatar
Benjamin Eberlei committed
34
}