cakephp-1.3 > TimeHelper :: format()
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

format

line:722 at /cake/libs/view/helpers/time.php
Returns a formatted date string, given either a UNIX timestamp or a valid strtotime() date string. This function also accepts a time string and a format string as first and second parameters. In that case this function behaves as a wrapper for TimeHelper::i18nFormat()

Method

(string) format ($format, $date = null, $invalid = false, $userOffset = null)

Parameters

ParameterTypeCommentDefault
$format string required date format string (or a DateTime string)
$date ? string optional Datetime string (or a date format string) null
$invalid boolean optional flag to ignore results of fromString == false false
$userOffset int optional User's offset from GMT (in hours) null

Return

string

Comment

Returns a formatted date string, given either a UNIX timestamp or a valid strtotime() date string.
This function also accepts a time string and a format string as first and second parameters.
In that case this function behaves as a wrapper for TimeHelper::i18nFormat()

@param string $format date format string (or a DateTime string)
@param string $dateString Datetime string (or a date format string)
@param boolean $invalid flag to ignore results of fromString == false
@param int $userOffset User's offset from GMT (in hours)
@return string Formatted date string
@access public