Time Helper class for easy use of time data.
Manipulation of time data.
\Cake\View\View
The View instance this helper is attached to
array
Runtime config
bool
Whether the config property has already been configured with defaults
array
Config options
array
A helper lookup table used to lazy load helper objects.
\Cake\View\StringTemplate
StringTemplate instance.
array
List of helpers used by this helper
Returns an array that can be used to describe the internal state of this object.
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Returns a formatted date string, given either a Time instance, UNIX timestamp or a valid strtotime() date string.
Returns a UNIX timestamp, given either a UNIX timestamp or a valid strtotime() date string.
Returns a formatted date string, given either a Datetime instance, UNIX timestamp or a valid strtotime() date string.
Returns true if specified datetime is within the interval specified, else false.
Returns true if specified datetime was within the interval specified, else false.
__call(string $method, array $params)
Provide non fatal errors on missing method calls.
string
$method Method to invoke
array
$params Array of params for the method.
mixed|void
__construct(\Cake\View\View $view, array $config)
Default Constructor
\Cake\View\View
$view The View this helper is being attached to.
array
$config optional Configuration settings for the helper.
__debugInfo()
Returns an array that can be used to describe the internal state of this object.
array
__get(string $name)
Lazy loads helpers.
string
$name Name of the property being accessed.
\Cake\View\Helper|null|void
Helper instance if helper with provided name exists
_configDelete(string $key)
Deletes a single config key.
string
$key Key to delete.
Cake\Core\Exception\Exception
_configRead(?string $key)
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
string|array
$key Key to write to.
mixed
$value Value to write.
bool|string
$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exception
_confirm(string $okCode, string $cancelCode)
Returns a string to be used as onclick handler for confirm dialogs.
string
$okCode Code to be executed after user chose 'OK'
string
$cancelCode Code to be executed after user chose 'Cancel'
string
"onclick" JS code
_getTimezone(mixed $timezone)
Get a timezone.
Will use the provided timezone, or default output timezone if defined.
\DateTimeZone|string|null
$timezone The override timezone if applicable.
\DateTimeZone|string|null
The chosen timezone or null.
addClass(array $options, string $class, string $key)
Adds the given class to the element options
array
$options Array options/attributes to add a class to
string
$class The class name being added.
string
$key optional the key to use for class. Defaults to 'class'
.
array
Array of options with $key set.
configShallow(mixed $key, mixed $value)
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->configShallow('key', $value);
Setting a nested value:
$this->configShallow('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
format(mixed $date, mixed $format, mixed $invalid, mixed $timezone)
Returns a formatted date string, given either a Time instance, UNIX timestamp or a valid strtotime() date string.
This method is an alias for TimeHelper::i18nFormat().
int|string|\DateTimeInterface
$date UNIX timestamp, strtotime() valid string or DateTime object (or a date format string).
int|string|null
$format optional date format string (or a UNIX timestamp, strtotime() valid string or DateTime object).
string|false
$invalid optional Default value to display on invalid dates
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
string|int|false
Formatted and translated date string
formatTemplate(string $name, array $data)
Formats a template string with $data
string
$name The template name.
array
$data The data to insert.
string
fromString(mixed $dateString, mixed $timezone)
Returns a UNIX timestamp, given either a UNIX timestamp or a valid strtotime() date string.
int|string|\DateTimeInterface
$dateString UNIX timestamp, strtotime() valid string or DateTime object
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
\Cake\I18n\Time
getConfig(?string $key, mixed $default)
Returns the config.
Reading the whole config:
$this->getConfig();
Reading a specific value:
$this->getConfig('key');
Reading a nested value:
$this->getConfig('some.nested.key');
Reading with default value:
$this->getConfig('some-key', 'default-value');
string|null
$key optional The key to get or null for the whole config.
mixed
$default optional The return value when the key does not exist.
mixed
Configuration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string
$key The key to get.
mixed
Configuration data at the named key
InvalidArgumentException
getTemplates(?string $template)
Gets templates to use or a specific template.
string|null
$template optional String for reading a specific template, null for all.
string|array
getView()
Get the view instance this helper is bound to.
\Cake\View\View
The bound view instance.
gmt(mixed $string)
Returns gmt as a UNIX timestamp.
int|string|\DateTimeInterface|null
$string optional UNIX timestamp, strtotime() valid string or DateTime object
string
UNIX timestamp
i18nFormat(mixed $date, mixed $format, mixed $invalid, mixed $timezone)
Returns a formatted date string, given either a Datetime instance, UNIX timestamp or a valid strtotime() date string.
int|string|\DateTimeInterface|null
$date UNIX timestamp, strtotime() valid string or DateTime object
string|int|null
$format optional Intl compatible format string.
string|false
$invalid optional Default value to display on invalid dates
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
string|int|false
Formatted and translated date string or value for $invalid
on failure.
Exception
implementedEvents()
Event listeners.
array
initialize(array $config)
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
array
$config The configuration settings provided to this helper.
isFuture(mixed $dateString, mixed $timezone)
Returns true, if the given datetime string is in the future.
int|string|\DateTimeInterface
$dateString UNIX timestamp, strtotime() valid string or DateTime object
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
bool
True if the given datetime string lies in the future.
isPast(mixed $dateString, mixed $timezone)
Returns true, if the given datetime string is in the past.
int|string|\DateTimeInterface
$dateString UNIX timestamp, strtotime() valid string or DateTime object
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
bool
True if the given datetime string lies in the past.
isThisMonth(mixed $dateString, mixed $timezone)
Returns true if given datetime string is within this month
int|string|\DateTimeInterface
$dateString UNIX timestamp, strtotime() valid string or DateTime object
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
bool
True if datetime string is within the current month
isThisWeek(mixed $dateString, mixed $timezone)
Returns true if given datetime string is within this week.
int|string|\DateTimeInterface
$dateString UNIX timestamp, strtotime() valid string or DateTime object
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
bool
True if datetime string is within current week
isThisYear(mixed $dateString, mixed $timezone)
Returns true if given datetime string is within the current year.
int|string|\DateTimeInterface
$dateString UNIX timestamp, strtotime() valid string or DateTime object
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
bool
True if datetime string is within current year
isToday(mixed $dateString, mixed $timezone)
Returns true, if the given datetime string is today.
int|string|\DateTimeInterface
$dateString UNIX timestamp, strtotime() valid string or DateTime object
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
bool
True if the given datetime string is today.
isTomorrow(mixed $dateString, mixed $timezone)
Returns true if given datetime string is tomorrow.
int|string|\DateTimeInterface
$dateString UNIX timestamp, strtotime() valid string or DateTime object
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
bool
True if datetime string was yesterday
isWithinNext(string $timeInterval, mixed $dateString, mixed $timezone)
Returns true if specified datetime is within the interval specified, else false.
string
$timeInterval the numeric value with space then time type. Example of valid types: 6 hours, 2 days, 1 minute.
int|string|\DateTimeInterface
$dateString UNIX timestamp, strtotime() valid string or DateTime object
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
bool
nice(mixed $dateString, mixed $timezone, ?string $locale)
Returns a nicely formatted date string for given Datetime string.
int|string|\DateTimeInterface|null
$dateString optional UNIX timestamp, strtotime() valid string or DateTime object
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
string|null
$locale optional Locale string.
string
Formatted date string
setConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
Setting a specific value:
$this->setConfig('key', $value);
Setting a nested value:
$this->setConfig('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
bool
$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
$this
Cake\Core\Exception\Exception
setTemplates(array $templates)
Sets templates to use.
string[]
$templates Templates to be added.
$this
templater()
Returns the templater instance.
\Cake\View\StringTemplate
timeAgoInWords(mixed $dateTime, array $options)
Formats a date into a phrase expressing the relative time.
element
- The element to wrap the formatted time in. Has a few additional options: tag
- The tag to use, defaults to 'span'.class
- The class name to use, defaults to time-ago-in-words
.title
- Defaults to the $dateTime input.int|string|\DateTimeInterface
$dateTime UNIX timestamp, strtotime() valid string or DateTime object.
array
$options optional Default format if timestamp is used in $dateString
string
Relative time string.
toAtom(mixed $dateString, mixed $timezone)
Returns a date formatted for Atom RSS feeds.
int|string|\DateTimeInterface
$dateString UNIX timestamp, strtotime() valid string or DateTime object
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
string
Formatted date string
toQuarter(mixed $dateString, mixed $range)
Returns the quarter
int|string|\DateTimeInterface
$dateString UNIX timestamp, strtotime() valid string or DateTime object
bool
$range optional if true returns a range in Y-m-d format
string[]|int
1, 2, 3, or 4 quarter of year or array if $range true
toRss(mixed $dateString, mixed $timezone)
Formats date for RSS feeds
int|string|\DateTimeInterface
$dateString UNIX timestamp, strtotime() valid string or DateTime object
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
string
Formatted date string
toUnix(mixed $dateString, mixed $timezone)
Returns a UNIX timestamp from a textual datetime description.
int|string|\DateTimeInterface
$dateString UNIX timestamp, strtotime() valid string or DateTime object
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
string
UNIX timestamp
wasWithinLast(string $timeInterval, mixed $dateString, mixed $timezone)
Returns true if specified datetime was within the interval specified, else false.
string
$timeInterval the numeric value with space then time type. Example of valid types: 6 hours, 2 days, 1 minute.
int|string|\DateTimeInterface
$dateString UNIX timestamp, strtotime() valid string or DateTime object
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
bool
wasYesterday(mixed $dateString, mixed $timezone)
Returns true if given datetime string was yesterday.
int|string|\DateTimeInterface
$dateString UNIX timestamp, strtotime() valid string or DateTime object
string|\DateTimeZone|null
$timezone optional User's timezone string or DateTimeZone object
bool
True if datetime string was yesterday
The View instance this helper is attached to
\Cake\View\View
Runtime config
array
Whether the config property has already been configured with defaults
bool
Config options
array
A helper lookup table used to lazy load helper objects.
array
StringTemplate instance.
\Cake\View\StringTemplate
List of helpers used by this helper
array
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.View.Helper.TimeHelper.html