cleanup text-match
[awl.git] / docs / api / awl / DataUpdate / _DataUpdate.php.html
bloba79ccf33eb10a98cbe206d5951355657355fb1b5
2 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
3 <?xml version="1.0" encoding="iso-8859-1"?>
4 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7 <!-- template designed by Marco Von Ballmoos -->
8 <title>Docs for page DataUpdate.php</title>
9 <link rel="stylesheet" href="../../media/stylesheet.css" />
10 <script src="../../media/lib/classTree.js"></script>
11 <script language="javascript" type="text/javascript">
12 var imgPlus = new Image();
13 var imgMinus = new Image();
14 imgPlus.src = "../../media/images/plus.png";
15 imgMinus.src = "../../media/images/minus.png";
17 function showNode(Node){
18 switch(navigator.family){
19 case 'nn4':
20 // Nav 4.x code fork...
21 var oTable = document.layers["span" + Node];
22 var oImg = document.layers["img" + Node];
23 break;
24 case 'ie4':
25 // IE 4/5 code fork...
26 var oTable = document.all["span" + Node];
27 var oImg = document.all["img" + Node];
28 break;
29 case 'gecko':
30 // Standards Compliant code fork...
31 var oTable = document.getElementById("span" + Node);
32 var oImg = document.getElementById("img" + Node);
33 break;
35 oImg.src = imgMinus.src;
36 oTable.style.display = "block";
39 function hideNode(Node){
40 switch(navigator.family){
41 case 'nn4':
42 // Nav 4.x code fork...
43 var oTable = document.layers["span" + Node];
44 var oImg = document.layers["img" + Node];
45 break;
46 case 'ie4':
47 // IE 4/5 code fork...
48 var oTable = document.all["span" + Node];
49 var oImg = document.all["img" + Node];
50 break;
51 case 'gecko':
52 // Standards Compliant code fork...
53 var oTable = document.getElementById("span" + Node);
54 var oImg = document.getElementById("img" + Node);
55 break;
57 oImg.src = imgPlus.src;
58 oTable.style.display = "none";
61 function nodeIsVisible(Node){
62 switch(navigator.family){
63 case 'nn4':
64 // Nav 4.x code fork...
65 var oTable = document.layers["span" + Node];
66 break;
67 case 'ie4':
68 // IE 4/5 code fork...
69 var oTable = document.all["span" + Node];
70 break;
71 case 'gecko':
72 // Standards Compliant code fork...
73 var oTable = document.getElementById("span" + Node);
74 break;
76 return (oTable && oTable.style.display == "block");
79 function toggleNodeVisibility(Node){
80 if (nodeIsVisible(Node)){
81 hideNode(Node);
82 }else{
83 showNode(Node);
86 </script>
87 </head>
88 <body>
89 <div class="page-body">
90 <h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/DataUpdate.php</h2>
92 <a name="sec-description"></a>
93 <div class="info-box">
94 <div class="info-box-title">Description</div>
95 <div class="nav-bar">
96 <span class="disabled">Description</span> |
97 <a href="#sec-classes">Classes</a>
98 | <a href="#sec-includes">Includes</a>
99 | <a href="#sec-functions">Functions</a>
100 </div>
101 <div class="info-box-body">
102 <!-- ========== Info from phpDoc block ========= -->
103 <p class="short-description">Some functions and a base class to help with updating records.</p>
104 <p class="description"><p>This subpackage provides some functions that are useful around single record database activities such as insert and update.</p></p>
105 <ul class="tags">
106 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
107 <li><span class="field">copyright:</span> Catalyst IT Ltd, Morphoss Ltd &lt;http://www.morphoss.com/&gt;</li>
108 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
109 </ul>
111 </div>
112 </div>
114 <a name="sec-classes"></a>
115 <div class="info-box">
116 <div class="info-box-title">Classes</div>
117 <div class="nav-bar">
118 <a href="#sec-description">Description</a> |
119 <span class="disabled">Classes</span>
120 | <a href="#sec-includes">Includes</a>
121 | <a href="#sec-functions">Functions</a>
122 </div>
123 <div class="info-box-body">
124 <table cellpadding="2" cellspacing="0" class="class-table">
125 <tr>
126 <th class="class-table-header">Class</th>
127 <th class="class-table-header">Description</th>
128 </tr>
129 <tr>
130 <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
131 <img src="../../media/images/Class.png"
132 alt=" class"
133 title=" class"/>
134 <a href="../../awl/DataUpdate/DBRecord.html">DBRecord</a>
135 </td>
136 <td>
137 A Base class to use for records which will be read/written from the database.
138 </td>
139 </tr>
140 </table>
141 </div>
142 </div>
144 <a name="sec-includes"></a>
145 <div class="info-box">
146 <div class="info-box-title">Includes</div>
147 <div class="nav-bar">
148 <a href="#sec-description">Description</a> |
149 <a href="#sec-classes">Classes</a>
150 | <span class="disabled">Includes</span>
151 | <a href="#sec-functions">Functions</a>
152 </div>
153 <div class="info-box-body">
155 Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
157 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
158 <a name="_AwlQuery_php"><!-- --></a>
159 <div class="oddrow">
161 <div>
162 <img src="../../media/images/Page.png" alt=" " />
163 <span class="include-title">
164 <span class="include-type">require_once</span>
165 (<span class="include-name"><a href="../../awl/AwlDatabase/_AwlQuery.php.html">'AwlQuery.php'</a></span>)
166 (line <span class="line-number">16</span>)
167 </span>
168 </div>
170 <!-- ========== Info from phpDoc block ========= -->
172 </div>
173 <a name="_AWLUtilities_php"><!-- --></a>
174 <div class="evenrow">
176 <div>
177 <img src="../../media/images/Page.png" alt=" " />
178 <span class="include-title">
179 <span class="include-type">require_once</span>
180 (<span class="include-name"><a href="../../awl/Utilities/_AWLUtilities.php.html">'AWLUtilities.php'</a></span>)
181 (line <span class="line-number">15</span>)
182 </span>
183 </div>
185 <!-- ========== Info from phpDoc block ========= -->
187 </div>
188 </div>
189 </div>
193 <a name="sec-functions"></a>
194 <div class="info-box">
195 <div class="info-box-title">Functions</div>
196 <div class="nav-bar">
197 <a href="#sec-description">Description</a> |
198 <a href="#sec-classes">Classes</a>
199 | <a href="#sec-includes">Includes</a>
200 | <span class="disabled">Functions</span>
201 </div>
202 <div class="info-box-body">
204 Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
206 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
207 <a name="functionsql_from_object" id="functionsql_from_object"><!-- --></a>
208 <div class="oddrow">
210 <div>
211 <img src="../../media/images/Function.png" />
212 <span class="method-title">sql_from_object</span> (line <span class="line-number">28</span>)
213 </div>
215 <!-- ========== Info from phpDoc block ========= -->
216 <p class="short-description">Build SQL INSERT/UPDATE statement from an associative array of fieldnames =&gt; values.</p>
217 <ul class="tags">
218 <li><span class="field">return:</span> An SQL Update or Insert statement with all fields/values from the array.</li>
219 </ul>
220 <div class="method-signature">
221 <span class="method-result">string</span>
222 <span class="method-name">
223 sql_from_object
224 </span>
225 (<span class="var-type">array</span>&nbsp;<span class="var-name">$obj</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$tablename</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$where</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$fprefix</span> = <span class="var-default">&amp;quot;&amp;quot;</span>])
226 </div>
228 <ul class="parameters">
229 <li>
230 <span class="var-type">array</span>
231 <span class="var-name">$obj</span><span class="var-description">: The object of fieldnames =&gt; values.</span> </li>
232 <li>
233 <span class="var-type">string</span>
234 <span class="var-name">$type</span><span class="var-description">: The word &quot;update&quot; or something else (which implies &quot;insert&quot;).</span> </li>
235 <li>
236 <span class="var-type">string</span>
237 <span class="var-name">$tablename</span><span class="var-description">: The name of the table being updated.</span> </li>
238 <li>
239 <span class="var-type">string</span>
240 <span class="var-name">$where</span><span class="var-description">: What the &quot;WHERE ...&quot; clause needs to be for an UPDATE statement.</span> </li>
241 <li>
242 <span class="var-type">string</span>
243 <span class="var-name">$fprefix</span><span class="var-description">: An optional string which all fieldnames in $assoc are prefixed with.</span> </li>
244 </ul>
247 </div>
248 <a name="functionsql_from_post" id="functionsql_from_post"><!-- --></a>
249 <div class="evenrow">
251 <div>
252 <img src="../../media/images/Function.png" />
253 <span class="method-title">sql_from_post</span> (line <span class="line-number">112</span>)
254 </div>
256 <!-- ========== Info from phpDoc block ========= -->
257 <p class="short-description">Build SQL INSERT/UPDATE statement from the $_POST associative array</p>
258 <ul class="tags">
259 <li><span class="field">return:</span> An SQL Update or Insert statement with all fields/values from the array.</li>
260 </ul>
261 <div class="method-signature">
262 <span class="method-result">string</span>
263 <span class="method-name">
264 sql_from_post
265 </span>
266 (<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$tablename</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$where</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$fprefix</span> = <span class="var-default">&amp;quot;&amp;quot;</span>])
267 </div>
269 <ul class="parameters">
270 <li>
271 <span class="var-type">string</span>
272 <span class="var-name">$type</span><span class="var-description">: The word &quot;update&quot; or something else (which implies &quot;insert&quot;).</span> </li>
273 <li>
274 <span class="var-type">string</span>
275 <span class="var-name">$tablename</span><span class="var-description">: The name of the table being updated.</span> </li>
276 <li>
277 <span class="var-type">string</span>
278 <span class="var-name">$where</span><span class="var-description">: What the &quot;WHERE ...&quot; clause needs to be for an UPDATE statement.</span> </li>
279 <li>
280 <span class="var-type">string</span>
281 <span class="var-name">$fprefix</span><span class="var-description">: An optional string which all fieldnames in $assoc are prefixed with.</span> </li>
282 </ul>
285 </div>
286 </div>
287 </div>
289 <p class="notes" id="credit">
290 Documentation generated on Wed, 04 Jul 2012 07:06:13 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
291 </p>
292 </div></body>
293 </html>