From 176ec2df0c562bf79c3b072514a2e90db6db0a08 Mon Sep 17 00:00:00 2001 From: mark_story Date: Sat, 12 May 2012 22:25:38 -0400 Subject: [PATCH] Add documentation on additional options. --- lib/Cake/View/Helper/TimeHelper.php | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/lib/Cake/View/Helper/TimeHelper.php b/lib/Cake/View/Helper/TimeHelper.php index 9b642af71..95fc214d2 100644 --- a/lib/Cake/View/Helper/TimeHelper.php +++ b/lib/Cake/View/Helper/TimeHelper.php @@ -343,6 +343,14 @@ class TimeHelper extends AppHelper { /** * @see CakeTime::timeAgoInWords() * + * ## Addition options + * + * - `element` - The element to wrap the formatted time in. + * Has a few additional options: + * - `tag` - The tag to use, defaults to 'span'. + * - `class` - The classname to use, defaults to `time-ago-in-words`. + * - `title` - Defaults to the $dateTime input. + * * @param string $dateTime Datetime string or Unix timestamp * @param array $options Default format if timestamp is used in $dateString * @return string Relative time string.