cakephp-1.3 > TimeHelper :: timeAgoInWords()
A AclBase AclBehavior AclComponent AclNode AclShell Aco AcoAction AjaxHelper ApcEngine ApiShell App AppController AppController AppHelper AppHelper AppModel AppModel Aro AuthComponent B BakeShell BakeTask BehaviorCollection C Cache CacheEngine CacheHelper CakeErrorController CakeLog CakeRoute CakeSchema CakeSession CakeSocket ClassRegistry Component Configure ConnectionManager ConsoleShell ContainableBehavior Controller ControllerTask CookieComponent D DataSource DbAcl DbAclSchema DbConfigTask DboMssql DboMysql DboMysqlBase DboMysqli DboOracle DboPostgres DboSource DboSqlite Debugger Dispatcher E EmailComponent ErrorHandler ErrorHandler ExtractTask F File FileEngine FileLog FixtureTask Folder FormHelper H Helper HtmlHelper HttpSocket I I18n I18nModel i18nSchema I18nShell Inflector IniAcl J JavascriptHelper JqueryEngineHelper JsBaseEngineHelper JsHelper L L10n M MagicDb MagicFileResource MediaView MemcacheEngine Model ModelBehavior ModelTask MootoolsEngineHelper Multibyte N NumberHelper O Object Overloadable Overloadable Overloadable2 Overloadable2 P PagesController PagesController PaginatorHelper Permission PluginShortRoute PluginTask ProjectTask PrototypeEngineHelper R RequestHandlerComponent Router RssHelper S Sanitize Scaffold ScaffoldView SchemaShell Security SecurityComponent SessionComponent SessionHelper SessionsSchema Set Shell ShellDispatcher String T TemplateTask TestSuiteShell TestTask TextHelper ThemeView TimeHelper TranslateBehavior TreeBehavior V Validation View ViewTask X XcacheEngine Xml XmlElement XmlHelper XmlManager XmlNode XmlTextNode

timeAgoInWords

line:486 at /cake/libs/view/helpers/time.php
Returns either a relative date or a formatted date depending on the difference between the current time and given datetime. $datetime should be in a <i>strtotime</i> - parsable format, like MySQL's datetime datatype.

Method

(string) timeAgoInWords ($dateTime, $options = array())

Parameters

ParameterTypeCommentDefault
$dateTime ? string required Datetime string or Unix timestamp
$options array optional Default format if timestamp is used in $dateString array()

Return

string

Comment

Returns either a relative date or a formatted date depending
on the difference between the current time and given datetime.
$datetime should be in a <i>strtotime</i> - parsable format, like MySQL's datetime datatype.

### Options:

- `format` => a fall back format if the relative time is longer than the duration specified by end
- `end` => The end of relative time telling
- `userOffset` => Users offset from GMT (in hours)

Relative dates look something like this:
3 weeks, 4 days ago
15 seconds ago

Default date formatting is d/m/yy e.g: on 18/2/09

The returned string includes 'ago' or 'on' and assumes you'll properly add a word
like 'Posted ' before the function output.

@param string $dateString Datetime string or Unix timestamp
@param array $options Default format if timestamp is used in $dateString
@return string Relative time string.
@access public
@link http://book.cakephp.org/view/1471/Formatting