summaryrefslogtreecommitdiffstats
path: root/class/CommonTable.php
blob: 365ef192c21894d4ed674abb7a95d53b6c17d04b (plain)
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
<?php
/**
 * Class for Database Table management
 *
 * PHP version 5
 *
 * Copyright © 2010 Remi Collet
 *
 * This file is part of rpmphp.
 *
 * rpmphp is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * rpmphp is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with rpmphp.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Main
 * @package   RPMPHP
 *
 * @author    Remi Collet <unknown@unknwown.com>
 * @author    Johan Cwiklinski <johan@x-tnd.be>
 * @copyright 2010 Remi Collet
 * @license   http://www.gnu.org/licenses/agpl-3.0-standalone.html AGPL License 3.0 or (at your option) any later version
 * @link      http://github.com/remicollet/rpmphp/
 * @since     The begining of times.
 */

abstract class CommonTable
{
    protected $db;
    protected $table;

    /**
     * Instanciate a CommonTable
     *
     * @param object $db    PDO instance of the DB connection
     * @param string $table with table name
     */
    function __construct(PDO $db, $table='')
    {
        if (empty($table)) {
            $table = substr(strtolower(get_class($this)),5);
        }
        $this->db = $db;
        $this->table = $table;

        if (!$this->existsTable($table)) {
            $this->createTable($table);
        }
    }

    /**
     * Check if the table already exists
     *
     * @param string $table with table name
     *
     * @return boolean
     */
    public function existsTable($table)
    {
        $req = new TableIterator($this->db, "SHOW TABLES LIKE '$table'");
        foreach ($req as $data) {
            return true;
        }
        return false;
    }

    /**
     * Execute an SQL statement (INSERT, DELETE, ...)
     *
     * @param string $sql The SQL clause
    *
     * @return integer number of affected rows
     */
    protected function exec($sql)
    {
        $res = $this->db->exec($sql);
        if ($res===false) {
            $err = $this->db->errorInfo();
            throw new Exception(
                "\nSQL: $sql\nERROR: " . $err[2] . "\nCODE:" . $err[0]
            );
        }
        return $res;
    }

    /**
     * Add a new row in the table
     *
     * @param hashtable $fields hashtable of fieldname => value
     *
     * @return integer primary key of inserted row
     */
    public function add(array $fields)
    {
        $col = array();
        $val = array();
        foreach ($fields as $name => $value) {
            $col[] = "`$name`";
            if (is_null($value)) {
                $val[] = 'NULL';
            } else if (is_numeric($value)) {
                $val[] = $value;
            } else {
                $val[] = "'".addslashes($value)."'";
            }
        }
        $sql = "INSERT INTO `".$this->table."` (".implode(',', $col).")
                VALUE (".implode(',', $val).")";
        $this->exec($sql);

        $id = $this->db->lastInsertId();

        return $id;
    }

    /**
     * Find a row from the table (the first matching criteria)
     *
     * @param hastable $crit array of field name => value
     *
     * @return hashtable (the first row)
     */
    function find(array $crit)
    {
        if (count($crit)) {
            foreach ($this->request($crit) as $row) {
                return $row;
            }
        }
        return false;
    }

    /**
     * Read a row from the table
     *
     * @param integer $id of the row
     *
     * @return hashtable
     */
    function get($id)
    {
        if (intval($id)>0) {
            return $this->find(array('id'=>$id));
        }
        return false;
    }

    /**
     * Delete a row in the table
     *
     * @param hashtable $crit of key => value
     *
     * @return integer : number of row deleted
     */
    public function delete(array $crit)
    {
        $sql = "DELETE FROM `".$this->table."` ";

        $link="WHERE";
        foreach ($crit as $key => $value) {
            $sql .= " $link `$key`";

            if (is_null($value)) {
                $sql .= 'IS NULL';
            } else if (is_numeric($value)) {
                $sql .= '='.$value;
            } else {
                $sql .= "='".addslashes($value)."'";
            }

            $link = "AND";
        }
        $nb = $this->exec($sql);

        return $nb;
    }

    /**
     * Update a row in the table
     *
     * @param integer   $id     of the record
     * @param hashtable $fields of key => value
     *
     * @return integer : number of row deleted
     */
    public function update($id, array $fields)
    {
        $sql = "UPDATE `".$this->table."` ";

        $link = 'SET';
        foreach ($fields as $key => $value) {
            if ($key=='id') {
                // Don't update id
                continue;
            }

            $sql .= "$link `$key`=";
            if (is_null($value)) {
                $sql .= 'NULL';
            } else if (is_numeric($value)) {
                $sql .= $value;
            } else {
                $sql .= "'".addslashes($value)."'";
            }
            $link = ',';
        }
        $sql .= " WHERE `id`=".intval($id);

        $nb = $this->exec($sql);

        return $nb;
    }

    /**
     * Create the table
     *
     * @return void
     */
    abstract protected function createTable();

    /**
     * Instanciate a Simple TableIterator on the current table
     *
     * Examples =
     *  foreach ($DB->request() as $ID => $data) { ... }
     *  foreach ($DB->request("ID=1") as $ID => $data) { ... }
     *  foreach ($DB->request("", "name") as $ID => $data) { ... }
     *  foreach ($DB->request(array(
     *              "name"=>"SBEI003W",
     *              "entities_id"=>1),
     *              array("serial","otherserial")) { ... }
     *
     * @param string|array $crit string or array of field/values,
     *                           ex array("id"=>1), if empty => all rows
     *
     * Examples =
     *  array("id"=>NULL)
     *  array("OR"=>array("id"=>1, "NOT"=>array("state"=>3)));
     *  array(
     *      "AND"=>array(
     *          "id"=>1,array(
     *              "NOT"=>array(
     *                  "state"=>array(3,4,5),
     *                  "toto"=>2
     *              )
     *          )
     *      )
     *  )
     *
     * param 'FIELDS' name or array of field names
     * param 'ORDER' filed name or array of field names
     * param 'LIMIT' max of row to retrieve
     * param 'START' first row to retrieve
     *
     * @return DBIterator
     **/
    public function request ($crit='')
    {
        if (is_string($crit) && strpos($crit,' ')) {
            // $crit is a full SQL command
            return new TableIterator ($this->db, $crit);
        }
        return new TableIterator ($this->db, $this->table, $crit);
    }

    /**
     * Retrieve 2 columns of all the table's row in a hashtable
     *
     * @param string $fieldkey   name of the field to use as index
     * @param string $fieldvalue name of the field to use as value
     * @param array  $crit       for request
     *
     * @return hashtable
     */
    public function getHashtable($fieldkey, $fieldvalue, array $crit=array())
    {
        $crit['FIELDS'] = array($fieldkey, $fieldvalue);
        $crit['ORDER']  = $fieldkey;

        $tab = array();
        foreach ($this->request($crit) as $data) {
            $tab[$data[$fieldkey]] = $data[$fieldvalue];
        }
        return $tab;
    }

    /**
     * Retrieve a big array with all date from the table
     *
     * @param array|string $crit for the request
     * @param string       $key  name of the key for the return array
     *
     * @return array, index is rowid, value is a hastable
     */
    public function getArray($crit='', $key='id')
    {
        $tab = array();
        foreach ($this->request($crit) as $id => $data) {
            $tab[$data[$key]] = $data;
        }
        return $tab;
    }

    /**
     * Truncate the table
     */
    public function truncate()
    {
        return $this->exec('TRUNCATE `'.$this->table.'`');
    }

    /**
     * Optimize the table
     */
    public function optimize()
    {
        $res = array();
        foreach ($this->request('OPTIMIZE TABLE `'.$this->table.'`') as $row) {
            $res[] = $row;
        }
        return $res;
    }


    /**
     * Get the number of rows in the table
     */
    public function getCount()
    {
        $sql = 'SELECT COUNT(*) AS cpt FROM `'.$this->table.'`';
        foreach ($this->request($sql) as $row) {
            return ($row['cpt']);
        }
        return 0;
    }
}

?>