Class Date

__construct( $time = self::DATE_NOW,  $referencial_timezone = \Timezone::USER_TIMEZONE) 

Builds and initializes a date.

The first parameter is the date in a standardized format defined in the PHP documentation. To get the current date, use the Date::DATE_NOW The second parameter allows us to chose what time referential we use to create the date:

• Timezone::SERVER_TIMEZONE if that date comes from for example the database (dates must be stored under this referential).
• Timezone::SITE_TIMEZONE if it's an entry coming from the site (nearly never used).
• Timezone::USER_TIMEZONE if it's an entry coming from the user (it's own timezone will be used)

format(integer $format = self::FORMAT_DAY_MONTH, integer $referencial_timezone = \Timezone::USER_TIMEZONE) : string

Formats the date to a particular format.

The formatted date

get_date_relative(integer $timestamp, integer $referencial_timezone) : string

Returns the relative time associated to the date

The relative time

get_timestamp() : integer

Returns the timestamp associated to the date

The timestamp

get_date_time() : \DateTime

Returns DateTime

get_year( $timezone = \Timezone::USER_TIMEZONE) : string

Returns the year of the date

The year

get_month( $timezone = \Timezone::USER_TIMEZONE) : string

Returns the month of the date

The month

get_month_text( $characters_number = '',  $timezone = \Timezone::USER_TIMEZONE) : string

Returns first charaters (all per default) of the month name

The first letters of the month name

get_week_number( $referential_timezone = \Timezone::USER_TIMEZONE) : string

Returns the week number of the date

The week number

get_day( $timezone = \Timezone::USER_TIMEZONE) : string

Returns the day of the date

The day

get_day_text( $characters_number = '',  $timezone = \Timezone::USER_TIMEZONE) : string

Returns first charaters (all per default) of the day of week name

The first letters of the day name

get_day_of_week( $timezone = \Timezone::USER_TIMEZONE) : string

Returns the day of the week (0 for sunday to 6 for saturday)

The day of the year

get_day_of_year( $timezone = \Timezone::USER_TIMEZONE) : string

Returns the day of the year

The day of the year

get_hours( $timezone = \Timezone::USER_TIMEZONE) : string

Returns the hours of the date

The hours

get_minutes() : string

Returns the minutes of the date

The minutes

get_seconds() : string

Returns the seconds of the date

The seconds

to_date() : string

Exports the date according to the format YYYY-mm-dd

The formatted date

is_anterior_to(\Date $date) : boolean

Tells whether this date is anterior to the given one

is_posterior_to(\Date $date) : boolean

Tells whether this date is posterior to the given one

equals(\Date $date) : boolean

Tells whether this date equals the given one

true if the two dates are the same, false otherwise

add_days(integer $number_days) 

Adds the given number of days to the date

add_weeks(integer $number_weeks) 

Adds the given number of weeks to the date

is_date_year_bissextile() : boolean

Tells whether the year of the date is bissextile

true if the year is bissextile, false otherwise

get_array_tpl_vars(\Date $date, string $date_label) : array<mixed,string>

Calculates and return date formats to use many variables in the TPL.

true if the date is correct and false otherwise.

check_date(integer $month, integer $day, integer $year) : boolean

Determines whether a date is correct. For example the february 31st is not correct.

true if the date is correct and false otherwise.

compute_server_user_difference( $referencial_timezone = \Timezone::SERVER_TIMEZONE) : integer

Computes the time difference between the server and the current user

The time difference (in hours)