1 |
jonen |
1.2 |
<?xml version="1.0" encoding="iso-8859-1"?>
|
2 |
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3 |
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
4 |
|
|
<head>
|
5 |
|
|
<!-- template designed by Marco Von Ballmoos -->
|
6 |
|
|
<title>Docs For Class FEFile</title>
|
7 |
|
|
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
8 |
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
9 |
|
|
</head>
|
10 |
|
|
<body>
|
11 |
|
|
<div class="page-body">
|
12 |
|
|
<h2 class="class-name">Class FEFile</h2>
|
13 |
|
|
|
14 |
|
|
<a name="sec-description"></a>
|
15 |
|
|
<div class="info-box">
|
16 |
|
|
<div class="info-box-title">Description</div>
|
17 |
|
|
<div class="nav-bar">
|
18 |
|
|
<span class="disabled">Description</span> |
|
19 |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
20 |
|
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
21 |
|
|
|
22 |
|
|
</div>
|
23 |
|
|
<div class="info-box-body">
|
24 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
25 |
|
|
<p class="short-description">This is the FileUpload FormElement which builds a input field of type="file". This automagically handles the case of a confirmation page.</p>
|
26 |
|
|
<ul class="tags">
|
27 |
|
|
<li><span class="field">copyright:</span> LGPL - See LICENCE</li>
|
28 |
|
|
<li><span class="field">author:</span> Dave Brondsema <<a href="mailto:dave@brondsema.net">dave@brondsema.net</a>></li>
|
29 |
|
|
</ul>
|
30 |
|
|
<p class="notes">
|
31 |
|
|
Located in <a class="field" href="_form_form_elements_FEFile_inc.html">/form/form_elements/FEFile.inc</a> (line <span class="field">27</span>)
|
32 |
|
|
</p>
|
33 |
|
|
|
34 |
|
|
|
35 |
jonen |
1.1 |
<pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a> |
36 |
|
|
| |
37 |
|
|
--<a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a> |
38 |
|
|
| |
39 |
jonen |
1.2 |
--FEFile</pre>
|
40 |
|
|
|
41 |
|
|
</div>
|
42 |
|
|
</div>
|
43 |
|
|
|
44 |
|
|
|
45 |
|
|
|
46 |
|
|
<a name="sec-var-summary"></a>
|
47 |
|
|
<div class="info-box">
|
48 |
|
|
<div class="info-box-title">Variable Summary</span></div>
|
49 |
|
|
<div class="nav-bar">
|
50 |
|
|
<a href="#sec-description">Description</a> |
|
51 |
|
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
52 |
|
|
|
|
53 |
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
54 |
|
|
|
55 |
|
|
</div>
|
56 |
|
|
<div class="info-box-body">
|
57 |
|
|
<div class="var-summary">
|
58 |
|
|
<div class="var-title">
|
59 |
|
|
<span class="var-type">mixed</span>
|
60 |
|
|
<a href="#$_files_info" title="details" class="var-name">$_files_info</a>
|
61 |
|
|
</div>
|
62 |
|
|
<div class="var-title">
|
63 |
|
|
<span class="var-type">mixed</span>
|
64 |
|
|
<a href="#$_max_size" title="details" class="var-name">$_max_size</a>
|
65 |
|
|
</div>
|
66 |
|
|
<div class="var-title">
|
67 |
|
|
<span class="var-type">mixed</span>
|
68 |
|
|
<a href="#$_temp_dir" title="details" class="var-name">$_temp_dir</a>
|
69 |
|
|
</div>
|
70 |
|
|
<div class="var-title">
|
71 |
|
|
<span class="var-type">mixed</span>
|
72 |
|
|
<a href="#$_valid_types" title="details" class="var-name">$_valid_types</a>
|
73 |
|
|
</div>
|
74 |
|
|
</div>
|
75 |
|
|
</div>
|
76 |
|
|
</div>
|
77 |
|
|
|
78 |
|
|
<a name="sec-method-summary"></a>
|
79 |
|
|
<div class="info-box">
|
80 |
|
|
<div class="info-box-title">Method Summary</span></div>
|
81 |
|
|
<div class="nav-bar">
|
82 |
|
|
<a href="#sec-description">Description</a> |
|
83 |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
84 |
|
|
|
85 |
|
|
|
|
86 |
|
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
87 |
|
|
</div>
|
88 |
|
|
<div class="info-box-body">
|
89 |
|
|
<div class="method-summary">
|
90 |
|
|
|
91 |
|
|
<div class="method-definition">
|
92 |
|
|
<span class="method-result">void</span>
|
93 |
|
|
<a href="#add_valid_type" title="details" class="method-name">add_valid_type</a>
|
94 |
|
|
(<span class="var-type">string</span> <span class="var-name">$mime_type</span>)
|
95 |
|
|
</div>
|
96 |
|
|
|
97 |
|
|
<div class="method-definition">
|
98 |
|
|
<span class="method-result"><a href="../../phpHtmlLib/INPUTtag.html">INPUTtag</a></span>
|
99 |
|
|
<a href="#get_confirm_element" title="details" class="method-name">get_confirm_element</a>
|
100 |
|
|
()
|
101 |
|
|
</div>
|
102 |
|
|
|
103 |
|
|
<div class="method-definition">
|
104 |
|
|
<span class="method-result">object</span>
|
105 |
|
|
<a href="#get_element" title="details" class="method-name">get_element</a>
|
106 |
|
|
()
|
107 |
|
|
</div>
|
108 |
|
|
|
109 |
|
|
<div class="method-definition">
|
110 |
|
|
<span class="method-result">array</span>
|
111 |
|
|
<a href="#get_file_info" title="details" class="method-name">get_file_info</a>
|
112 |
|
|
()
|
113 |
|
|
</div>
|
114 |
|
|
|
115 |
|
|
<div class="method-definition">
|
116 |
|
|
<span class="method-result">integer</span>
|
117 |
|
|
<a href="#get_max_size" title="details" class="method-name">get_max_size</a>
|
118 |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$max_size</span>)
|
119 |
|
|
</div>
|
120 |
|
|
|
121 |
|
|
<div class="method-definition">
|
122 |
|
|
<span class="method-result">string</span>
|
123 |
|
|
<a href="#get_pre_confirm_value" title="details" class="method-name">get_pre_confirm_value</a>
|
124 |
|
|
()
|
125 |
|
|
</div>
|
126 |
|
|
|
127 |
|
|
<div class="method-definition">
|
128 |
|
|
<span class="method-result">string</span>
|
129 |
|
|
<a href="#get_temp_dir" title="details" class="method-name">get_temp_dir</a>
|
130 |
|
|
()
|
131 |
|
|
</div>
|
132 |
|
|
|
133 |
|
|
<div class="method-definition">
|
134 |
|
|
<span class="method-result">mixed</span>
|
135 |
|
|
<a href="#get_value" title="details" class="method-name">get_value</a>
|
136 |
|
|
()
|
137 |
|
|
</div>
|
138 |
|
|
|
139 |
|
|
<div class="method-definition">
|
140 |
|
|
<span class="method-result">string</span>
|
141 |
|
|
<a href="#get_value_text" title="details" class="method-name">get_value_text</a>
|
142 |
|
|
(<span class="var-type">mixed</span> <span class="var-name">0</span>)
|
143 |
|
|
</div>
|
144 |
|
|
|
145 |
|
|
<div class="method-definition">
|
146 |
|
|
<span class="method-result">void</span>
|
147 |
|
|
<a href="#set_max_size" title="details" class="method-name">set_max_size</a>
|
148 |
|
|
(<span class="var-type">integer</span> <span class="var-name">$max_size</span>)
|
149 |
|
|
</div>
|
150 |
|
|
|
151 |
|
|
<div class="method-definition">
|
152 |
|
|
<span class="method-result">void</span>
|
153 |
|
|
<a href="#set_temp_dir" title="details" class="method-name">set_temp_dir</a>
|
154 |
|
|
(<span class="var-type">string</span> <span class="var-name">$dir</span>)
|
155 |
|
|
</div>
|
156 |
|
|
|
157 |
|
|
<div class="method-definition">
|
158 |
|
|
<span class="method-result">void</span>
|
159 |
|
|
<a href="#validate" title="details" class="method-name">validate</a>
|
160 |
|
|
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> <span class="var-name">&$_FormValidation</span>)
|
161 |
|
|
</div>
|
162 |
|
|
|
163 |
|
|
<div class="method-definition">
|
164 |
|
|
<span class="method-result">void</span>
|
165 |
|
|
<a href="#_populate_file_info" title="details" class="method-name">_populate_file_info</a>
|
166 |
|
|
()
|
167 |
|
|
</div>
|
168 |
|
|
|
169 |
|
|
<div class="method-definition">
|
170 |
|
|
<span class="method-result">void</span>
|
171 |
|
|
<a href="#_pre_confirm" title="details" class="method-name">_pre_confirm</a>
|
172 |
|
|
()
|
173 |
|
|
</div>
|
174 |
|
|
</div>
|
175 |
|
|
</div>
|
176 |
|
|
</div>
|
177 |
|
|
|
178 |
|
|
<a name="sec-vars"></a>
|
179 |
|
|
<div class="info-box">
|
180 |
|
|
<div class="info-box-title">Variables</div>
|
181 |
|
|
<div class="nav-bar">
|
182 |
|
|
<a href="#sec-description">Description</a> |
|
183 |
|
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
184 |
|
|
|
185 |
|
|
|
186 |
|
|
|
|
187 |
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
188 |
|
|
|
189 |
|
|
</div>
|
190 |
|
|
<div class="info-box-body">
|
191 |
|
|
<a name="var$_files_info" id="$_files_info"><!-- --></A>
|
192 |
|
|
<div class="evenrow">
|
193 |
|
|
|
194 |
|
|
<div class="var-header">
|
195 |
|
|
<span class="var-title">
|
196 |
|
|
<span class="var-type">mixed</span>
|
197 |
|
|
<span class="var-name">$_files_info</span>
|
198 |
|
|
= <span class="var-default">array('name' => '',<br /> 'type' => '',<br /> 'size' => '',<br /> 'tmp_name' => '')</span> (line <span class="line-number">34</span>)
|
199 |
|
|
</span>
|
200 |
|
|
</div>
|
201 |
|
|
|
202 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
203 |
|
|
<p class="short-description">The $_FILES information about the submitted file.</p>
|
204 |
|
|
|
205 |
|
|
|
206 |
|
|
|
207 |
|
|
|
208 |
|
|
|
209 |
|
|
</div>
|
210 |
|
|
<a name="var$_max_size" id="$_max_size"><!-- --></A>
|
211 |
|
|
<div class="oddrow">
|
212 |
|
|
|
213 |
|
|
<div class="var-header">
|
214 |
|
|
<span class="var-title">
|
215 |
|
|
<span class="var-type">mixed</span>
|
216 |
|
|
<span class="var-name">$_max_size</span>
|
217 |
|
|
(line <span class="line-number">55</span>)
|
218 |
|
|
</span>
|
219 |
|
|
</div>
|
220 |
|
|
|
221 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
222 |
|
|
<p class="short-description">max size in bytes determined by user</p>
|
223 |
|
|
|
224 |
|
|
|
225 |
|
|
|
226 |
|
|
|
227 |
|
|
|
228 |
|
|
</div>
|
229 |
|
|
<a name="var$_temp_dir" id="$_temp_dir"><!-- --></A>
|
230 |
|
|
<div class="evenrow">
|
231 |
|
|
|
232 |
|
|
<div class="var-header">
|
233 |
|
|
<span class="var-title">
|
234 |
|
|
<span class="var-type">mixed</span>
|
235 |
|
|
<span class="var-name">$_temp_dir</span>
|
236 |
|
|
= <span class="var-default"> "/tmp"</span> (line <span class="line-number">43</span>)
|
237 |
|
|
</span>
|
238 |
|
|
</div>
|
239 |
|
|
|
240 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
241 |
|
|
<p class="short-description">The place where we temporarily save</p>
|
242 |
|
|
<p class="description"><p>the file during confirmation</p></p>
|
243 |
|
|
|
244 |
|
|
|
245 |
|
|
|
246 |
|
|
|
247 |
|
|
|
248 |
|
|
</div>
|
249 |
|
|
<a name="var$_valid_types" id="$_valid_types"><!-- --></A>
|
250 |
|
|
<div class="oddrow">
|
251 |
|
|
|
252 |
|
|
<div class="var-header">
|
253 |
|
|
<span class="var-title">
|
254 |
|
|
<span class="var-type">mixed</span>
|
255 |
|
|
<span class="var-name">$_valid_types</span>
|
256 |
|
|
= <span class="var-default">array()</span> (line <span class="line-number">49</span>)
|
257 |
|
|
</span>
|
258 |
|
|
</div>
|
259 |
|
|
|
260 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
261 |
|
|
<p class="short-description">Array listing mime types to check for</p>
|
262 |
|
|
<p class="description"><p>during validation</p></p>
|
263 |
|
|
|
264 |
|
|
|
265 |
|
|
|
266 |
|
|
|
267 |
|
|
|
268 |
|
|
</div>
|
269 |
|
|
<h4>Inherited Variables</h4>
|
270 |
|
|
<A NAME='inherited_vars'><!-- --></A>
|
271 |
|
|
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
|
272 |
|
|
<blockquote>
|
273 |
|
|
<span class="var-title">
|
274 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br>
|
275 |
|
|
</span>
|
276 |
|
|
<span class="var-title">
|
277 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br>
|
278 |
|
|
</span>
|
279 |
|
|
<span class="var-title">
|
280 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br>
|
281 |
|
|
</span>
|
282 |
|
|
<span class="var-title">
|
283 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br>
|
284 |
|
|
</span>
|
285 |
|
|
<span class="var-title">
|
286 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br>
|
287 |
|
|
</span>
|
288 |
|
|
<span class="var-title">
|
289 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br>
|
290 |
|
|
</span>
|
291 |
|
|
<span class="var-title">
|
292 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_form_on_submit">FormElement::$_has_form_on_submit</a></span><br>
|
293 |
|
|
</span>
|
294 |
|
|
<span class="var-title">
|
295 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br>
|
296 |
|
|
</span>
|
297 |
|
|
<span class="var-title">
|
298 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br>
|
299 |
|
|
</span>
|
300 |
|
|
<span class="var-title">
|
301 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br>
|
302 |
|
|
</span>
|
303 |
|
|
<span class="var-title">
|
304 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_required_field_marker">FormElement::$_required_field_marker</a></span><br>
|
305 |
|
|
</span>
|
306 |
|
|
<span class="var-title">
|
307 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_slave_elements">FormElement::$_slave_elements</a></span><br>
|
308 |
|
|
</span>
|
309 |
|
|
<span class="var-title">
|
310 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br>
|
311 |
|
|
</span>
|
312 |
|
|
<span class="var-title">
|
313 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br>
|
314 |
|
|
</span>
|
315 |
|
|
<span class="var-title">
|
316 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br>
|
317 |
|
|
</span>
|
318 |
|
|
</blockquote>
|
319 |
|
|
|
320 |
|
|
</div>
|
321 |
|
|
</div>
|
322 |
|
|
|
323 |
|
|
<a name="sec-methods"></a>
|
324 |
|
|
<div class="info-box">
|
325 |
|
|
<div class="info-box-title">Methods</div>
|
326 |
|
|
<div class="nav-bar">
|
327 |
|
|
<a href="#sec-description">Description</a> |
|
328 |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
329 |
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
330 |
|
|
|
331 |
|
|
</div>
|
332 |
|
|
<div class="info-box-body">
|
333 |
|
|
<A NAME='method_detail'></A>
|
334 |
|
|
<a name="methodadd_valid_type" id="add_valid_type"><!-- --></a>
|
335 |
|
|
<div class="evenrow">
|
336 |
|
|
|
337 |
|
|
<div class="method-header">
|
338 |
|
|
<span class="method-title">add_valid_type</span> (line <span class="line-number">286</span>)
|
339 |
|
|
</div>
|
340 |
|
|
|
341 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
342 |
|
|
<p class="short-description">This is so the user can create a list of mime types to allow</p>
|
343 |
|
|
|
344 |
|
|
<div class="method-signature">
|
345 |
|
|
<span class="method-result">void</span>
|
346 |
|
|
<span class="method-name">
|
347 |
|
|
add_valid_type
|
348 |
|
|
</span>
|
349 |
|
|
(<span class="var-type">string</span> <span class="var-name">$mime_type</span>)
|
350 |
|
|
</div>
|
351 |
|
|
|
352 |
|
|
<ul class="parameters">
|
353 |
|
|
<li>
|
354 |
|
|
<span class="var-type">string</span>
|
355 |
|
|
<span class="var-name">$mime_type</span><span class="var-description">: a mime type to check for</span> </li>
|
356 |
|
|
</ul>
|
357 |
|
|
|
358 |
|
|
|
359 |
|
|
</div>
|
360 |
|
|
<a name="methodget_confirm_element" id="get_confirm_element"><!-- --></a>
|
361 |
|
|
<div class="oddrow">
|
362 |
|
|
|
363 |
|
|
<div class="method-header">
|
364 |
|
|
<span class="method-title">get_confirm_element</span> (line <span class="line-number">275</span>)
|
365 |
|
|
</div>
|
366 |
|
|
|
367 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
368 |
|
|
<p class="short-description">This method returns the hidden version of this element for a confirmation page.</p>
|
369 |
|
|
<p class="description"><p>NOTE: This is called by the FormProcessor only. It shouldn't be called manually.</p></p>
|
370 |
|
|
<ul class="tags">
|
371 |
|
|
<li><span class="field">return:</span> of type hidden</li>
|
372 |
|
|
</ul>
|
373 |
|
|
|
374 |
|
|
<div class="method-signature">
|
375 |
|
|
<span class="method-result"><a href="../../phpHtmlLib/INPUTtag.html">INPUTtag</a></span>
|
376 |
|
|
<span class="method-name">
|
377 |
|
|
get_confirm_element
|
378 |
|
|
</span>
|
379 |
|
|
()
|
380 |
|
|
</div>
|
381 |
|
|
|
382 |
|
|
|
383 |
|
|
<hr class="separator" />
|
384 |
|
|
<div class="notes">Redefinition of:</div>
|
385 |
|
|
<dl>
|
386 |
|
|
<dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></dt>
|
387 |
|
|
<dd>This method returns the hidden version of this element for a confirmation page.</dd>
|
388 |
|
|
</dl>
|
389 |
|
|
|
390 |
|
|
</div>
|
391 |
|
|
<a name="methodget_element" id="get_element"><!-- --></a>
|
392 |
|
|
<div class="evenrow">
|
393 |
|
|
|
394 |
|
|
<div class="method-header">
|
395 |
|
|
<span class="method-title">get_element</span> (line <span class="line-number">63</span>)
|
396 |
|
|
</div>
|
397 |
|
|
|
398 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
399 |
|
|
<p class="short-description">This function builds and returns the form element object</p>
|
400 |
|
|
|
401 |
|
|
<div class="method-signature">
|
402 |
|
|
<span class="method-result">object</span>
|
403 |
|
|
<span class="method-name">
|
404 |
|
|
get_element
|
405 |
|
|
</span>
|
406 |
|
|
()
|
407 |
|
|
</div>
|
408 |
|
|
|
409 |
|
|
|
410 |
|
|
<hr class="separator" />
|
411 |
|
|
<div class="notes">Redefinition of:</div>
|
412 |
|
|
<dl>
|
413 |
|
|
<dt><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></dt>
|
414 |
|
|
<dd>This function builds and returns the form element object</dd>
|
415 |
|
|
</dl>
|
416 |
|
|
|
417 |
|
|
</div>
|
418 |
|
|
<a name="methodget_file_info" id="get_file_info"><!-- --></a>
|
419 |
|
|
<div class="oddrow">
|
420 |
|
|
|
421 |
|
|
<div class="method-header">
|
422 |
|
|
<span class="method-title">get_file_info</span> (line <span class="line-number">197</span>)
|
423 |
|
|
</div>
|
424 |
|
|
|
425 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
426 |
|
|
<p class="short-description">This function will return this file's portion of the $_FILES array</p>
|
427 |
|
|
|
428 |
|
|
<div class="method-signature">
|
429 |
|
|
<span class="method-result">array</span>
|
430 |
|
|
<span class="method-name">
|
431 |
|
|
get_file_info
|
432 |
|
|
</span>
|
433 |
|
|
()
|
434 |
|
|
</div>
|
435 |
|
|
|
436 |
|
|
|
437 |
|
|
|
438 |
|
|
</div>
|
439 |
|
|
<a name="methodget_max_size" id="get_max_size"><!-- --></a>
|
440 |
|
|
<div class="evenrow">
|
441 |
|
|
|
442 |
|
|
<div class="method-header">
|
443 |
|
|
<span class="method-title">get_max_size</span> (line <span class="line-number">305</span>)
|
444 |
|
|
</div>
|
445 |
|
|
|
446 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
447 |
|
|
<p class="short-description">This allows the user to get the max size of the file (if any has been set)</p>
|
448 |
|
|
<ul class="tags">
|
449 |
|
|
<li><span class="field">return:</span> value of $_max_size if any</li>
|
450 |
|
|
</ul>
|
451 |
|
|
|
452 |
|
|
<div class="method-signature">
|
453 |
|
|
<span class="method-result">integer</span>
|
454 |
|
|
<span class="method-name">
|
455 |
|
|
get_max_size
|
456 |
|
|
</span>
|
457 |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$max_size</span>)
|
458 |
|
|
</div>
|
459 |
|
|
|
460 |
|
|
|
461 |
|
|
|
462 |
|
|
</div>
|
463 |
|
|
<a name="methodget_pre_confirm_value" id="get_pre_confirm_value"><!-- --></a>
|
464 |
|
|
<div class="oddrow">
|
465 |
|
|
|
466 |
|
|
<div class="method-header">
|
467 |
|
|
<span class="method-title">get_pre_confirm_value</span> (line <span class="line-number">186</span>)
|
468 |
|
|
</div>
|
469 |
|
|
|
470 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
471 |
|
|
<p class="short-description">This is so we can save the file information in a hidden form field during confirmation page.</p>
|
472 |
|
|
|
473 |
|
|
<div class="method-signature">
|
474 |
|
|
<span class="method-result">string</span>
|
475 |
|
|
<span class="method-name">
|
476 |
|
|
get_pre_confirm_value
|
477 |
|
|
</span>
|
478 |
|
|
()
|
479 |
|
|
</div>
|
480 |
|
|
|
481 |
|
|
|
482 |
|
|
|
483 |
|
|
</div>
|
484 |
|
|
<a name="methodget_temp_dir" id="get_temp_dir"><!-- --></a>
|
485 |
|
|
<div class="evenrow">
|
486 |
|
|
|
487 |
|
|
<div class="method-header">
|
488 |
|
|
<span class="method-title">get_temp_dir</span> (line <span class="line-number">219</span>)
|
489 |
|
|
</div>
|
490 |
|
|
|
491 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
492 |
|
|
<p class="short-description">This is so the user can get the temp directory where the file was saved during confirmation (if any)</p>
|
493 |
|
|
<ul class="tags">
|
494 |
|
|
<li><span class="field">return:</span> the new temp dir.</li>
|
495 |
|
|
</ul>
|
496 |
|
|
|
497 |
|
|
<div class="method-signature">
|
498 |
|
|
<span class="method-result">string</span>
|
499 |
|
|
<span class="method-name">
|
500 |
|
|
get_temp_dir
|
501 |
|
|
</span>
|
502 |
|
|
()
|
503 |
|
|
</div>
|
504 |
|
|
|
505 |
|
|
|
506 |
|
|
|
507 |
|
|
</div>
|
508 |
|
|
<a name="methodget_value" id="get_value"><!-- --></a>
|
509 |
|
|
<div class="oddrow">
|
510 |
|
|
|
511 |
|
|
<div class="method-header">
|
512 |
|
|
<span class="method-title">get_value</span> (line <span class="line-number">147</span>)
|
513 |
|
|
</div>
|
514 |
|
|
|
515 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
516 |
|
|
<p class="short-description">This function will return the elements value</p>
|
517 |
|
|
|
518 |
|
|
<div class="method-signature">
|
519 |
|
|
<span class="method-result">mixed</span>
|
520 |
|
|
<span class="method-name">
|
521 |
|
|
get_value
|
522 |
|
|
</span>
|
523 |
|
|
()
|
524 |
|
|
</div>
|
525 |
|
|
|
526 |
|
|
|
527 |
|
|
<hr class="separator" />
|
528 |
|
|
<div class="notes">Redefinition of:</div>
|
529 |
|
|
<dl>
|
530 |
|
|
<dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></dt>
|
531 |
|
|
<dd>This function will return the elements value</dd>
|
532 |
|
|
</dl>
|
533 |
|
|
|
534 |
|
|
</div>
|
535 |
|
|
<a name="methodget_value_text" id="get_value_text"><!-- --></a>
|
536 |
|
|
<div class="evenrow">
|
537 |
|
|
|
538 |
|
|
<div class="method-header">
|
539 |
|
|
<span class="method-title">get_value_text</span> (line <span class="line-number">169</span>)
|
540 |
|
|
</div>
|
541 |
|
|
|
542 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
543 |
|
|
<ul class="tags">
|
544 |
|
|
<li><span class="field">return:</span> - the text associated</li>
|
545 |
|
|
</ul>
|
546 |
|
|
|
547 |
|
|
<div class="method-signature">
|
548 |
|
|
<span class="method-result">string</span>
|
549 |
|
|
<span class="method-name">
|
550 |
|
|
get_value_text
|
551 |
|
|
</span>
|
552 |
|
|
(<span class="var-type">mixed</span> <span class="var-name">0</span>)
|
553 |
|
|
</div>
|
554 |
|
|
|
555 |
|
|
<ul class="parameters">
|
556 |
|
|
<li>
|
557 |
|
|
<span class="var-type">mixed</span>
|
558 |
|
|
<span class="var-name">0</span><span class="var-description">: - the value to look up</span> </li>
|
559 |
|
|
</ul>
|
560 |
|
|
|
561 |
|
|
<hr class="separator" />
|
562 |
|
|
<div class="notes">Redefinition of:</div>
|
563 |
|
|
<dl>
|
564 |
|
|
<dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></dt>
|
565 |
|
|
<dd>This provides a method</dd>
|
566 |
|
|
</dl>
|
567 |
|
|
|
568 |
|
|
</div>
|
569 |
|
|
<a name="methodset_max_size" id="set_max_size"><!-- --></a>
|
570 |
|
|
<div class="oddrow">
|
571 |
|
|
|
572 |
|
|
<div class="method-header">
|
573 |
|
|
<span class="method-title">set_max_size</span> (line <span class="line-number">295</span>)
|
574 |
|
|
</div>
|
575 |
|
|
|
576 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
577 |
|
|
<p class="short-description">This allows the user to set the max size of the file</p>
|
578 |
|
|
|
579 |
|
|
<div class="method-signature">
|
580 |
|
|
<span class="method-result">void</span>
|
581 |
|
|
<span class="method-name">
|
582 |
|
|
set_max_size
|
583 |
|
|
</span>
|
584 |
|
|
(<span class="var-type">integer</span> <span class="var-name">$max_size</span>)
|
585 |
|
|
</div>
|
586 |
|
|
|
587 |
|
|
<ul class="parameters">
|
588 |
|
|
<li>
|
589 |
|
|
<span class="var-type">integer</span>
|
590 |
|
|
<span class="var-name">$max_size</span><span class="var-description">: max size in bytes</span> </li>
|
591 |
|
|
</ul>
|
592 |
|
|
|
593 |
|
|
|
594 |
|
|
</div>
|
595 |
|
|
<a name="methodset_temp_dir" id="set_temp_dir"><!-- --></a>
|
596 |
|
|
<div class="evenrow">
|
597 |
|
|
|
598 |
|
|
<div class="method-header">
|
599 |
|
|
<span class="method-title">set_temp_dir</span> (line <span class="line-number">208</span>)
|
600 |
|
|
</div>
|
601 |
|
|
|
602 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
603 |
|
|
<p class="short-description">This is so the user can set the temp directory where the file will be saved during confirmation (if any)</p>
|
604 |
|
|
|
605 |
|
|
<div class="method-signature">
|
606 |
|
|
<span class="method-result">void</span>
|
607 |
|
|
<span class="method-name">
|
608 |
|
|
set_temp_dir
|
609 |
|
|
</span>
|
610 |
|
|
(<span class="var-type">string</span> <span class="var-name">$dir</span>)
|
611 |
|
|
</div>
|
612 |
|
|
|
613 |
|
|
<ul class="parameters">
|
614 |
|
|
<li>
|
615 |
|
|
<span class="var-type">string</span>
|
616 |
|
|
<span class="var-name">$dir</span><span class="var-description">: the new temp dir.</span> </li>
|
617 |
|
|
</ul>
|
618 |
|
|
|
619 |
|
|
|
620 |
|
|
</div>
|
621 |
|
|
<a name="methodvalidate" id="validate"><!-- --></a>
|
622 |
|
|
<div class="oddrow">
|
623 |
|
|
|
624 |
|
|
<div class="method-header">
|
625 |
|
|
<span class="method-title">validate</span> (line <span class="line-number">82</span>)
|
626 |
|
|
</div>
|
627 |
|
|
|
628 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
629 |
|
|
<p class="short-description">This method validates the data for this Form Element.</p>
|
630 |
|
|
<p class="description"><p>It validates file size and partial uploads..</p></p>
|
631 |
|
|
|
632 |
|
|
<div class="method-signature">
|
633 |
|
|
<span class="method-result">void</span>
|
634 |
|
|
<span class="method-name">
|
635 |
|
|
validate
|
636 |
|
|
</span>
|
637 |
|
|
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> <span class="var-name">&$_FormValidation</span>)
|
638 |
|
|
</div>
|
639 |
|
|
|
640 |
|
|
<ul class="parameters">
|
641 |
|
|
<li>
|
642 |
|
|
<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>
|
643 |
|
|
<span class="var-name">&$_FormValidation</span><span class="var-description">: object.</span> </li>
|
644 |
|
|
</ul>
|
645 |
|
|
|
646 |
|
|
<hr class="separator" />
|
647 |
|
|
<div class="notes">Redefinition of:</div>
|
648 |
|
|
<dl>
|
649 |
|
|
<dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></dt>
|
650 |
|
|
<dd>This function performs the actual validation It is called only if the validation is required by this element</dd>
|
651 |
|
|
</dl>
|
652 |
|
|
|
653 |
|
|
</div>
|
654 |
|
|
<a name="method_populate_file_info" id="_populate_file_info"><!-- --></a>
|
655 |
|
|
<div class="evenrow">
|
656 |
|
|
|
657 |
|
|
<div class="method-header">
|
658 |
|
|
<span class="method-title">_populate_file_info</span> (line <span class="line-number">259</span>)
|
659 |
|
|
</div>
|
660 |
|
|
|
661 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
662 |
|
|
<p class="short-description">This method re-populates the $this->_files_info because the form had a confirmation page, and the user accepted the confirmation.</p>
|
663 |
|
|
<p class="description"><p>This is so we can re populate the local private var so we can get access at the file data on disk.</p></p>
|
664 |
|
|
|
665 |
|
|
<div class="method-signature">
|
666 |
|
|
<span class="method-result">void</span>
|
667 |
|
|
<span class="method-name">
|
668 |
|
|
_populate_file_info
|
669 |
|
|
</span>
|
670 |
|
|
()
|
671 |
|
|
</div>
|
672 |
|
|
|
673 |
|
|
|
674 |
|
|
|
675 |
|
|
</div>
|
676 |
|
|
<a name="method_pre_confirm" id="_pre_confirm"><!-- --></a>
|
677 |
|
|
<div class="oddrow">
|
678 |
|
|
|
679 |
|
|
<div class="method-header">
|
680 |
|
|
<span class="method-title">_pre_confirm</span> (line <span class="line-number">233</span>)
|
681 |
|
|
</div>
|
682 |
|
|
|
683 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
684 |
|
|
<p class="short-description">The function that allows us to save the temp file someplace we can use it after a confirmation has been accepted.</p>
|
685 |
|
|
<p class="description"><p>NOTE: if the user doesn't confirm, then this could leave files in /tmp</p></p>
|
686 |
|
|
|
687 |
|
|
<div class="method-signature">
|
688 |
|
|
<span class="method-result">void</span>
|
689 |
|
|
<span class="method-name">
|
690 |
|
|
_pre_confirm
|
691 |
|
|
</span>
|
692 |
|
|
()
|
693 |
|
|
</div>
|
694 |
|
|
|
695 |
|
|
|
696 |
|
|
|
697 |
|
|
</div>
|
698 |
|
|
<h4>Inherited Methods</h4>
|
699 |
|
|
<a name='inherited_methods'><!-- --></a>
|
700 |
|
|
<!-- =========== Summary =========== -->
|
701 |
|
|
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a></span></p>
|
702 |
|
|
<blockquote>
|
703 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodFEText">FEText::FEText()</a></span><br>
|
704 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></span><br>
|
705 |
|
|
</blockquote>
|
706 |
|
|
<!-- =========== Summary =========== -->
|
707 |
|
|
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
|
708 |
|
|
<blockquote>
|
709 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br>
|
710 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br>
|
711 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodform_tag_onsubmit">FormElement::form_tag_onsubmit()</a></span><br>
|
712 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br>
|
713 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></span><br>
|
714 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br>
|
715 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br>
|
716 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br>
|
717 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br>
|
718 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br>
|
719 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br>
|
720 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br>
|
721 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br>
|
722 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_slave_elements">FormElement::get_slave_elements()</a></span><br>
|
723 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_tabindex">FormElement::get_tabindex()</a></span><br>
|
724 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br>
|
725 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br>
|
726 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br>
|
727 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br>
|
728 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br>
|
729 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br>
|
730 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br>
|
731 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br>
|
732 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br>
|
733 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br>
|
734 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br>
|
735 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br>
|
736 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_data_all_slaves">FormElement::set_data_all_slaves()</a></span><br>
|
737 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br>
|
738 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_element_name">FormElement::set_element_name()</a></span><br>
|
739 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br>
|
740 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br>
|
741 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br>
|
742 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br>
|
743 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required_symbol">FormElement::set_required_symbol()</a></span><br>
|
744 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_data">FormElement::set_slave_data()</a></span><br>
|
745 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_elements">FormElement::set_slave_elements()</a></span><br>
|
746 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br>
|
747 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br>
|
748 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_tabindex">FormElement::set_tabindex()</a></span><br>
|
749 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br>
|
750 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br>
|
751 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br>
|
752 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br>
|
753 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br>
|
754 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br>
|
755 |
|
|
</blockquote>
|
756 |
|
|
|
757 |
|
|
</div>
|
758 |
|
|
</div>
|
759 |
|
|
|
760 |
|
|
|
761 |
|
|
<p class="notes" id="credit">
|
762 |
|
|
Documentation generated on Thu, 1 Apr 2004 09:38:23 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
|
763 |
|
|
</p>
|
764 |
|
|
</div></body>
|
765 |
|
|
</html>
|