summaryrefslogtreecommitdiffstats
path: root/class/TableIterator.php
blob: 9f5889bdaffff3efa9ae597b6db8138db99c1757 (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
<?php
/**
 * Class which implement a simple Iterator over a PDO connexion
 *
 * 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.
*/

/**
 * Helper for simple query => use directly or through  CommonTable::request()
 *
 * Freely inspired from DBmysqlIterator class from GLPI
 * (already written by Remi, and ported to PDO)
 * See http://www.glpi-project.org/
 */
class TableIterator  implements Iterator
{
    private $con;
    private $sql;
    private $res = false;
    private $row;
    private $pos;

    /**
     * Constructor
     *
     * @param CommonDBTM   $dbconnexion Database Connnexion
     *                                  (must be a CommonDBTM object)
     * @param string       $table       table name
     * @param string|array $crit        string or array of filed/values,
     *                                  ex array("id"=>1), if empty => all rows
     */
    function __construct (PDO $dbconnexion, $table, $crit='')
    {

        $this->conn = $dbconnexion;
        if (is_string($table) && strpos($table, " ")) {
            $this->sql = $table;
        } else {
            // check field, orderby, limit, start in criterias
            $field="";
            $orderby="";
            $limit=0;
            $start=0;

            if (is_array($crit) && count($crit)) {
                foreach ($crit as $key => $val) {
                    if ($key==="FIELDS") {
                        $field = $val;
                        unset($crit[$key]);
                    } else if ($key==="ORDER") {
                        $orderby = $val;
                        unset($crit[$key]);
                    } else if ($key==="LIMIT") {
                        $limit = $val;
                        unset($crit[$key]);
                    } else if ($key==="START") {
                            $start = $val;
                            unset($crit[$key]);
                    }
                }
            }

            // SELECT field list
            if (is_array($field)) {
                $this->sql = "";
                foreach ($field as $t => $f) {
                    if (is_numeric($t)) {
                        $this->sql .= (empty($this->sql)
                            ? "SELECT " : ",") . $f;
                    } else if (is_array($f)) {
                        $this->sql .= (empty($this->sql)
                            ? "SELECT $t." : ",$t.") . implode(",$t.", $f);
                    } else {
                        $this->sql .= (empty($this->sql)
                            ? "SELECT " : ",") . "$t.$f";
                    }
                }
            } else if (empty($field)) {
                $this->sql = "SELECT *";
            } else {
                $this->sql = "SELECT `$field`";
            }
            // FROM table list
            if (is_array($table)) {
                $this->sql .= " FROM `".implode("`, `", $table)."`";
            } else {
                $this->sql .= " FROM `$table`";
            }
            // WHERE criteria list
            if (!empty($crit)) {
                print_r($crit);
                $this->sql .= " WHERE ".$this->_analyseCrit($crit);
            }
            // ORDER BY
            if (is_array($orderby)) {
                $this->sql .= " ORDER BY `".implode("`, `", $orderby)."`";
            } else if (!empty($orderby)) {
                $this->sql .= " ORDER BY `$orderby`";
            }
            if (is_numeric($limit) && $limit>0) {
                $this->sql .= " LIMIT $limit";
                if (is_numeric($start) && $start>0) {
                    $this->sql .= " OFFSET $start";
                }
            }
        }
        //echo "SQL: ".$this->sql."\n";
        $this->res = $this->conn->prepare($this->sql);
        if ($this->res===false) {
            $err = $this->db->errorInfo();
            throw new Exception($err[2]);
        }

        $this->pos = -1;
    }

    /**
     * Class destructor
     */
    function __destruct ()
    {
        if ($this->res) {
            $this->res->closeCursor();
        }
    }

    /**
     * Build WHERE clause
     *
     * @param TODO $crit To document
     * @param TODO $bool To document
     *
     * @return To document
     */
    private function _analyseCrit ($crit, $bool="AND")
    {

        if (!is_array($crit)) {
            return $crit;
        }
        $ret = "";
        foreach ($crit as $name => $value) {
            if (!empty($ret)) {
                $ret .= " $bool ";
            }
            if (is_numeric($name)) {
                // No Key case => recurse.
                $ret .= "(" . $this->_analyseCrit($value, $bool) . ")";
            } else if ($name==="OR" || $name==="AND") {
                // Binary logical operator
                $ret .= "(" . $this->_analyseCrit($value, $name) . ")";
            } else if ($name==="NOT") {
                // Uninary logicial operator
                $ret .= " NOT (" . $this->_analyseCrit($value, "AND") . ")";
            } else if ($name==="FKEY") {
                // Foreign Key condition
                if (is_array($value) && count($value)==2) {
                    reset($value);
                    list($t1,$f1)=each($value);
                    list($t2,$f2)=each($value);
                    $ret .= (is_numeric($t1) ? "$f1" : "$t1.$f1") . "=" .
                            (is_numeric($t2) ? "$f2" : "$t2.$f2");
                } else {
                    trigger_error("BAD FOREIGN KEY", E_USER_ERROR);
                }
            } else if (is_array($value)) {
                // Array of Value
                $ret .= "$name IN ('". implode("','", $value)."')";
            } else if (is_null($value)) {
                // NULL condition
                $ret .= "$name IS NULL";
            } else if (is_numeric($value)) {
                // Integer
                $ret .= "$name=$value";
            } else {
                // String
                $ret .= "$name='$value'";
            }
        }
        return $ret;
    }

    /**
    * To document
     *
     * @return To document
    */
    public function rewind ()
    {

        if ($this->res && $this->pos>=0) {
            $this->res->closeCursor();
            $this->pos = -1;
        }

        if ($this->res && $this->pos<0) {
            if (!$this->res->execute()) {
                $err = $this->res->errorInfo();
                throw new Exception($err[2]);
            }
        }
        return $this->next();
    }

    /**
     * To document
     *
     * @return To document
     */
    public function current()
    {
        return $this->row;
    }

    /**
     * To document
     *
     * @return To document
     */
    public function key()
    {
        return (isset($this->row["id"]) ? $this->row["id"] : $this->pos);
    }

    /**
     * To document
     *
     * @return To document
     */
    public function next()
    {
        if (!$this->res) {
            return false;
        }
        $this->row = $this->res->fetch(PDO::FETCH_ASSOC);
        $this->pos++;
        return $this->row;
    }

    /**
     * To document
     *
     * @return To document
     */
    public function valid()
    {
        return $this->res && $this->row;
    }

    /**
     * To document
     *
     * @return To document
     */
    public function numrows()
    {
        return ($this->res ? $this->res->rowCount() : 0);
    }
}
?>