-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclass-Helper_Functions.html
More file actions
384 lines (242 loc) · 8.41 KB
/
class-Helper_Functions.html
File metadata and controls
384 lines (242 loc) · 8.41 KB
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
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Class Helper_Functions</title>
<script type="text/javascript" src="resources/combined.js?4058929694"></script>
<script type="text/javascript" src="elementlist.js?2335409893"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Packages</h3>
<ul>
<li><a href="package-None.html">None</a>
</li>
<li class="active"><a href="package-WPMVCBase.html">WPMVCBase<span></span></a>
<ul>
<li><a href="package-WPMVCBase.Controllers.html">Controllers</a>
</li>
<li class="active"><a href="package-WPMVCBase.Helper.html">Helper</a>
</li>
<li><a href="package-WPMVCBase.Models.html">Models</a>
</li>
</ul></li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li class="active"><a href="class-Helper_Functions.html">Helper_Functions</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="package-WPMVCBase.Helper.html" title="Summary of WPMVCBase\Helper"><span>Package</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Helper_Functions</h1>
<div class="description">
<p>Helper functions class</p>
</div>
<div class="info">
<b>Package:</b> <a href="package-WPMVCBase.html">WPMVCBase</a>\<a href="package-WPMVCBase.Helper.html">Helper</a><br />
<b>Author:</b>
Daryl Lozupone <<a
href="mailto:daryl@actionhook.com">daryl@<!---->actionhook.com</a>><br />
<b>Version:</b>
0.2<br />
<b>Since:</b>
WPMVCBase 0.1<br />
<b>Located at</b> <a href="source-class-Helper_Functions.html#12-218" title="Go to source code">helpers/class-base-helpers.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="create_directory" id="_create_directory">
<td class="attributes"><code>
public static
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_create_directory">#</a>
<code><a href="source-class-Helper_Functions.html#73-97" title="Go to source code">create_directory</a>( <span>string <var>$target</var></span>, <span>boolean <var>$index</var> = <span class="php-keyword1">true</span></span>, <span>octal <var>$permissions</var> = <span class="php-num">0755</span> </span> )</code>
<div class="description short">
<p>Create a directory and possibly add index.php</p>
</div>
<div class="description detailed hidden">
<p>Create a directory and possibly add index.php</p>
<p>This function will create the directory specified in $target if it does not
already exist. It will also add an index.php file if $index is set to TRUE.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$target</var></dt>
<dd><code>string</code><br>$target The directory absolute path.</dd>
<dt><var>$index</var></dt>
<dd><code>boolean</code><br>$index Create an index.php in the directory (default true).</dd>
<dt><var>$permissions</var></dt>
<dd><code>octal</code><br>$permissions The directory permissions (default 0755 ).</dd>
</dl></div>
<h4>Since</h4>
<div class="list">
0.1<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="get_local_directory_contents" id="_get_local_directory_contents">
<td class="attributes"><code>
public static
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_get_local_directory_contents">#</a>
<code><a href="source-class-Helper_Functions.html#99-123" title="Go to source code">get_local_directory_contents</a>( <span>string <var>$directory</var></span> )</code>
<div class="description short">
<p>Get the contents of a local filesystem directory.</p>
</div>
<div class="description detailed hidden">
<p>Get the contents of a local filesystem directory.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$directory</var></dt>
<dd><code>string</code><br>$directory The absolute path to the directory.</dd>
</dl></div>
<h4>Since</h4>
<div class="list">
0.1<br />
</div>
<h4>Returns</h4>
<div class="list">
array|void array An array containg the directory contents on success, void on
failure.<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="remove_local_directory" id="_remove_local_directory">
<td class="attributes"><code>
public static
boolean
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_remove_local_directory">#</a>
<code><a href="source-class-Helper_Functions.html#125-159" title="Go to source code">remove_local_directory</a>( <span>string <var>$dirname</var></span>, <span>boolean <var>$force</var> = <span class="php-keyword1">false</span> </span> )</code>
<div class="description short">
<p>Remove a directory and all contents from the local filesystem.</p>
</div>
<div class="description detailed hidden">
<p>Remove a directory and all contents from the local filesystem.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$dirname</var></dt>
<dd><code>string</code><br>$dirname The absolute path to the directory to be deleted.</dd>
<dt><var>$force</var></dt>
<dd><code>boolean</code><br>$force Delete all folder contents recursively (TRUE). Default FALSE.</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>boolean</code><br>TRUE on success, FALSE on failure.<br />
</div>
<h4>Since</h4>
<div class="list">
0.1<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="sanitize_text_field_array" id="_sanitize_text_field_array">
<td class="attributes"><code>
public static
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_sanitize_text_field_array">#</a>
<code><a href="source-class-Helper_Functions.html#179-196" title="Go to source code">sanitize_text_field_array</a>( <span>array <var>$array</var></span> )</code>
<div class="description short">
<p>Sanitize an array with sanitize_text_field.</p>
</div>
<div class="description detailed hidden">
<p>Sanitize an array with sanitize_text_field.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$array</var></dt>
<dd><code>array</code><br>$array Contains the elements to be sanitized</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>array</code><br>The sanitized array<br />
</div>
<h4>Since</h4>
<div class="list">
0.1<br />
</div>
</div>
</div></td>
</tr>
<tr data-order="deprecated" id="_deprecated">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_deprecated">#</a>
<code><a href="source-class-Helper_Functions.html#198-217" title="Go to source code">deprecated</a>( <span>mixed <var>$deprecated</var></span>, <span>mixed <var>$replacement</var></span>, <span>mixed <var>$txtdomain</var> = <span class="php-quote">''</span> </span> )</code>
<div class="description short">
<p>Generate a deprecated notice message.</p>
</div>
<div class="description detailed hidden">
<p>Generate a deprecated notice message.</p>
<p>This function is used to trigger a PHP warning message to notify user a
deprecated function has been called.</p>
<h4>Since</h4>
<div class="list">
0.2<br />
</div>
<h4>Internal</h4>
<div class="list">
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>