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
// Class file for the database access. Extend PHP's native PDO and
// PDOStatement classes to provide database access with logging, etc.
//
// webtrees: Web based Family History software
// Copyright (C) 2011 webtrees development team.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
// @author Greg Roach
// @version $Id$
if (!defined('WT_WEBTREES')) {
header('HTTP/1.0 403 Forbidden');
exit;
}
class WT_DBStatement {
//////////////////////////////////////////////////////////////////////////////
// CONSTRUCTION
// Decorate a PDOStatement object.
// See http://en.wikipedia.org/wiki/Decorator_pattern
//////////////////////////////////////////////////////////////////////////////
private $pdostatement=null;
// Keep track of calls to execute(), so we can do it automatically
private $executed=false;
// Keep a copy of the bind variables, for logging
private $bind_variables=array();
// Our constructor just takes a copy of the object to be decorated
public function __construct(PDOStatement $statement) {
$this->pdostatement=$statement;
}
// Need this function to load BLOB values from streams
public function bindParam($num, &$value, $type) {
$this->pdostatement->bindParam($num, $value, $type);
return $this;
}
//////////////////////////////////////////////////////////////////////////////
// FLUENT INTERFACE
// Add automatic calling of execute() and closeCursor()
// See http://en.wikipedia.org/wiki/Fluent_interface
//////////////////////////////////////////////////////////////////////////////
public function __call($function, $params) {
switch ($function) {
case 'closeCursor':
$this->executed=false;
// no break;
case 'bindColumn':
case 'bindParam':
case 'bindValue':
// TODO: bind variables need to be stored in $this->bind_variables so we can log them
case 'setAttribute':
case 'setFetchMode':
// Functions that return no values become fluent
call_user_func_array(array($this->pdostatement, $function), $params);
return $this;
case 'execute':
if ($this->executed) {
trigger_error('WT_DBStatement::execute() called twice.', E_USER_ERROR);
} else {
if ($params) {
$this->bind_variables=$params[0];
foreach ($params[0] as &$param) {
if ($param===false) {
// For consistency, otherwise true=>'1' and false=>''
$param=0;
}
}
}
$start=microtime(true);
$result=call_user_func_array(array($this->pdostatement, $function), $params);
$end=microtime(true);
$this->executed=!preg_match('/^(insert|delete|update|create|alter) /i', $this->pdostatement->queryString);
WT_DB::logQuery($this->pdostatement->queryString, $this->pdostatement->rowCount(), $end-$start, $this->bind_variables);
return $this;
}
case 'fetch':
case 'fetchColumn':
case 'fetchObject':
case 'fetchAll':
// Automatically execute the query
if (!$this->executed) {
$this->execute();
$this->executed=true;
}
// no break;
default:
return call_user_func_array(array($this->pdostatement, $function), $params);
}
}
//////////////////////////////////////////////////////////////////////////////
// FUNCTIONALITY ENHANCEMENTS
//////////////////////////////////////////////////////////////////////////////
// Fetch one row, and close the cursor. e.g. SELECT * FROM foo WHERE pk=bar
public function fetchOneRow($fetch_style=PDO::FETCH_OBJ) {
if (!$this->executed) {
$this->execute();
}
$row=$this->pdostatement->fetch($fetch_style);
$this->pdostatement->closeCursor();
$this->executed=false;
return $row ? $row : null;
}
// Fetch one value and close the cursor. e.g. SELECT MAX(foo) FROM bar
public function fetchOne() {
if (!$this->executed) {
$this->execute();
}
$value=$this->pdostatement->fetchColumn();
$this->pdostatement->closeCursor();
$this->executed=false;
return $value===false ? null : $value;
}
// Fetch two columns, and return an associative array of col1=>col2
public function fetchAssoc() {
if (!$this->executed) {
$this->execute();
}
$rows=array();
while ($row=$this->pdostatement->fetch(PDO::FETCH_NUM)) {
$rows[$row[0]]=$row[1];
}
$this->pdostatement->closeCursor();
$this->executed=false;
return $rows;
}
// Fetch all the first column, as an array
public function fetchOneColumn() {
if (!$this->executed) {
$this->execute();
}
$list=array();
while ($row=$this->pdostatement->fetch(PDO::FETCH_NUM)) {
$list[]=$row[0];
}
$this->pdostatement->closeCursor();
$this->executed=false;
return $list;
}
}
|
