Dates

Date and time related utility functions.

today

$today = Dates::today();

Returns today’s date as a DateTime object. Source

returns

DateTime

todayAsString

Syntax:

$today = Dates::todayAsString($pattern);

Returns today’s date as string. By default it returns the date in ISO format The output format can be changed by the $pattern parameter Source

$pattern

Date formatting pattern. Optional. The default value is Y-m-d

returns

string

yesterday

Syntax:

$yesterday = Dates::yesterday();

Returns yesterday’s date as a DateTime object. Source

returns

DateTime

yesterdayAsString

Syntax:

$yesterday = Dates::yesterdayAsString($pattern = 'Y-m-d');

Returns yesterday’s date as string. By default it returns the date in ISO format The output format can be changed by the $pattern parameter Source

param $pattern

Date formatting pattern

returns

string

tomorrow

Syntax:

$tomorrow = Dates::tomorrow();

Returns tomorrow’s date as a DateTime object. Source

returns

DateTime

tomorrowAsString

Syntax:

$tomorrow = Dates::tomorrowAsString($pattern = 'Y-m-d')

Returns tomorrow’s date as string. By default it returns the date in ISO format The output format can be changed by the $pattern parameter. Source

param $pattern

Date formatting pattern

returns

string

differenceInDays

Syntax:

$differenceInDay = Dates::differenceInDays(DateTime $startDate, DateTime $endDate);

Returns the difference in days between two dates. Source

type $startDate

DateTime

param $startDate

type $endDate

DateTime

param $endDate

returns

string

differenceInDaysFromString

Syntax:

$differenceInDays = Dates::differenceInDaysFromString(string $startDate, string $endDate);

Returns the difference in days between two dates that are defined as strings. Source

type $startDate

string

param $startDate

type $endDate

string

param $endDate

returns

string

addDaysToDate

Syntax:

$newDate = Dates::addDaysToDate(string $originalDate, int $days);

Adds days to the original date and returns the new date as a DateTime object. Source

type $originalDate

string

param $originalDate

type $days

int

param $days

returns

DateTime

addMinutesToTime

Syntax:

$newTime = Dates::addMinutesToTime(string $originalTime, int $minutes);

Adds minutes to the original time and returns the new time as a DateTime object. Source

type $originalTime

string

param $originalTime

type $minutes

int

param $minutes

returns

DateTime

getLastDayOfMonth

Syntax:

$newTime = Dates::getLastDayOfMonth(string $actualDate);

Returns the last day of the month based on the specified date. Source

type $actualDate

string

param $actualDate

returns

DateTime

timestampToDateTime

Syntax:

$date = Dates::timestampToDateTime(int $timestamp);

Converts the given Unix timestamp to a DateTime object. Source

type $timestamp

int

param $timestamp

returns

DateTime

dateToTimestamp

Syntax:

$timestamp = Dates::dateToTimestamp(string $dateStr);

Returns the Unix timestamp representation of a given date. Source

type $dateStr

string

param $dateStr

returns

int

getTimeDifferenceInMinutes

Syntax:

$diffInMinutes = Dates::getTimeDifferenceInMinutes($startTime, $endTime);

Gets the difference between two date times in minutes. Source

type $startTime

string

param $startTime

type $endTime

string

param $endTime

returns

int

getDayOneWeekFromNow

Syntax:

$day = Dates::getDayOneWeekFromNow();

Returns the date one week from now. Source

returns

DateTime