dbal/BuilderInterface.php at master · mreschke/dbal · 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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<?php namespace Mreschke\Dbal;

/**
 * Provides a contractual interface for query builder implementations
 * @copyright 2014 Matthew Reschke
 * @license http://mreschke.com/license/mit
 * @author Matthew Reschke <mail@mreschke.com>
 */
interface BuilderInterface
{

    /**
     * Configure the dbal query builder
     * @return void
     */
    public function configureBuilder();

    /**
     * Return the dbal database instance
     * @return DbalInterface
     */
    public function dbInstance();

    /**
     * Build and return the query
     * @return string
     */
    public function queryBuilder();

    /**
     * Alias to queryBuilder
     * @return string
     */
    public function toSql();

    /**
     * Set a new select statement
     * @param  string $sql select statement
     * @return self chainable
     */
    public function select($columns = array('*'));

    /**
     * Add a new column to the select query
     * @param string $column
     */
    public function addSelect($column);

    /**
     * Set a new from statement
     * @param  string $sql from statement
     * @return self chainable
     */
    public function from($sql);

    /**
     * Alias to from
     * @param  string $sql from statement
     * @return self chainable
     */
    public function table($sql);

    /**
     * Set a new primary key
     * @param  mixed $sql from statement
     * @return self chainable
     */
    public function key($sql);

    /**
     * Add a where clause to the query
     * @param  string  $column
     * @param  string  $operator
     * @param  mixed   $value
     * @return self chainable
     */
    public function where($column, $operator = null, $value = null, $boolean = 'and');

    /**
     * Add an or where clause to the query
     * @param  string  $column
     * @param  string  $operator
     * @param  mixed   $value
     * @return selc chainable
     */
    public function orWhere($column, $operator = null, $value = null);

    /**
     * Add a new group by statement
     * @param  string $sql group by statement
     * @return self chainable
     */
    public function groupBy($sql);

    /**
     * Set a new having statement
     * @param  string $sql having statement
     * @return self chainable
     */
    public function having($sql);

    /**
     * Set a new order by statement
     * @param  string $sql order bystatement
     * @return self chainable
     */
    public function orderBy($sql);

    /**
     * Alias to execute
     * @return dbal resource
     */
    public function query();

    /**
     * Execute query builder
     * @param  string $query option if not set use query builder
     * @return dbal resource
     */
    public function execute($query = null);

    /**
     * Alias to execute
     * @return dbal resource
     */
    public function all();

    /**
     * Return one row by one or more primary keys
     * @param  mixed $id
     * @return dbal resource
     */
    public function find($id);

    /**
     * Return one row as array by one or more primary keys
     * @param  mixed $id
     * @return dbal resource
     */
    public function findArray($id);

    /**
     * Insert new record.
     * @param  object $record
     * @return mixed new primary key inserted
     */
    public function insert($record);

    /**
     * Update one record by one or more primary keys
     * @param  object $record
     * @return void
     */
    public function update($record);

    /**
     * Delete one record by one or more primary keys
     * @param  mixed $id
     * @return void
     */
    public function delete($id);
}