Query/DatabaseInterface.php at master · CommonApi/Query · GitHub

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
<?php
/**
 * Database Interface
 *
 * @package    Query
 * @copyright  2014 Amy Stephen. All rights reserved.
 * @license    http://www.opensource.org/licenses/mit-license.html MIT License
 */
namespace CommonApi\Query;

/**
 * Database Interface
 *
 * @package    Query
 * @license    http://www.opensource.org/licenses/mit-license.html MIT License
 * @copyright  2014 Amy Stephen. All rights reserved.
 * @since      1.0
 */
interface DatabaseInterface
{
    /**
     * Query the database and return a single value as the result
     *
     * @param   string $sql
     *
     * @return  object
     * @since   1.0.0
     */
    public function loadResult($sql);

    /**
     * Query the database and return an array of object values returned from query
     *
     * @param   string $sql
     *
     * @return  array
     * @since   1.0.0
     */
    public function loadObjectList($sql);

    /**
     * Execute the Database Query
     *
     * @param   string $sql
     *
     * @return  object
     * @since   1.0.0
     */
    public function execute($sql);

    /**
     * Returns the primary key following insert
     *
     * @return  integer
     * @since   1.0.0
     */
    public function getInsertId();
}