CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.0 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.0
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • I18n
    • Log
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View
      • Exception
      • Form
      • Helper
      • Widget

Class TimeHelper

Time Helper class for easy use of time data.

Manipulation of time data.

Namespace: Cake\View\Helper
See: \Cake\I18n\Time
Link: http://book.cakephp.org/3.0/en/views/helpers/time.html

Property Summary

  • $_View protected
    Cake\View\View

    The View instance this helper is attached to

  • $_config protected
    array

    Runtime config

  • $_configInitialized protected
    bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array

    Default config for this helper.

  • $_helperMap protected
    array

    A helper lookup table used to lazy load helper objects.

  • $_templater protected
    Cake\View\StringTemplate

    StringTemplate instance.

  • $fieldset public
    array

    Holds the fields ['field_name' => ['type' => 'string', 'length' => 100]], primaryKey and validates ['field_name']

  • $helpers public
    array

    List of helpers used by this helper

  • $plugin public
    string

    Plugin path

  • $request public
    Cake\Network\Request

    Request object

  • $tags public
    array

    Holds tag templates.

  • $theme public
    string

    The current theme name if any.

Method Summary

  • __call() public

    Provide non fatal errors on missing method calls.

  • __construct() public

    Default Constructor

  • __debugInfo() public

    Returns an array that can be used to describe the internal state of this object.

  • __get() public

    Lazy loads helpers.

  • _configDelete() protected

    Delete a single config key

  • _configRead() protected

    Read a config variable

  • _configWrite() protected

    Write a config variable

  • _confirm() protected

    Returns a string to be used as onclick handler for confirm dialogs.

  • addClass() public

    Adds the given class to the element options

  • config() public

    Usage

  • configShallow() public

    Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

  • format() public

    Returns a formatted date string, given either a Time instance, UNIX timestamp or a valid strtotime() date string.

  • formatTemplate() public

    Format a template string with $data

  • fromString() public

    Returns a UNIX timestamp, given either a UNIX timestamp or a valid strtotime() date string.

  • gmt() public

    Returns gmt as a UNIX timestamp.

  • i18nFormat() public

    Returns a formatted date string, given either a Datetime instance, UNIX timestamp or a valid strtotime() date string.

  • implementedEvents() public

    Event listeners.

  • isFuture() public

    Returns true if given datetime string is in the future.

  • isPast() public

    Returns true if given datetime string is in the past.

  • isThisMonth() public

    Returns true if given datetime string is within this month

  • isThisWeek() public

    Returns true if given datetime string is within this week.

  • isThisYear() public

    Returns true if given datetime string is within the current year.

  • isToday() public

    Returns true if given datetime string is today.

  • isTomorrow() public

    Returns true if given datetime string is tomorrow.

  • isWithinNext() public

    Returns true if specified datetime is within the interval specified, else false.

  • nice() public

    Returns a nicely formatted date string for given Datetime string.

  • templater() public

    templater

  • templates() public

    Get/set templates to use.

  • timeAgoInWords() public

    Formats a date into a phrase expressing the relative time.

  • toAtom() public

    Returns a date formatted for Atom RSS feeds.

  • toQuarter() public

    Returns the quarter

  • toRss() public

    Formats date for RSS feeds

  • toUnix() public

    Returns a UNIX timestamp from a textual datetime description.

  • wasWithinLast() public

    Returns true if specified datetime was within the interval specified, else false.

  • wasYesterday() public

    Returns true if given datetime string was yesterday.

Method Detail

__call() ¶ public

__call(string $method, array $params): void

Provide non fatal errors on missing method calls.

Parameters
string $method

Method to invoke

array $params

Array of params for the method.

Returns
void

__construct() ¶ public

__construct(Cake\View\View $View, array $config = [])

Default Constructor

Parameters
Cake\View\View $View

The View this helper is being attached to.

array $config optional

Configuration settings for the helper.

__debugInfo() ¶ public

__debugInfo(): array

Returns an array that can be used to describe the internal state of this object.

Returns
array

__get() ¶ public

__get(string $name): Cake\View\Helper|void

Lazy loads helpers.

Parameters
string $name

Name of the property being accessed.

Returns
Cake\View\Helper|void

_configDelete() ¶ protected

_configDelete(string $key): void

Delete a single config key

Parameters
string $key

Key to delete.

Returns
void
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead() ¶ protected

_configRead(string|null $key): mixed

Read a config variable

Parameters
string|null $key

Key to read.

Returns
mixed

_configWrite() ¶ protected

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

Write a config variable

Parameters
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.

Returns
void
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config

_confirm() ¶ protected

_confirm(string $message, string $okCode, string $cancelCode = '', array $options = []): string

Returns a string to be used as onclick handler for confirm dialogs.

Parameters
string $message

Message to be displayed

string $okCode

Code to be executed after user chose 'OK'

string $cancelCode optional

Code to be executed after user chose 'Cancel'

array $options optional

Array of options

Returns
string

addClass() ¶ public

addClass(array $options = [], string $class = null, string $key = 'class'): array

Adds the given class to the element options

Parameters
array $options optional

Array options/attributes to add a class to

string $class optional

The class name being added.

string $key optional

the key to use for class.

Returns
array

config() ¶ public

config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixed

Usage

Reading the whole config:

$this->config();

Reading a specific value:

$this->config('key');

Reading a nested value:

$this->config('some.nested.key');

Setting a specific value:

$this->config('key', $value);

Setting a nested value:

$this->config('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->config(['one' => 'value', 'another' => 'value']);
Parameters
string|array|null $key optional

The key to get/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.

Returns
mixed
Throws
Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow() ¶ public

configShallow(string|array $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->config('key', $value);

Setting a nested value:

$this->config('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->config(['one' => 'value', 'another' => 'value']);
Parameters
string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional

The value to set.

Returns
$this

format() ¶ public

format(int|string|DateTime $date, int|string|null $format = null, bool|string $invalid = false, string|DateTimeZone|null $timezone = null): string

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().

Parameters
int|string|DateTime $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)

bool|string $invalid optional

Default value to display on invalid dates

string|DateTimeZone|null $timezone optional

User's timezone string or DateTimeZone object

Returns
string
See Also
\Cake\I18n\Time::i18nFormat()

formatTemplate() ¶ public

formatTemplate(string $name, array $data): string

Format a template string with $data

Parameters
string $name

The template name.

array $data

The data to insert.

Returns
string

fromString() ¶ public

fromString(int|string|DateTime $dateString, string|DateTimeZone|null $timezone = null): Cake\I18n\Time

Returns a UNIX timestamp, given either a UNIX timestamp or a valid strtotime() date string.

Parameters
int|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone|null $timezone optional

User's timezone string or DateTimeZone object

Returns
Cake\I18n\Time

gmt() ¶ public

gmt(int|string|DateTime|null $string = null): int

Returns gmt as a UNIX timestamp.

Parameters
int|string|DateTime|null $string optional

UNIX timestamp, strtotime() valid string or DateTime object

Returns
int
See Also
\Cake\I18n\Time::gmt()

i18nFormat() ¶ public

i18nFormat(int|string|DateTime $date, string|null $format = null, bool|string $invalid = false, string|DateTimeZone|null $timezone = null): string

Returns a formatted date string, given either a Datetime instance, UNIX timestamp or a valid strtotime() date string.

Parameters
int|string|DateTime $date

UNIX timestamp, strtotime() valid string or DateTime object

string|null $format optional

Intl compatible format string.

bool|string $invalid optional

Default value to display on invalid dates

string|DateTimeZone|null $timezone optional

User's timezone string or DateTimeZone object

Returns
string
Throws
InvalidArgumentException
When the date cannot be parsed
See Also
\Cake\I18n\Time::i18nFormat()

implementedEvents() ¶ public

implementedEvents(): array

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.

Returns
array

isFuture() ¶ public

isFuture(int|string|DateTime $dateString, string|DateTimeZone|null $timezone = null): bool

Returns true if given datetime string is in the future.

Parameters
int|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone|null $timezone optional

User's timezone string or DateTimeZone object

Returns
bool

isPast() ¶ public

isPast(int|string|DateTime $dateString, string|DateTimeZone|null $timezone = null): bool

Returns true if given datetime string is in the past.

Parameters
int|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone|null $timezone optional

User's timezone string or DateTimeZone object

Returns
bool

isThisMonth() ¶ public

isThisMonth(int|string|DateTime $dateString, string|DateTimeZone|null $timezone = null): bool

Returns true if given datetime string is within this month

Parameters
int|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone|null $timezone optional

User's timezone string or DateTimeZone object

Returns
bool

isThisWeek() ¶ public

isThisWeek(int|string|DateTime $dateString, string|DateTimeZone|null $timezone = null): bool

Returns true if given datetime string is within this week.

Parameters
int|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone|null $timezone optional

User's timezone string or DateTimeZone object

Returns
bool

isThisYear() ¶ public

isThisYear(int|string|DateTime $dateString, string|DateTimeZone|null $timezone = null): bool

Returns true if given datetime string is within the current year.

Parameters
int|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone|null $timezone optional

User's timezone string or DateTimeZone object

Returns
bool

isToday() ¶ public

isToday(int|string|DateTime $dateString, string|DateTimeZone|null $timezone = null): bool

Returns true if given datetime string is today.

Parameters
int|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone|null $timezone optional

User's timezone string or DateTimeZone object

Returns
bool

isTomorrow() ¶ public

isTomorrow(int|string|DateTime $dateString, string|DateTimeZone|null $timezone = null): bool

Returns true if given datetime string is tomorrow.

Parameters
int|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone|null $timezone optional

User's timezone string or DateTimeZone object

Returns
bool

isWithinNext() ¶ public

isWithinNext(string|int $timeInterval, int|string|DateTime $dateString, string|DateTimeZone|null $timezone = null): bool

Returns true if specified datetime is within the interval specified, else false.

Parameters
string|int $timeInterval

the numeric value with space then time type. Example of valid types: 6 hours, 2 days, 1 minute.

int|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone|null $timezone optional

User's timezone string or DateTimeZone object

Returns
bool
See Also
\Cake\I18n\Time::wasWithinLast()

nice() ¶ public

nice(int|string|DateTime|null $dateString = null, string|DateTimeZone|null $timezone = null, string|null $locale = null): string

Returns a nicely formatted date string for given Datetime string.

Parameters
int|string|DateTime|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.

Returns
string

templater() ¶ public

templater(): Cake\View\StringTemplate

templater

Returns
Cake\View\StringTemplate

templates() ¶ public

templates(string|null|array $templates = null): $this|string|array

Get/set templates to use.

Parameters
string|null|array $templates optional

null or string allow reading templates. An array allows templates to be added.

Returns
$this|string|array

timeAgoInWords() ¶ public

timeAgoInWords(int|string|DateTime $dateTime, array $options = []): string

Formats a date into a phrase expressing the relative time.

Additional 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 class name to use, defaults to time-ago-in-words.
    • title - Defaults to the $dateTime input.
Parameters
int|string|DateTime $dateTime

UNIX timestamp, strtotime() valid string or DateTime object

array $options optional

Default format if timestamp is used in $dateString

Returns
string
See Also
\Cake\I18n\Time::timeAgoInWords()

toAtom() ¶ public

toAtom(int|string|DateTime $dateString, string|DateTimeZone|null $timezone = null): string

Returns a date formatted for Atom RSS feeds.

Parameters
int|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone|null $timezone optional

User's timezone string or DateTimeZone object

Returns
string
See Also
\Cake\I18n\Time::toAtom()

toQuarter() ¶ public

toQuarter(int|string|DateTime $dateString, bool $range = false): mixed

Returns the quarter

Parameters
int|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

bool $range optional

if true returns a range in Y-m-d format

Returns
mixed
See Also
\Cake\I18n\Time::toQuarter()

toRss() ¶ public

toRss(int|string|DateTime $dateString, string|DateTimeZone|null $timezone = null): string

Formats date for RSS feeds

Parameters
int|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone|null $timezone optional

User's timezone string or DateTimeZone object

Returns
string

toUnix() ¶ public

toUnix(int|string|DateTime $dateString, string|DateTimeZone|null $timezone = null): int

Returns a UNIX timestamp from a textual datetime description.

Parameters
int|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone|null $timezone optional

User's timezone string or DateTimeZone object

Returns
int
See Also
\Cake\I18n\Time::toUnix()

wasWithinLast() ¶ public

wasWithinLast(string|int $timeInterval, int|string|DateTime $dateString, string|DateTimeZone|null $timezone = null): bool

Returns true if specified datetime was within the interval specified, else false.

Parameters
string|int $timeInterval

the numeric value with space then time type. Example of valid types: 6 hours, 2 days, 1 minute.

int|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone|null $timezone optional

User's timezone string or DateTimeZone object

Returns
bool
See Also
\Cake\I18n\Time::wasWithinLast()

wasYesterday() ¶ public

wasYesterday(int|string|DateTime $dateString, string|DateTimeZone|null $timezone = null): bool

Returns true if given datetime string was yesterday.

Parameters
int|string|DateTime $dateString

UNIX timestamp, strtotime() valid string or DateTime object

string|DateTimeZone|null $timezone optional

User's timezone string or DateTimeZone object

Returns
bool

Property Detail

$_View ¶ protected

The View instance this helper is attached to

Type
Cake\View\View

$_config ¶ protected

Runtime config

Type
array

$_configInitialized ¶ protected

Whether the config property has already been configured with defaults

Type
bool

$_defaultConfig ¶ protected

Default config for this helper.

Type
array

$_helperMap ¶ protected

A helper lookup table used to lazy load helper objects.

Type
array

$_templater ¶ protected

StringTemplate instance.

Type
Cake\View\StringTemplate

$fieldset ¶ public

Holds the fields ['field_name' => ['type' => 'string', 'length' => 100]], primaryKey and validates ['field_name']

Type
array

$helpers ¶ public

List of helpers used by this helper

Type
array

$plugin ¶ public

Plugin path

Type
string

$request ¶ public

Request object

Type
Cake\Network\Request

$tags ¶ public

Holds tag templates.

Type
array

$theme ¶ public

The current theme name if any.

Type
string
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs