-
Notifications
You must be signed in to change notification settings - Fork 9
/
DateTimeField.html
303 lines (261 loc) · 13.5 KB
/
DateTimeField.html
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
<?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 Class DateTimeField</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="class-name">Class DateTimeField</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-vars">Vars</a>
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">DateTimeField</p>
<p class="description"><p>A text field that accepts a variety of date/time formats (those accepted by PHP's built-in strtotime.) Note that due to the reliance on strtotime, this class has a serious memory leak in PHP 5.2.8 (I am unsure if it is present as well in 5.2.9+.)</p></p>
<ul class="tags">
<li><span class="field">author:</span> Jeff Ober</li>
</ul>
<p class="notes">
Located in <a class="field" href="_fields.php.html">/fields.php</a> (line <span class="field">1070</span>)
</p>
<pre><a href="../Fields/PhormField.html">PhormField</a>
|
--<a href="../Fields/TextField.html">TextField</a>
|
--DateTimeField</pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">DateTimeField</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
(<span class="var-type">string</span> <span class="var-name">$label</span>, [<span class="var-type"></span> <span class="var-name">$validators</span> = <span class="var-default">array()</span>], [<span class="var-type"></span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
</div>
<div class="method-definition">
<span class="method-result">int</span>
<a href="#import_value" title="details" class="method-name">import_value</a>
(<span class="var-type">string</span> <span class="var-name">$value</span>)
</div>
<div class="method-definition">
<span class="method-result">null</span>
<a href="#validate" title="details" class="method-name">validate</a>
(<span class="var-type">string</span> <span class="var-name">$value</span>)
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../Fields/TextField.html">TextField</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../Fields/TextField.html#var$max_length">TextField::$max_length</a></span><br>
</span>
</blockquote>
<p>Inherited from <span class="classname"><a href="../Fields/PhormField.html">PhormField</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../Fields/PhormField.html#var$attributes">PhormField::$attributes</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../Fields/PhormField.html#var$errors">PhormField::$errors</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../Fields/PhormField.html#var$help_text">PhormField::$help_text</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../Fields/PhormField.html#var$imported">PhormField::$imported</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../Fields/PhormField.html#var$label">PhormField::$label</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../Fields/PhormField.html#var$multi_field">PhormField::$multi_field</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../Fields/PhormField.html#var$valid">PhormField::$valid</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../Fields/PhormField.html#var$validators">PhormField::$validators</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../Fields/PhormField.html#var$value">PhormField::$value</a></span><br>
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">1078</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">author:</span> Jeff Ober</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">DateTimeField</span>
<span class="method-name">
__construct
</span>
(<span class="var-type">string</span> <span class="var-name">$label</span>, [<span class="var-type"></span> <span class="var-name">$validators</span> = <span class="var-default">array()</span>], [<span class="var-type"></span> <span class="var-name">$attributes</span> = <span class="var-default">array()</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$label</span><span class="var-description">: the field's text label</span> </li>
<li>
<span class="var-type">array</span>
<span class="var-name">$validators</span><span class="var-description">: a list of callbacks to validate the field data</span> </li>
<li>
<span class="var-type">array</span>
<span class="var-name">$attributes</span><span class="var-description">: a list of key/value pairs representing HTML attributes</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../Fields/TextField.html#method__construct">TextField::__construct()</a></dt>
</dl>
</div>
<a name="methodimport_value" id="import_value"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">import_value</span> (line <span class="line-number">1104</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Imports the value and returns a unix timestamp (the number of seconds</p>
<p class="description"><p>since the epoch.)</p></p>
<ul class="tags">
<li><span class="field">return:</span> the date/time as a unix timestamp</li>
<li><span class="field">author:</span> Jeff Ober</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">int</span>
<span class="method-name">
import_value
</span>
(<span class="var-type">string</span> <span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../Fields/TextField.html#methodimport_value">TextField::import_value()</a></dt>
<dd>Imports the value by decoding HTML entities.</dd>
</dl>
</div>
<a name="methodvalidate" id="validate"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">validate</span> (line <span class="line-number">1090</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Validates that the value is parsable as a date/time value.</p>
<ul class="tags">
<li><span class="field">author:</span> Jeff Ober</li>
<li><span class="field">throws:</span> ValidationError</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">null</span>
<span class="method-name">
validate
</span>
(<span class="var-type">string</span> <span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../Fields/TextField.html#methodvalidate">TextField::validate()</a></dt>
<dd>Validates that the value is less than $this->max_length;</dd>
</dl>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../Fields/TextField.html">TextField</a></span></p>
<blockquote>
<span class="method-name"><a href="../Fields/TextField.html#method__construct">TextField::__construct()</a></span><br>
<span class="method-name"><a href="../Fields/TextField.html#methodget_widget">TextField::get_widget()</a></span><br>
<span class="method-name"><a href="../Fields/TextField.html#methodimport_value">TextField::import_value()</a></span><br>
<span class="method-name"><a href="../Fields/TextField.html#methodvalidate">TextField::validate()</a></span><br>
</blockquote>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../Fields/PhormField.html">PhormField</a></span></p>
<blockquote>
<span class="method-name"><a href="../Fields/PhormField.html#method__construct">PhormField::__construct()</a></span><br>
<span class="method-name"><a href="../Fields/PhormField.html#methoderrors">PhormField::errors()</a></span><br>
<span class="method-name"><a href="../Fields/PhormField.html#methodget_attribute">PhormField::get_attribute()</a></span><br>
<span class="method-name"><a href="../Fields/PhormField.html#methodget_errors">PhormField::get_errors()</a></span><br>
<span class="method-name"><a href="../Fields/PhormField.html#methodget_value">PhormField::get_value()</a></span><br>
<span class="method-name"><a href="../Fields/PhormField.html#methodget_widget">PhormField::get_widget()</a></span><br>
<span class="method-name"><a href="../Fields/PhormField.html#methodhelp_text">PhormField::help_text()</a></span><br>
<span class="method-name"><a href="../Fields/PhormField.html#methodhtml">PhormField::html()</a></span><br>
<span class="method-name"><a href="../Fields/PhormField.html#methodimport_value">PhormField::import_value()</a></span><br>
<span class="method-name"><a href="../Fields/PhormField.html#methodis_valid">PhormField::is_valid()</a></span><br>
<span class="method-name"><a href="../Fields/PhormField.html#methodlabel">PhormField::label()</a></span><br>
<span class="method-name"><a href="../Fields/PhormField.html#methodprepare_value">PhormField::prepare_value()</a></span><br>
<span class="method-name"><a href="../Fields/PhormField.html#methodset_attribute">PhormField::set_attribute()</a></span><br>
<span class="method-name"><a href="../Fields/PhormField.html#methodset_help_text">PhormField::set_help_text()</a></span><br>
<span class="method-name"><a href="../Fields/PhormField.html#methodset_value">PhormField::set_value()</a></span><br>
<span class="method-name"><a href="../Fields/PhormField.html#methodvalidate">PhormField::validate()</a></span><br>
<span class="method-name"><a href="../Fields/PhormField.html#method__toString">PhormField::__toString()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Mon, 20 Apr 2009 08:29:20 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
</p>
</div></body>
</html>