aboutsummaryrefslogtreecommitdiff
path: root/includes/vendor/aura/sql/src/ProfilerInterface.php
blob: f3ae0d8ff224f0c3098871e9225bc1e56df151a6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<?php
/**
 *
 * This file is part of Aura for PHP.
 *
 * @license http://opensource.org/licenses/bsd-license.php BSD
 *
 */
namespace Aura\Sql;

/**
 *
 * Interface for query profilers.
 *
 * @package Aura.Sql
 *
 */
interface ProfilerInterface
{
    /**
     *
     * Turns the profiler on and off.
     *
     * @param bool $active True to turn on, false to turn off.
     *
     * @return null
     *
     */
    public function setActive($active);

    /**
     *
     * Is the profiler active?
     *
     * @return bool
     *
     */
    public function isActive();

    /**
     *
     * Adds a profile entry.
     *
     * @param float $duration The query duration.
     *
     * @param string $function The PDO method that made the entry.
     *
     * @param string $statement The SQL query statement.
     *
     * @param array $bind_values The values bound to the statement.
     *
     * @return null
     *
     */
    public function addProfile(
        $duration,
        $function,
        $statement,
        array $bind_values
    );

    /**
     *
     * Returns all the profiles.
     *
     * @return array
     *
     */
    public function getProfiles();


    /**
     *
     * Reset all the profiles
     *
     * @return null
     *
     */
    public function resetProfiles();
}