1 |
jonen |
1.1 |
<?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-vars">Vars</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".</p> |
26 |
|
|
<ul class="tags"> |
27 |
|
|
<li><span class="field">copyright:</span> <p>LGPL - See LICENCE</p></li> |
28 |
|
|
<li><span class="field">author:</span> <p>Dave Brondsema <<a href="mailto:dave@brondsema.net">mailto:dave@brondsema.net</a>></p></li> |
29 |
|
|
</ul> |
30 |
|
|
<p class="notes"> |
31 |
|
|
Located in <a class="field" href="_form_form_elements_FEFile_inc.html">Program_Root/form/form_elements/FEFile.inc</a> (line <span class="field">26</span>) |
32 |
|
|
</p> |
33 |
|
|
|
34 |
|
|
|
35 |
|
|
<pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a> |
36 |
|
|
| |
37 |
|
|
--<a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a> |
38 |
|
|
| |
39 |
|
|
--FEFile</pre> |
40 |
|
|
|
41 |
|
|
</div> |
42 |
|
|
</div> |
43 |
|
|
|
44 |
|
|
|
45 |
|
|
|
46 |
|
|
<a name="sec-method-summary"></a> |
47 |
|
|
<div class="info-box"> |
48 |
|
|
<div class="info-box-title">Method Summary</span></div> |
49 |
|
|
<div class="nav-bar"> |
50 |
|
|
<a href="#sec-description">Description</a> | |
51 |
|
|
<a href="#sec-vars">Vars</a> |
52 |
|
|
|
53 |
|
|
| |
54 |
|
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
55 |
|
|
</div> |
56 |
|
|
<div class="info-box-body"> |
57 |
|
|
<div class="method-summary"> |
58 |
|
|
|
59 |
|
|
<div class="method-definition"> |
60 |
|
|
<span class="method-result">object</span> |
61 |
|
|
<a href="#get_element" title="details" class="method-name">get_element</a> |
62 |
|
|
() |
63 |
|
|
</div> |
64 |
|
|
|
65 |
|
|
<div class="method-definition"> |
66 |
|
|
<span class="method-result">array</span> |
67 |
|
|
<a href="#get_file_info" title="details" class="method-name">get_file_info</a> |
68 |
|
|
() |
69 |
|
|
</div> |
70 |
|
|
|
71 |
|
|
<div class="method-definition"> |
72 |
|
|
<span class="method-result">mixed</span> |
73 |
|
|
<a href="#get_value" title="details" class="method-name">get_value</a> |
74 |
|
|
() |
75 |
|
|
</div> |
76 |
|
|
|
77 |
|
|
<div class="method-definition"> |
78 |
|
|
<span class="method-result">void</span> |
79 |
|
|
<a href="#validate" title="details" class="method-name">validate</a> |
80 |
|
|
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> <span class="var-name">&$_FormValidation</span>) |
81 |
|
|
</div> |
82 |
|
|
</div> |
83 |
|
|
</div> |
84 |
|
|
</div> |
85 |
|
|
|
86 |
|
|
<a name="sec-vars"></a> |
87 |
|
|
<div class="info-box"> |
88 |
|
|
<div class="info-box-title">Variables</div> |
89 |
|
|
<div class="nav-bar"> |
90 |
|
|
<a href="#sec-description">Description</a> | |
91 |
|
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
92 |
|
|
|
93 |
|
|
|
94 |
|
|
| |
95 |
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
96 |
|
|
|
97 |
|
|
</div> |
98 |
|
|
<div class="info-box-body"> |
99 |
|
|
<h4>Inherited Variables</h4> |
100 |
|
|
<A NAME='inherited_vars'><!-- --></A> |
101 |
|
|
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
102 |
|
|
<blockquote> |
103 |
|
|
<span class="var-title"> |
104 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br> |
105 |
|
|
</span> |
106 |
|
|
<span class="var-title"> |
107 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br> |
108 |
|
|
</span> |
109 |
|
|
<span class="var-title"> |
110 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br> |
111 |
|
|
</span> |
112 |
|
|
<span class="var-title"> |
113 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br> |
114 |
|
|
</span> |
115 |
|
|
<span class="var-title"> |
116 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br> |
117 |
|
|
</span> |
118 |
|
|
<span class="var-title"> |
119 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br> |
120 |
|
|
</span> |
121 |
|
|
<span class="var-title"> |
122 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br> |
123 |
|
|
</span> |
124 |
|
|
<span class="var-title"> |
125 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br> |
126 |
|
|
</span> |
127 |
|
|
<span class="var-title"> |
128 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br> |
129 |
|
|
</span> |
130 |
|
|
<span class="var-title"> |
131 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br> |
132 |
|
|
</span> |
133 |
|
|
<span class="var-title"> |
134 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br> |
135 |
|
|
</span> |
136 |
|
|
<span class="var-title"> |
137 |
|
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br> |
138 |
|
|
</span> |
139 |
|
|
</blockquote> |
140 |
|
|
|
141 |
|
|
</div> |
142 |
|
|
</div> |
143 |
|
|
|
144 |
|
|
<a name="sec-methods"></a> |
145 |
|
|
<div class="info-box"> |
146 |
|
|
<div class="info-box-title">Methods</div> |
147 |
|
|
<div class="nav-bar"> |
148 |
|
|
<a href="#sec-description">Description</a> | |
149 |
|
|
<a href="#sec-vars">Vars</a> |
150 |
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
151 |
|
|
|
152 |
|
|
</div> |
153 |
|
|
<div class="info-box-body"> |
154 |
|
|
<A NAME='method_detail'></A> |
155 |
|
|
<a name="methodget_element" id="get_element"><!-- --></a> |
156 |
|
|
<div class="evenrow"> |
157 |
|
|
|
158 |
|
|
<div class="method-header"> |
159 |
|
|
<span class="method-title">get_element</span> (line <span class="line-number">34</span>) |
160 |
|
|
</div> |
161 |
|
|
|
162 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
163 |
|
|
<p class="short-description">This function builds and returns the form element object</p> |
164 |
|
|
|
165 |
|
|
<div class="method-signature"> |
166 |
|
|
<span class="method-result">object</span> |
167 |
|
|
<span class="method-name"> |
168 |
|
|
get_element |
169 |
|
|
</span> |
170 |
|
|
() |
171 |
|
|
</div> |
172 |
|
|
|
173 |
|
|
|
174 |
|
|
<hr class="separator" /> |
175 |
|
|
<div class="notes">Redefinition of:</div> |
176 |
|
|
<dl> |
177 |
|
|
<dt><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></dt> |
178 |
|
|
<dd>This function builds and returns the form element object</dd> |
179 |
|
|
</dl> |
180 |
|
|
|
181 |
|
|
</div> |
182 |
|
|
<a name="methodget_file_info" id="get_file_info"><!-- --></a> |
183 |
|
|
<div class="oddrow"> |
184 |
|
|
|
185 |
|
|
<div class="method-header"> |
186 |
|
|
<span class="method-title">get_file_info</span> (line <span class="line-number">104</span>) |
187 |
|
|
</div> |
188 |
|
|
|
189 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
190 |
|
|
<p class="short-description">This function will return this file's portion of the $_FILES array</p> |
191 |
|
|
|
192 |
|
|
<div class="method-signature"> |
193 |
|
|
<span class="method-result">array</span> |
194 |
|
|
<span class="method-name"> |
195 |
|
|
get_file_info |
196 |
|
|
</span> |
197 |
|
|
() |
198 |
|
|
</div> |
199 |
|
|
|
200 |
|
|
|
201 |
|
|
|
202 |
|
|
</div> |
203 |
|
|
<a name="methodget_value" id="get_value"><!-- --></a> |
204 |
|
|
<div class="evenrow"> |
205 |
|
|
|
206 |
|
|
<div class="method-header"> |
207 |
|
|
<span class="method-title">get_value</span> (line <span class="line-number">94</span>) |
208 |
|
|
</div> |
209 |
|
|
|
210 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
211 |
|
|
<p class="short-description">This function will return the elements value</p> |
212 |
|
|
|
213 |
|
|
<div class="method-signature"> |
214 |
|
|
<span class="method-result">mixed</span> |
215 |
|
|
<span class="method-name"> |
216 |
|
|
get_value |
217 |
|
|
</span> |
218 |
|
|
() |
219 |
|
|
</div> |
220 |
|
|
|
221 |
|
|
|
222 |
|
|
<hr class="separator" /> |
223 |
|
|
<div class="notes">Redefinition of:</div> |
224 |
|
|
<dl> |
225 |
|
|
<dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></dt> |
226 |
|
|
<dd>This function will return the elements value</dd> |
227 |
|
|
</dl> |
228 |
|
|
|
229 |
|
|
</div> |
230 |
|
|
<a name="methodvalidate" id="validate"><!-- --></a> |
231 |
|
|
<div class="oddrow"> |
232 |
|
|
|
233 |
|
|
<div class="method-header"> |
234 |
|
|
<span class="method-title">validate</span> (line <span class="line-number">54</span>) |
235 |
|
|
</div> |
236 |
|
|
|
237 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
238 |
|
|
<p class="short-description">This method validates the data for this Form Element.</p> |
239 |
|
|
<p class="description"><p>It validates file size and partial uploads..</p></p> |
240 |
|
|
|
241 |
|
|
<div class="method-signature"> |
242 |
|
|
<span class="method-result">void</span> |
243 |
|
|
<span class="method-name"> |
244 |
|
|
validate |
245 |
|
|
</span> |
246 |
|
|
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> <span class="var-name">&$_FormValidation</span>) |
247 |
|
|
</div> |
248 |
|
|
|
249 |
|
|
<ul class="parameters"> |
250 |
|
|
<li> |
251 |
|
|
<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> |
252 |
|
|
<span class="var-name">&$_FormValidation</span><span class="var-description">: <p>object.</p></span> </li> |
253 |
|
|
</ul> |
254 |
|
|
|
255 |
|
|
<hr class="separator" /> |
256 |
|
|
<div class="notes">Redefinition of:</div> |
257 |
|
|
<dl> |
258 |
|
|
<dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></dt> |
259 |
|
|
<dd>This function performs the actual validation It is called only if the validation is required by this element</dd> |
260 |
|
|
</dl> |
261 |
|
|
|
262 |
|
|
</div> |
263 |
|
|
<h4>Inherited Methods</h4> |
264 |
|
|
<a name='inherited_methods'><!-- --></a> |
265 |
|
|
<!-- =========== Summary =========== --> |
266 |
|
|
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a></span></p> |
267 |
|
|
<blockquote> |
268 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodFEText">FEText::FEText()</a></span><br> |
269 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></span><br> |
270 |
|
|
</blockquote> |
271 |
|
|
<!-- =========== Summary =========== --> |
272 |
|
|
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
273 |
|
|
<blockquote> |
274 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br> |
275 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br> |
276 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br> |
277 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br> |
278 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br> |
279 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br> |
280 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br> |
281 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br> |
282 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br> |
283 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br> |
284 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br> |
285 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br> |
286 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br> |
287 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br> |
288 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br> |
289 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br> |
290 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br> |
291 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br> |
292 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br> |
293 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br> |
294 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br> |
295 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br> |
296 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br> |
297 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br> |
298 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br> |
299 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br> |
300 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br> |
301 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br> |
302 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br> |
303 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br> |
304 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br> |
305 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br> |
306 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br> |
307 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br> |
308 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br> |
309 |
|
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br> |
310 |
|
|
</blockquote> |
311 |
|
|
|
312 |
|
|
</div> |
313 |
|
|
</div> |
314 |
|
|
|
315 |
|
|
<p class="notes" id="credit"> |
316 |
|
|
Documention generated on Thu, 31 Jul 2003 18:32:30 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
317 |
|
|
</p> |
318 |
|
|
</div></body> |
319 |
|
|
</html> |