summaryrefslogtreecommitdiffstats
path: root/user_guide
diff options
context:
space:
mode:
authorKyle Farris <kylefarris@gmail.com>2011-08-22 04:21:25 +0200
committerKyle Farris <kylefarris@gmail.com>2011-08-22 04:21:25 +0200
commit37e5ff65b2bd1601daadac40fdfce80fd8956fd7 (patch)
tree2c1888a41236c81821284223ccd21be18dd07a6a /user_guide
parentd9c3a6f20e858b22ababbb2a3f3209eca1e93c13 (diff)
Added documentation for the nice_date function in the date_helper.
Diffstat (limited to 'user_guide')
-rw-r--r--user_guide/helpers/date_helper.html14
1 files changed, 14 insertions, 0 deletions
diff --git a/user_guide/helpers/date_helper.html b/user_guide/helpers/date_helper.html
index f930ea3ae..29e242696 100644
--- a/user_guide/helpers/date_helper.html
+++ b/user_guide/helpers/date_helper.html
@@ -234,6 +234,20 @@ $unix = human_to_unix($human);</code>
+<h2>nice_date()</h2>
+
+<p>This function can take a number poorly-formed date formats and convert them into something useful. It also accepts well-formed dates.</p>
+<p>The fuction will return a Unix timestamp by default. You can, optionally, pass a format string (the same type as the PHP date function accepts) as the second parameter. Example:</p>
+
+<code>$bad_time = 199605<br />
+<br />
+// Should Produce: 1996-05-01<br />
+$better_time = nice_date($bad_time,'Y-m-d');<br />
+<br />
+$bad_time = 9-11-2001<br />
+// Should Produce: 2001-09-11<br />
+$better_time = nice_date($human,'Y-m-d');</code>
+
<h2>timespan()</h2>