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<string, mixed>
Runtime config
bool
Whether the config property has already been configured with defaults
array<string, mixed>
Config options
array<string, array>
A helper lookup table used to lazy load helper objects.
Cake\View\StringTemplate|null
StringTemplate instance.
array
List of helpers used by this helper
Provide non fatal errors on missing method calls.
Default Constructor
Returns an array that can be used to describe the internal state of this object.
Lazy loads helpers.
Deletes a single config key.
Reads a config key.
Writes a config key.
Returns a string to be used as onclick handler for confirm dialogs.
Get a timezone.
Adds the given class to the element options
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.
Formats a template string with $data
Returns a UNIX timestamp, given either a UNIX timestamp or a valid strtotime() date string.
Returns the config.
Returns the config for this specific key.
Gets templates to use or a specific template.
Get the view instance this helper is bound to.
Returns gmt as a UNIX timestamp.
Returns a formatted date string, given either a Datetime instance, UNIX timestamp or a valid strtotime() date string.
Event listeners.
Constructor hook method.
Returns true, if the given datetime string is in the future.
Returns true, if the given datetime string is in the past.
Returns true if given datetime string is within this month
Returns true if given datetime string is within this week.
Returns true if given datetime string is within the current year.
Returns true, if the given datetime string is today.
Returns true if given datetime string is tomorrow.
Returns true if specified datetime is within the interval specified, else false.
Returns a nicely formatted date string for given Datetime string.
Sets the config.
Sets templates to use.
Returns the templater instance.
Formats a date into a phrase expressing the relative time.
Returns a date formatted for Atom RSS feeds.
Returns the quarter
Formats date for RSS feeds
Returns a UNIX timestamp from a textual datetime description.
Returns true if specified datetime was within the interval specified, else false.
Returns true if given datetime string was yesterday.
__call(string $method, array $params): mixed|void
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<string, mixed> $config = [])
Default Constructor
Cake\View\View
$view The View this helper is being attached to.
array<string, mixed>
$config optional Configuration settings for the helper.
__debugInfo(): array<string, mixed>
Returns an array that can be used to describe the internal state of this object.
array<string, mixed>
__get(string $name): Cake\View\Helper|null|void
Lazy loads helpers.
string
$name Name of the property being accessed.
Cake\View\Helper|null|void
_configDelete(string $key): void
Deletes a single config key.
string
$key Key to delete.
void
Cake\Core\Exception\CakeException
_configRead(string|null $key): mixed
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
array<string, mixed>|string
$key Key to write to.
mixed
$value Value to write.
string|bool
$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
void
Cake\Core\Exception\CakeException
_confirm(string $okCode, string $cancelCode): string
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
_getTimezone(DateTimeZone|string|null $timezone): DateTimeZone|string|null
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
addClass(array<string, mixed> $options, string $class, string $key = 'class'): array<string, mixed>
Adds the given class to the element options
array<string, mixed>
$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<string, mixed>
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this
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']);
array<string, mixed>|string
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
format(DateTimeInterface|string|int|null $date, string|int|null $format = null, string|false $invalid = false, DateTimeZone|string|null $timezone = null): string|int|false
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().
DateTimeInterface|string|int|null
$date UNIX timestamp, strtotime() valid string or DateTime object (or a date format string).
string|int|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
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
string|int|false
formatTemplate(string $name, array<string, mixed> $data): string
Formats a template string with $data
string
$name The template name.
array<string, mixed>
$data The data to insert.
string
fromString(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): Cake\I18n\FrozenTime
Returns a UNIX timestamp, given either a UNIX timestamp or a valid strtotime() date string.
DateTimeInterface|string|int
$dateString UNIX timestamp, strtotime() valid string or DateTime object
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
Cake\I18n\FrozenTime
getConfig(string|null $key = null, mixed $default = null): mixed
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
getConfigOrFail(string $key): mixed
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
InvalidArgumentException
getTemplates(string|null $template = null): array|string
Gets templates to use or a specific template.
string|null
$template optional String for reading a specific template, null for all.
array|string
getView(): Cake\View\View
Get the view instance this helper is bound to.
Cake\View\View
gmt(DateTimeInterface|string|int|null $string = null): string
Returns gmt as a UNIX timestamp.
DateTimeInterface|string|int|null
$string optional UNIX timestamp, strtotime() valid string or DateTime object
string
i18nFormat(DateTimeInterface|string|int|null $date, string|int|null $format = null, string|false $invalid = false, DateTimeZone|string|null $timezone = null): string|int|false
Returns a formatted date string, given either a Datetime instance, UNIX timestamp or a valid strtotime() date string.
DateTimeInterface|string|int|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
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
string|int|false
Exception
implementedEvents(): array<string, mixed>
Event listeners.
By defining one of the callback methods a helper is assumed to be interested in the related event.
Override this method if you need to add non-conventional event listeners. Or if you want helpers to listen to non-standard events.
array<string, mixed>
initialize(array<string, mixed> $config): void
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
array<string, mixed>
$config The configuration settings provided to this helper.
void
isFuture(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool
Returns true, if the given datetime string is in the future.
DateTimeInterface|string|int
$dateString UNIX timestamp, strtotime() valid string or DateTime object
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
bool
isPast(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool
Returns true, if the given datetime string is in the past.
DateTimeInterface|string|int
$dateString UNIX timestamp, strtotime() valid string or DateTime object
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
bool
isThisMonth(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool
Returns true if given datetime string is within this month
DateTimeInterface|string|int
$dateString UNIX timestamp, strtotime() valid string or DateTime object
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
bool
isThisWeek(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool
Returns true if given datetime string is within this week.
DateTimeInterface|string|int
$dateString UNIX timestamp, strtotime() valid string or DateTime object
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
bool
isThisYear(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool
Returns true if given datetime string is within the current year.
DateTimeInterface|string|int
$dateString UNIX timestamp, strtotime() valid string or DateTime object
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
bool
isToday(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool
Returns true, if the given datetime string is today.
DateTimeInterface|string|int
$dateString UNIX timestamp, strtotime() valid string or DateTime object
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
bool
isTomorrow(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool
Returns true if given datetime string is tomorrow.
DateTimeInterface|string|int
$dateString UNIX timestamp, strtotime() valid string or DateTime object
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
bool
isWithinNext(string $timeInterval, DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool
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.
DateTimeInterface|string|int
$dateString UNIX timestamp, strtotime() valid string or DateTime object
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
bool
nice(DateTimeInterface|string|int|null $dateString = null, DateTimeZone|string|null $timezone = null, string|null $locale = null): string
Returns a nicely formatted date string for given Datetime string.
DateTimeInterface|string|int|null
$dateString optional UNIX timestamp, strtotime() valid string or DateTime object
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
string|null
$locale optional Locale string.
string
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
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']);
array<string, mixed>|string
$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\CakeException
setTemplates(array<string> $templates): $this
Sets templates to use.
array<string>
$templates Templates to be added.
$this
templater(): Cake\View\StringTemplate
Returns the templater instance.
Cake\View\StringTemplate
timeAgoInWords(DateTimeInterface|string|int $dateTime, array<string, mixed> $options = []): string
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.DateTimeInterface|string|int
$dateTime UNIX timestamp, strtotime() valid string or DateTime object.
array<string, mixed>
$options optional Default format if timestamp is used in $dateString
string
toAtom(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): string
Returns a date formatted for Atom RSS feeds.
DateTimeInterface|string|int
$dateString UNIX timestamp, strtotime() valid string or DateTime object
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
string
toQuarter(DateTimeInterface|string|int $dateString, bool $range = false): array<string>|int
Returns the quarter
DateTimeInterface|string|int
$dateString UNIX timestamp, strtotime() valid string or DateTime object
bool
$range optional if true returns a range in Y-m-d format
array<string>|int
toRss(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): string
Formats date for RSS feeds
DateTimeInterface|string|int
$dateString UNIX timestamp, strtotime() valid string or DateTime object
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
string
toUnix(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): string
Returns a UNIX timestamp from a textual datetime description.
DateTimeInterface|string|int
$dateString UNIX timestamp, strtotime() valid string or DateTime object
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
string
wasWithinLast(string $timeInterval, DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool
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.
DateTimeInterface|string|int
$dateString UNIX timestamp, strtotime() valid string or DateTime object
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
bool
wasYesterday(DateTimeInterface|string|int $dateString, DateTimeZone|string|null $timezone = null): bool
Returns true if given datetime string was yesterday.
DateTimeInterface|string|int
$dateString UNIX timestamp, strtotime() valid string or DateTime object
DateTimeZone|string|null
$timezone optional User's timezone string or DateTimeZone object
bool
The View instance this helper is attached to
Cake\View\View
Runtime config
array<string, mixed>
Whether the config property has already been configured with defaults
bool
Config options
array<string, mixed>
A helper lookup table used to lazy load helper objects.
array<string, array>
StringTemplate instance.
Cake\View\StringTemplate|null
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.4/class-Cake.View.Helper.TimeHelper.html