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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs for page util.php</title>
<link rel="stylesheet" href="../../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="file-name">/php/lib/util.php</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-functions">Functions</a>
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Utility funcs.</p>
</div>
</div>
<a name="sec-functions"></a>
<div class="info-box">
<div class="info-box-title">Functions</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Functions</span>
</div>
<div class="info-box-body">
<a name="functionarray_order_by" id="functionarray_order_by"><!-- --></a>
<div class="evenrow">
<div>
<span class="method-title">array_order_by</span> (line <span class="line-number">198</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sort a two dimensional array based on a 'column' key</p>
<ul class="tags">
<li><span class="field">return:</span> the original array on argument errors, the sorted array on success</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
array_order_by
</span>
(<span class="var-type">array</span> <span class="var-name">&$array</span>, [<span class="var-type">mixed</span> <span class="var-name">$key</span> = <span class="var-default">null</span>], [<span class="var-type">mixed</span> <span class="var-name">$order</span> = <span class="var-default">null</span>], [<span class="var-type">bool</span> <span class="var-name">$retain_keys</span> = <span class="var-default">TRUE</span>], [<span class="var-type">bool</span> <span class="var-name">$case_sensitive</span> = <span class="var-default">FALSE</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$array</span><span class="var-description">: the array to be sorted</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$key</span><span class="var-description">: the column key to be used for sorting, an array of keys are also acceptable</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$order</span><span class="var-description">: the order of the sort, either 'asc' (ascending) or 'desc' (descending), can also be an array (with matching array keys to the $key param)</span> </li>
<li>
<span class="var-type">bool</span>
<span class="var-name">$retain_keys</span><span class="var-description">: option to retain the original keys; default to true</span> </li>
<li>
<span class="var-type">bool</span>
<span class="var-name">$case_sensitive</span><span class="var-description">: option for a case sensitive sort; default to false</span> </li>
</ul>
</div>
<a name="functiondebug_r" id="functiondebug_r"><!-- --></a>
<div class="oddrow">
<div>
<span class="method-title">debug_r</span> (line <span class="line-number">98</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Print out an varible enclosed by &lt;pre&gt; tags</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
debug_r
</span>
(<span class="var-type">mixed</span> <span class="var-name">&$var</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$var</span><span class="var-description">: the variable to print by print_r</span> </li>
</ul>
</div>
<a name="functionemptify_in_array" id="functionemptify_in_array"><!-- --></a>
<div class="evenrow">
<div>
<span class="method-title">emptify_in_array</span> (line <span class="line-number">131</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This recursive function empty values in an 'multi-dimensional' array.</p>
<ul class="tags">
<li><span class="field">return:</span> false if an empty needle passed in, else a copy of the array with needle values replaced with empty strings</li>
</ul>
<div class="method-signature">
<span class="method-result">mixed</span>
<span class="method-name">
emptify_in_array
</span>
(<span class="var-type">mixed</span> <span class="var-name">$array</span>, <span class="var-type">mixed</span> <span class="var-name">$needle</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$needle</span><span class="var-description">: it accepts just one value or an array of values</span> </li>
</ul>
</div>
<a name="functionmicrotime_float" id="functionmicrotime_float"><!-- --></a>
<div class="oddrow">
<div>
<span class="method-title">microtime_float</span> (line <span class="line-number">12</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">determine float value of now</p>
<ul class="tags">
<li><span class="field">return:</span> value of current time in seconds</li>
</ul>
<div class="method-signature">
<span class="method-result">float</span>
<span class="method-name">
microtime_float
</span>
()
</div>
</div>
<a name="functionpassword_gen" id="functionpassword_gen"><!-- --></a>
<div class="evenrow">
<div>
<span class="method-title">password_gen</span> (line <span class="line-number">110</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generate a random string good for passwords</p>
<ul class="tags">
<li><span class="field">return:</span> password</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
password_gen
</span>
([<span class="var-type">in</span> <span class="var-name">$len</span> = <span class="var-default">6</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">in</span>
<span class="var-name">$len</span><span class="var-description">: the length of the password string</span> </li>
</ul>
</div>
<a name="functionrecord_exists" id="functionrecord_exists"><!-- --></a>
<div class="oddrow">
<div>
<span class="method-title">record_exists</span> (line <span class="line-number">158</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This function checks for the existence of a particular row in a particular table matching a value.</p>
<p class="description"><p>Use this with libdb, unless you want lots of problems. :)</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
record_exists
</span>
(<span class="var-type">string</span> <span class="var-name">$table</span>, <span class="var-type">string</span> <span class="var-name">$column</span>, <span class="var-type">string</span> <span class="var-name">$val</span>, [<span class="var-type">string</span> <span class="var-name">$extra</span> = <span class="var-default">NULL</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$table</span><span class="var-description">: name of table</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$column</span><span class="var-description">: name of column containing value to match</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$val</span><span class="var-description">: value to match against database (goes in WHERE clause)</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$extra</span><span class="var-description">: (optional) any AND or ORDER BY or LIMIT or anything you want to add.</span> </li>
</ul>
</div>
<a name="functionset_error" id="functionset_error"><!-- --></a>
<div class="evenrow">
<div>
<span class="method-title">set_error</span> (line <span class="line-number">61</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add an error message to SESSION['errors'] array.</p>
<p class="description"><p>The $_SESSION['errors'] array stores error messages.</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
set_error
</span>
([<span class="var-type">string</span> <span class="var-name">$str</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$str</span><span class="var-description">: message to add (optional)</span> </li>
</ul>
</div>
<a name="functionset_msg" id="functionset_msg"><!-- --></a>
<div class="oddrow">
<div>
<span class="method-title">set_msg</span> (line <span class="line-number">23</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add a message to SESSION['messages'] array.</p>
<p class="description"><p>The $_SESSION['messages'] array stores general or success messages.</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
set_msg
</span>
([<span class="var-type">string</span> <span class="var-name">$str</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$str</span><span class="var-description">: message to add (optional)</span> </li>
</ul>
</div>
<a name="functionshow_error" id="functionshow_error"><!-- --></a>
<div class="evenrow">
<div>
<span class="method-title">show_error</span> (line <span class="line-number">74</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Show errors messages.</p>
<p class="description"><p>Iterates through $_SESSION['errors'] and displays them in a ul.</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
show_error
</span>
([<span class="var-type">string</span> <span class="var-name">$class</span> = <span class="var-default">'error'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$class</span><span class="var-description">: css class for message style</span> </li>
</ul>
</div>
<a name="functionshow_msg" id="functionshow_msg"><!-- --></a>
<div class="oddrow">
<div>
<span class="method-title">show_msg</span> (line <span class="line-number">36</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Show messages.</p>
<p class="description"><p>Iterates through $_SESSION['messages'] and displays them in a ul.</p></p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
show_msg
</span>
([<span class="var-type">string</span> <span class="var-name">$class</span> = <span class="var-default">'msg'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$class</span><span class="var-description">: css class for message style</span> </li>
</ul>
</div>
<a name="functionshow_tabs" id="functionshow_tabs"><!-- --></a>
<div class="evenrow">
<div>
<span class="method-title">show_tabs</span> (line <span class="line-number">173</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Show user tabs, based on an array.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
show_tabs
</span>
(<span class="var-type">array</span> <span class="var-name">$tabs</span>, <span class="var-type">string</span> <span class="var-name">$current</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$tabs</span><span class="var-description">: array of tabs (name=>href)</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$current</span><span class="var-description">: name of tab to highlight</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Mon, 8 Nov 2004 13:43:06 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
</p>
</div></body>
</html>
|
GitWeb