Add documentation on additional options.

cakephp · May 13, 2012 · 176ec2d · 176ec2d
1 parent 683146d
commit 176ec2d
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/lib/Cake/View/Helper/TimeHelper.php b/lib/Cake/View/Helper/TimeHelper.php
@@ -343,6 +343,14 @@ public function toRSS($dateString, $timezone = null) {
 /**
  * @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.