DateTimeHelper

Type
Class
Namespace
craft\helpers
Inherits
craft\helpers\DateTimeHelper
Since
3.0.0

Class DateTimeHelper

View source

Public Methods

MethodDescription
currentTimeStamp()
currentUTCDateTime()
humanDurationFromInterval()Returns the interval in a human-friendly string.
intervalToSeconds()Returns the number of seconds that a given DateInterval object spans.
isInThePast()Returns true if the specified date was in the past, otherwise false.
isIso8601()Determines whether the given value is an ISO-8601-formatted date, as formatted by either DateTime::ATOM or DateTime::ISO8601 (with or without the colon between the hours and minutes of the timezone).
isThisMonth()Returns true if given date is in this month
isThisWeek()Returns true if given date is in this week
isThisYear()Returns true if given date is in this year
isToday()Returns true if given date is today.
isValidIntervalString()Returns true if interval string is a valid interval.
isValidTimeStamp()
isWithinLast()Returns true if specified datetime was within the interval specified, else false.
isYesterday()Returns true if given date was yesterday
normalizeTimeZone()Normalizes a timezone string to a PHP timezone identifier.
secondsToHumanTimeDuration()
secondsToInterval()Creates a DateInterval object based on a given number of seconds.
timeZoneAbbreviation()Returns the timezone abbreviation for a given timezone name.
timeZoneOffset()Returns a given timezone’s offset from UTC (e.g. '+10:00' or '-06:00').
toDateTime()Converts a value into a DateTime object.
toIso8601()Converts a date to an ISO-8601 string.
translateDate()Translates the words in a formatted date string to the application’s language.

currentTimeStamp()

View source

Returns

integer

currentUTCDateTime()

View source

Returns

DateTime

humanDurationFromInterval()

Returns the interval in a human-friendly string.

View source

Arguments

Returns

string

intervalToSeconds()

Returns the number of seconds that a given DateInterval object spans.

View source

Arguments

Returns

integer

isInThePast()

Returns true if the specified date was in the past, otherwise false.

View source

Arguments

  • $date (mixed) – The timestamp to check

Returns

boolean – True if the specified date was in the past, false otherwise.

isIso8601()

Determines whether the given value is an ISO-8601-formatted date, as formatted by either DateTime::ATOM or DateTime::ISO8601 (with or without the colon between the hours and minutes of the timezone).

View source

Arguments

  • $value (mixed) – The timestamp to check

Returns

boolean – Whether the value is an ISO-8601 date string

isThisMonth()

Returns true if given date is in this month

View source

Arguments

  • $date (mixed) – The timestamp to check

Returns

boolean – True if date is in this month, false otherwise.

isThisWeek()

Returns true if given date is in this week

View source

Arguments

  • $date (mixed) – The timestamp to check

Returns

boolean – True if date is in this week, false otherwise.

isThisYear()

Returns true if given date is in this year

View source

Arguments

  • $date (mixed) – The timestamp to check

Returns

boolean – True if date is in this year, false otherwise.

isToday()

Returns true if given date is today.

View source

Arguments

  • $date (mixed) – The timestamp to check

Returns

boolean – True if date is today, false otherwise.

isValidIntervalString()

Returns true if interval string is a valid interval.

View source

Arguments

Returns

boolean

isValidTimeStamp()

View source

Arguments

Returns

boolean

isWithinLast()

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

View source

Arguments

  • $date (mixed) – The timestamp to check
  • $timeInterval (mixed) – The numeric value with space then time type. Example of valid types: '6 hours', '2 days', '1 minute'.

Returns

boolean – Whether the $dateString was within the specified $timeInterval.

isYesterday()

Returns true if given date was yesterday

View source

Arguments

  • $date (mixed) – The timestamp to check

Returns

boolean – True if date was yesterday, false otherwise.

normalizeTimeZone()

Normalizes a timezone string to a PHP timezone identifier. Supports the following formats:

  • Time zone abbreviation (EST, MDT)
  • Difference to Greenwich time (GMT) in hours, with/without a colon between the hours and minutes (+0200, -0200, +02:00, -02:00)
  • A PHP timezone identifier (UTC, GMT, Atlantic/Azores)

View source

Arguments

  • $timeZone (string) – The timezone to be normalized

Returns

string, false – The PHP timezone identifier, or false if it could not be determined

secondsToHumanTimeDuration()

View source

Arguments

  • $seconds (integer) – The number of seconds
  • $showSeconds (boolean) – Whether to output seconds or not

Returns

string

secondsToInterval()

Creates a DateInterval object based on a given number of seconds.

View source

Arguments

Returns

DateInterval

timeZoneAbbreviation()

Returns the timezone abbreviation for a given timezone name.

View source

Arguments

Returns

string

timeZoneOffset()

Returns a given timezone’s offset from UTC (e.g. '+10:00' or '-06:00').

View source

Arguments

Returns

string

toDateTime()

Converts a value into a DateTime object. $value can be in the following formats:

  • All W3C date and time formats (http://www.w3.org/TR/NOTE-datetime)
  • MySQL DATE and DATETIME formats (http://dev.mysql.com/doc/refman/5.1/en/datetime.html)
  • Relaxed versions of W3C and MySQL formats (single-digit months, days, and hours)
  • Unix timestamps
  • An array with at least one of these keys defined: datetime, date, or time. Supported keys include:
    • date – a date string in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS.MU formats or the current locale’s short date format
    • time – a time string in HH:MM (24-hour) format or the current locale’s short time format
    • datetime – A timestamp in any of the non-array formats supported by this method
    • timezone – A valid PHP timezone. If set, this will override the assumed timezone per $assumeSystemTimeZone.

View source

Arguments

  • $value (string, integer, array, null) – The value that should be converted to a DateTime object.
  • $assumeSystemTimeZone (boolean) – Whether it should be assumed that the value was set in the system timezone if the timezone was not specified. If this is false, UTC will be assumed.
  • $setToSystemTimeZone (boolean) – Whether to set the resulting DateTime object to the system timezone.

Returns

DateTime, false – The DateTime object, or false if $object could not be converted to one

Throws

toIso8601()

Converts a date to an ISO-8601 string.

View source

Arguments

  • $date (mixed) – The date, in any format that toDateTime() supports.

Returns

string, false – The date formatted as an ISO-8601 string, or false if $date was not a valid date

translateDate()

DEPRECATED

Deprecated in 3.0.6. Use \craft\helpers\craft\i18n\Formatter::asDate() instead.

Translates the words in a formatted date string to the application’s language.

View source

Arguments

Returns

string – The translated date string

Constants

ConstantDescription
SECONDS_DAY
SECONDS_HOUR
SECONDS_MINUTE
SECONDS_MONTH
SECONDS_YEAR