* The string to parse. Before PHP 5.0.0, microseconds weren't allowed in * the time, since PHP 5.0.0 they are allowed but ignored. *
* @param int|null $baseTimestamp [optional]* Default value: null * The timestamp which is used as a base for the calculation of relative * dates. *
* @return int|false a timestamp on success, false otherwise. Previous to PHP 5.1.0, * this function would return -1 on failure. */ #[Pure(true)] function strtotime(string $datetime, ?int $baseTimestamp): int|false {} /** * Format a local time/date * @link https://php.net/manual/en/function.date.php * @param string $format* The format of the outputted date string. See the formatting * options below. There are also several * predefined date constants * that may be used instead, so for example DATE_RSS * contains the format string 'D, d M Y H:i:s'. *
*
*
* The following characters are recognized in the
* format parameter string:
*
*
format character | *Description | *Example returned values | *
---|---|---|
Day | *--- | *--- | *
d | *Day of the month, 2 digits with leading zeros | *01 to 31 | *
D | *A textual representation of a day, three letters | *Mon through Sun | *
j | *Day of the month without leading zeros | *1 to 31 | *
l (lowercase 'L') | *A full textual representation of the day of the week | *Sunday through Saturday | *
N | *ISO-8601 numeric representation of the day of the week (added in * PHP 5.1.0) | *1 (for Monday) through 7 (for Sunday) | *
S | *English ordinal suffix for the day of the month, 2 characters | ** st, nd, rd or * th. Works well with j * | *
w | *Numeric representation of the day of the week | *0 (for Sunday) through 6 (for Saturday) | *
z | *The day of the year (starting from 0) | *0 through 365 | *
Week | *--- | *--- | *
W | *ISO-8601 week number of year, weeks starting on Monday (added in PHP 4.1.0) | *Example: 42 (the 42nd week in the year) | *
Month | *--- | *--- | *
F | *A full textual representation of a month, such as January or March | *January through December | *
m | *Numeric representation of a month, with leading zeros | *01 through 12 | *
M | *A short textual representation of a month, three letters | *Jan through Dec | *
n | *Numeric representation of a month, without leading zeros | *1 through 12 | *
t | *Number of days in the given month | *28 through 31 | *
Year | *--- | *--- | *
L | *Whether it's a leap year | *1 if it is a leap year, 0 otherwise. | *
o | *ISO-8601 year number. This has the same value as * Y, except that if the ISO week number * (W) belongs to the previous or next year, that year * is used instead. (added in PHP 5.1.0) | *Examples: 1999 or 2003 | *
Y | *A full numeric representation of a year, 4 digits | *Examples: 1999 or 2003 | *
y | *A two digit representation of a year | *Examples: 99 or 03 | *
Time | *--- | *--- | *
a | *Lowercase Ante meridiem and Post meridiem | *am or pm | *
A | *Uppercase Ante meridiem and Post meridiem | *AM or PM | *
B | *Swatch Internet time | *000 through 999 | *
g | *12-hour format of an hour without leading zeros | *1 through 12 | *
G | *24-hour format of an hour without leading zeros | *0 through 23 | *
h | *12-hour format of an hour with leading zeros | *01 through 12 | *
H | *24-hour format of an hour with leading zeros | *00 through 23 | *
i | *Minutes with leading zeros | *00 to 59 | *
s | *Seconds, with leading zeros | *00 through 59 | *
u | *Microseconds (added in PHP 5.2.2) | *Example: 654321 | *
Timezone | *--- | *--- | *
e | *Timezone identifier (added in PHP 5.1.0) | *Examples: UTC, GMT, Atlantic/Azores | *
I (capital i) | *Whether or not the date is in daylight saving time | *1 if Daylight Saving Time, 0 otherwise. | *
O | *Difference to Greenwich time (GMT) in hours | *Example: +0200 | *
P | *Difference to Greenwich time (GMT) with colon between hours and minutes (added in PHP 5.1.3) | *Example: +02:00 | *
T | *Timezone abbreviation | *Examples: EST, MDT ... | *
Z | *Timezone offset in seconds. The offset for timezones west of UTC is always * negative, and for those east of UTC is always positive. | *-43200 through 50400 | *
Full Date/Time | *--- | *--- | *
c | *ISO 8601 date (added in PHP 5) | *2004-02-12T15:19:21+00:00 | *
r | *RFC 2822 formatted date | *Example: Thu, 21 Dec 2000 16:01:07 +0200 | *
U | *Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) | *See also time | *
* Unrecognized characters in the format string will be printed * as-is. The Z format will always return * 0 when using gmdate. *
** Since this function only accepts integer timestamps the * u format character is only useful when using the * date_format function with user based timestamps * created with date_create. *
* @param int|null $timestamp [optional] Default value: time(). The optional timestamp parameter is an integer Unix timestamp * that defaults to the current local time if a timestamp is not given. * @return string|false a formatted date string. If a non-numeric value is used for * timestamp, false is returned and an * E_WARNING level error is emitted. */ #[Pure(true)] #[LanguageLevelTypeAware(["8.0" => "string"], default: "string|false")] function date(string $format, ?int $timestamp) {} /** * Format a local time/date as integer * @link https://php.net/manual/en/function.idate.php * @param string $format*
format character | *Description | *
B | *Swatch Beat/Internet Time | *
d | *Day of the month | *
h | *Hour (12 hour format) | *
H | *Hour (24 hour format) | *
i | *Minutes | *
I (uppercase i) | *returns 1 if DST is activated, * 0 otherwise | *
L (uppercase l) | *returns 1 for leap year, * 0 otherwise | *
m | *Month number | *
s | *Seconds | *
t | *Days in current month | *
U | *Seconds since the Unix Epoch - January 1 1970 00:00:00 UTC - * this is the same as time | *
w | *Day of the week (0 on Sunday) | *
W | *ISO-8601 week number of year, weeks starting on * Monday | *
y | *Year (1 or 2 digits - check note below) | *
Y | *Year (4 digits) | *
z | *Day of the year | *
Z | *Timezone offset in seconds | *
* As idate always returns an integer and * as they can't start with a "0", idate may return * fewer digits than you would expect. See the example below. *
*/ #[Pure(true)] function idate(string $format, ?int $timestamp): int|false {} /** * Format a GMT/UTC date/time * @link https://php.net/manual/en/function.gmdate.php * @param string $format* The format of the outputted date string. See the formatting * options for the date function. *
* @param int|null $timestamp [optional] * @return string|false a formatted date string. If a non-numeric value is used for * timestamp, false is returned and an * E_WARNING level error is emitted. */ #[Pure(true)] #[LanguageLevelTypeAware(["8.0" => "string"], default: "string|false")] function gmdate(string $format, ?int $timestamp) {} /** * Get Unix timestamp for a date * @link https://php.net/manual/en/function.mktime.php * @param int $hour* The number of the hour. *
* @param int|null $minute* The number of the minute. *
* @param int|null $second* The number of seconds past the minute. *
* @param int|null $month* The number of the month. *
* @param int|null $day* The number of the day. *
* @param int|null $year [optional]* The number of the year, may be a two or four digit value, * with values between 0-69 mapping to 2000-2069 and 70-100 to * 1970-2000. On systems where time_t is a 32bit signed integer, as * most common today, the valid range for year * is somewhere between 1901 and 2038. However, before PHP 5.1.0 this * range was limited from 1970 to 2038 on some systems (e.g. Windows). *
* @param int $is_dst [optional]* This parameter can be set to 1 if the time is during daylight savings time (DST), * 0 if it is not, or -1 (the default) if it is unknown whether the time is within * daylight savings time or not. If it's unknown, PHP tries to figure it out itself. * This can cause unexpected (but not incorrect) results. * Some times are invalid if DST is enabled on the system PHP is running on or * is_dst is set to 1. If DST is enabled in e.g. 2:00, all times * between 2:00 and 3:00 are invalid and mktime returns an undefined * (usually negative) value. * Some systems (e.g. Solaris 8) enable DST at midnight so time 0:30 of the day when DST * is enabled is evaluated as 23:30 of the previous day. *
** As of PHP 5.1.0, this parameter became deprecated. As a result, the * new timezone handling features should be used instead. *
** This parameter has been removed in PHP 7.0.0. *
* @return int|false mktime returns the Unix timestamp of the arguments * given. * If the arguments are invalid, the function returns false (before PHP 5.1 * it returned -1). */ #[Pure(true)] function mktime( #[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] int $hour = null, #[PhpStormStubsElementAvailable(from: '8.0')] int $hour, ?int $minute = null, ?int $second = null, ?int $month = null, ?int $day = null, ?int $year = null, #[Deprecated('Use the new timezone handling functions instead', since: '5.3')] #[PhpStormStubsElementAvailable(from: '5.5', to: '5.6')] $is_dst = -1 ): int|false {} /** * Get Unix timestamp for a GMT date * @link https://php.net/manual/en/function.gmmktime.php * @param int $hour* The hour *
* @param int $minute* The minute *
* @param int $second* The second *
* @param int $month* The month *
* @param int $day* The day *
* @param int $year* The year *
* @param int $is_dst* Parameters always represent a GMT date so is_dst * doesn't influence the result. *
* @return int|false a integer Unix timestamp. */ #[Pure(true)] function gmmktime( #[PhpStormStubsElementAvailable(from: '5.3', to: '7.4')] int $hour = null, #[PhpStormStubsElementAvailable(from: '8.0')] int $hour, ?int $minute = null, ?int $second = null, ?int $month = null, ?int $day = null, ?int $year = null, #[PhpStormStubsElementAvailable(from: '5.5', to: '5.6')] $is_dst = null ): int|false {} /** * Validate a Gregorian date * @link https://php.net/manual/en/function.checkdate.php * @param int $month* The month is between 1 and 12 inclusive. *
* @param int $day* The day is within the allowed number of days for the given * month. Leap years * are taken into consideration. *
* @param int $year* The year is between 1 and 32767 inclusive. *
* @return bool true if the date given is valid; otherwise returns false. */ #[Pure(true)] function checkdate(int $month, int $day, int $year): bool {} /** * Format a local time/date according to locale settings * The following characters are recognized in the * format parameter string *format | *Description | *Example returned values | ** Day | *
---|---|---|---|
%a | *An abbreviated textual representation of the day | *Sun through Sat | *|
%A | *A full textual representation of the day | *Sunday through Saturday | *|
%d | *Two-digit day of the month (with leading zeros) | *01 to 31 | *|
%e | *Day of the month, with a space preceding single digits | *1 to 31 | *|
%j | *Day of the year, 3 digits with leading zeros | *001 to 366 | *|
%u | *ISO-8601 numeric representation of the day of the week | *1 (for Monday) though 7 (for Sunday) | *|
%w | *Numeric representation of the day of the week | *0 (for Sunday) through 6 (for Saturday) | *|
Week | *|||
%U | *Week number of the given year, starting with the first * Sunday as the first week | *13 (for the 13th full week of the year) | *|
%V | *ISO-8601:1988 week number of the given year, starting with * the first week of the year with at least 4 weekdays, with Monday * being the start of the week | *01 through 53 (where 53 * accounts for an overlapping week) | *|
%W | *A numeric representation of the week of the year, starting * with the first Monday as the first week | *46 (for the 46th week of the year beginning * with a Monday) | *|
Month | *|||
%b | *Abbreviated month name, based on the locale | *Jan through Dec | *|
%B | *Full month name, based on the locale | *January through December | *|
%h | *Abbreviated month name, based on the locale (an alias of %b) | *Jan through Dec | *|
%m | *Two digit representation of the month | *01 (for January) through 12 (for December) | *|
Year | *|||
%C | *Two digit representation of the century (year divided by 100, truncated to an integer) | *19 for the 20th Century | *|
%g | *Two digit representation of the year going by ISO-8601:1988 standards (see %V) | *Example: 09 for the week of January 6, 2009 | *|
%G | *The full four-digit version of %g | *Example: 2008 for the week of January 3, 2009 | *|
%y | *Two digit representation of the year | *Example: 09 for 2009, 79 for 1979 | *|
%Y | *Four digit representation for the year | *Example: 2038 | *|
Time | *|||
%H | *Two digit representation of the hour in 24-hour format | *00 through 23 | *|
%I | *Two digit representation of the hour in 12-hour format | *01 through 12 | *|
%l (lower-case 'L') | *Hour in 12-hour format, with a space preceding single digits | *1 through 12 | *|
%M | *Two digit representation of the minute | *00 through 59 | *|
%p | *UPPER-CASE 'AM' or 'PM' based on the given time | *Example: AM for 00:31, PM for 22:23 | *|
%P | *lower-case 'am' or 'pm' based on the given time | *Example: am for 00:31, pm for 22:23 | *|
%r | *Same as "%I:%M:%S %p" | *Example: 09:34:17 PM for 21:34:17 | *|
%R | *Same as "%H:%M" | *Example: 00:35 for 12:35 AM, 16:44 for 4:44 PM | *|
%S | *Two digit representation of the second | *00 through 59 | *|
%T | *Same as "%H:%M:%S" | *Example: 21:34:17 for 09:34:17 PM | *|
%X | *Preferred time representation based on locale, without the date | *Example: 03:59:16 or 15:59:16 | *|
%z | *Either the time zone offset from UTC or the abbreviation (depends * on operating system) | *Example: -0500 or EST for Eastern Time | *|
%Z | *The time zone offset/abbreviation option NOT given by %z (depends * on operating system) | *Example: -0500 or EST for Eastern Time | *|
Time and Date Stamps | *|||
%c | *Preferred date and time stamp based on local | *Example: Tue Feb 5 00:45:10 2009 for * February 4, 2009 at 12:45:10 AM | *|
%D | *Same as "%m/%d/%y" | *Example: 02/05/09 for February 5, 2009 | *|
%F | *Same as "%Y-%m-%d" (commonly used in database datestamps) | *Example: 2009-02-05 for February 5, 2009 | *|
%s | *Unix Epoch Time timestamp (same as the time * function) | *Example: 305815200 for September 10, 1979 08:40:00 AM | *|
%x | *Preferred date representation based on locale, without the time | *Example: 02/05/09 for February 5, 2009 | *|
Miscellaneous | *|||
%n | *A newline character ("\n") | *--- | *|
%t | *A Tab character ("\t") | *--- | *|
%% | *A literal percentage character ("%") | *--- | *
* Maximum length of this parameter is 1023 characters. *
* Contrary to ISO-9899:1999, Sun Solaris starts with Sunday as 1. * As a result, %u may not function as described in this manual. * @link https://php.net/manual/en/function.strftime.php * @param string $format * @param int|null $timestamp [optional] defaults to the value of time() * Unix timestamp that defaults to the current local time if a timestamp is not given.. * @return string|false a string formatted according format * using the given timestamp or the current * local time if no timestamp is given. Month and weekday names and * other language-dependent strings respect the current locale set * with setlocale. * @deprecated 8.1 */ #[Deprecated(since: '8.1')] function strftime(string $format, ?int $timestamp): string|false {} /** * Format a GMT/UTC time/date according to locale settings * @link https://php.net/manual/en/function.gmstrftime.php * @param string $format* See description in strftime. *
* @param int|null $timestamp [optional] * @return string|false a string formatted according to the given format string * using the given timestamp or the current * local time if no timestamp is given. Month and weekday names and * other language dependent strings respect the current locale set * with setlocale. * @deprecated 8.1 */ #[Deprecated(since: '8.1')] function gmstrftime(string $format, ?int $timestamp): string|false {} /** * Return current Unix timestamp * @link https://php.net/manual/en/function.time.php * @return intReturns the current time measured in the number of seconds since the Unix Epoch (January 1 1970 00:00:00 GMT).
*/ function time(): int {} /** * Get the local time * @link https://php.net/manual/en/function.localtime.php * @param int|null $timestamp [optional] * @param bool $associative [optional]* If set to false or not supplied then the array is returned as a regular, * numerically indexed array. If the argument is set to true then * localtime returns an associative array containing * all the different elements of the structure returned by the C * function call to localtime. The names of the different keys of * the associative array are as follows: *
* "tm_sec" - seconds * @return array */ #[Pure(true)] #[ArrayShape([ 'tm_sec' => 'int', 'tm_min' => 'int', 'tm_hour' => 'int', 'tm_mday' => 'int', 'tm_mon' => 'int', 'tm_year' => 'int', 'tm_wday' => 'int', 'tm_yday' => 'int', 'tm_isdst' => 'int', ])] function localtime(?int $timestamp, bool $associative = false): array {} /** * Get date/time information * @link https://php.net/manual/en/function.getdate.php * @param int|null $timestamp [optional] * @return array an associative array of information related to * the timestamp. Elements from the returned * associative array are as follows: * **
Key | *Description | *Example returned values | *
"seconds" | *Numeric representation of seconds | *0 to 59 | *
"minutes" | *Numeric representation of minutes | *0 to 59 | *
"hours" | *Numeric representation of hours | *0 to 23 | *
"mday" | *Numeric representation of the day of the month | *1 to 31 | *
"wday" | *Numeric representation of the day of the week | *0 (for Sunday) through 6 (for Saturday) | *
"mon" | *Numeric representation of a month | *1 through 12 | *
"year" | *A full numeric representation of a year, 4 digits | *Examples: 1999 or 2003 | *
"yday" | *Numeric representation of the day of the year | *0 through 365 | *
"weekday" | *A full textual representation of the day of the week | *Sunday through Saturday | *
"month" | *A full textual representation of a month, such as January or March | *January through December | *
0 | ** Seconds since the Unix Epoch, similar to the values returned by * time and used by date. * | ** System Dependent, typically -2147483648 through * 2147483647. * | *
* String in a format accepted by strtotime. *
* @param DateTimeZone|null $timezone [optional]* Time zone of the time. *
* @return DateTime|false DateTime object on success or false on failure. */ #[Pure(true)] function date_create(string $datetime = 'now', ?DateTimeZone $timezone): DateTime|false {} /** * (PHP 5.5)* String in a format accepted by strtotime. *
* @param DateTimeZone|null $timezone [optional]* Time zone of the time. *
* @return DateTimeImmutable|false DateTime object on success or false on failure. */ #[Pure(true)] function date_create_immutable(string $datetime = 'now', ?DateTimeZone $timezone): DateTimeImmutable|false {} /** * Returns new DateTimeImmutable object formatted according to the specified format * @link https://php.net/manual/en/function.date-create-immutable-from-format.php * @param string $format * @param string $datetime * @param DateTimeZone|null $timezone [optional] * @return DateTimeImmutable|false */ #[Pure(true)] function date_create_immutable_from_format(string $format, string $datetime, ?DateTimeZone $timezone): DateTimeImmutable|false {} /** * Alias: * {@see DateTime::createFromFormat} * @link https://php.net/manual/en/function.date-create-from-format.php * @param string $format Format accepted by date(). *If format does not contain the character ! then portions of the generated time which are not specified in format will be set to the current system time.
*If format contains the character !, then portions of the generated time not provided in format, as well as values to the left-hand side of the !, will be set to corresponding values from the Unix epoch.
*The Unix epoch is 1970-01-01 00:00:00 UTC.
* @param string $datetime String representing the time. * @param DateTimeZone|null $timezone [optional] A DateTimeZone object representing the desired time zone. * @return DateTime|falseReturns a new * {@see DateTime} instance or FALSE on failure.
*/ #[Pure(true)] function date_create_from_format(string $format, string $datetime, ?DateTimeZone $timezone): DateTime|false {} /** * Returns associative array with detailed info about given date * @link https://php.net/manual/en/function.date-parse.php * @param string $datetime* Date in format accepted by strtotime. *
* @return array|false array with information about the parsed date * on success or false on failure. */ #[Pure(true)] #[LanguageLevelTypeAware(["8.0" => "array"], default: "array|false")] #[ArrayShape([ "year" => "int", "month" => "int", "day" => "int", "hour" => "int", "minute" => "int", "second" => "int", "fraction" => "double", "is_localtime" => "bool", "zone_type" => "int", "zone" => "int", "is_dst" => "bool", "tz_abbr" => "string", "tz_id" => "string", "relative" => "array", "warning_count" => "int", "warnings" => "array", "error_count" => "int", "errors" => "array" ])] function date_parse(string $datetime): false|array {} /** * Get info about given date formatted according to the specified format * @link https://php.net/manual/en/function.date-parse-from-format.php * @param string $format* Format accepted by date with some extras. *
* @param string $datetime* String representing the date. *
* @return array associative array with detailed info about given date. */ #[Pure(true)] #[ArrayShape([ 'year' => 'int', 'month' => 'int', 'day' => 'int', 'hour' => 'int', 'minute' => 'int', 'second' => 'int', 'fraction' => 'double', 'is_localtime' => 'bool', 'zone_type' => 'int', 'zone' => 'int', 'is_dst' => 'bool', 'tz_abbr' => 'string', 'tz_id' => 'string', 'relative' => 'array', 'warning_count' => 'int', 'warnings' => 'array', 'error_count' => 'int', 'errors' => 'array' ])] function date_parse_from_format(string $format, string $datetime): array {} /** * Returns the warnings and errors * Alias: * {@see DateTime::getLastErrors} * @link https://php.net/manual/en/function.date-get-last-errors.php * @return array|falseReturns array containing info about warnings and errors.
*/ #[ArrayShape(["warning_count" => "int", "warnings" => "string[]", "error_count" => "int", "errors" => "string[]"])] #[Pure(true)] function date_get_last_errors(): array|false {} /** * Alias: * {@see DateTime::format} * @link https://php.net/manual/en/function.date-format.php * @param DateTimeInterface $object * @param string $format * @return string|false formatted date string on success or FALSE on failure. */ #[Pure(true)] #[LanguageLevelTypeAware(["8.0" => "string"], default: "string|false")] function date_format(DateTimeInterface $object, string $format) {} /** * Alter the timestamp of a DateTime object by incrementing or decrementing * in a format accepted by strtotime(). * Alias: * {@see DateTime::modify} * @link https://php.net/manual/en/function.date-modify.php * @param DateTime $object A DateTime object returned by date_create(). The function modifies this object. * @param string $modifier A date/time string. Valid formats are explained in {@link https://secure.php.net/manual/en/datetime.formats.php Date and Time Formats}. * @return DateTime|false Returns the DateTime object for method chaining or FALSE on failure. */ function date_modify(DateTime $object, string $modifier): DateTime|false {} /** * Alias: * {@see DateTime::add} * @link https://php.net/manual/en/function.date-add.php * @param DateTime $objectProcedural style only: A * {@see DateTime} object returned by * {@see date_create()}. The function modifies this object.
* @param DateInterval $intervalA * {@see DateInterval} object
* @return DateTime|falseReturns the * {@see DateTime} object for method chaining or FALSE on failure.
*/ #[LanguageLevelTypeAware(["8.0" => "DateTime"], default: "DateTime|false")] function date_add(DateTime $object, DateInterval $interval) {} /** * Subtracts an amount of days, months, years, hours, minutes and seconds from a datetime object * Alias: * {@see DateTime::sub} * @link https://php.net/manual/en/function.date-sub.php * @param DateTime $object Procedural style only: A * {@see DateTime} object returned by * {@see date_create()}. The function modifies this object. * @param DateInterval $intervalA * {@see DateInterval} object
* @return DateTime|falseReturns the * {@see DateTime} object for method chaining or FALSE on failure.
*/ #[LanguageLevelTypeAware(["8.0" => "DateTime"], default: "DateTime|false")] function date_sub(DateTime $object, DateInterval $interval) {} /** * Alias: * {@see DateTime::getTimezone} * @link https://php.net/manual/en/function.date-timezone-get.php * @param DateTimeInterface $objectProcedural style only: A * {@see DateTime} object * returned by * {@see date_create()}
* @return DateTimeZone|false ** Returns a * {@see DateTimeZone} object on success * or FALSE on failure. *
*/ #[Pure(true)] function date_timezone_get(DateTimeInterface $object): DateTimeZone|false {} /** * Sets the time zone for the datetime object * Alias: * {@see DateTime::setTimezone} * @link https://php.net/manual/en/function.date-timezone-set.php * @param DateTime|DateTimeInterface $objectA * {@see DateTime} object returned by * {@see date_create()}. The function modifies this object.
* @param DateTimeZone $timezoneA * {@see DateTimeZone} object representing the desired time zone.
* @return DateTime|falseReturns the * {@see DateTime} object for method chaining or FALSE on failure.
*/ #[LanguageLevelTypeAware(["8.0" => "DateTime"], default: "DateTime|false")] function date_timezone_set(#[LanguageLevelTypeAware(["8.0" => "DateTime"], default: "DateTimeInterface")] $object, DateTimeZone $timezone) {} /** * Alias: * {@see DateTime::getOffset} * @link https://php.net/manual/en/function.date-offset-get.php * @param DateTimeInterface $objectProcedural style only: A {@see DateTime} object * returned by {@see date_create()}
* @return int|falseReturns the timezone offset in seconds from UTC on success or FALSE on failure.
*/ #[Pure(true)] #[LanguageLevelTypeAware(["8.0" => "int"], default: "int|false")] function date_offset_get(DateTimeInterface $object) {} /** * Returns the difference between two datetime objects * Alias: * {@see DateTime::diff} * @link https://php.net/manual/en/function.date-diff.php * @param DateTimeInterface $baseObject * @param DateTimeInterface $targetObject The date to compare to * @param bool $absolute [optional] Whether to return absolute difference. * @return DateInterval|false The DateInterval object representing the difference between the two dates or FALSE on failure. */ #[Pure(true)] #[LanguageLevelTypeAware(["8.0" => "DateInterval"], default: "DateInterval|false")] function date_diff(DateTimeInterface $baseObject, DateTimeInterface $targetObject, bool $absolute = false) {} /** * Alias: * {@see DateTime::setTime} * @link https://php.net/manual/en/function.date-time-set.php * @param DateTime $object * @param int $hour * @param int $minute * @param int $second [optional] * @param int $microsecond [optional] * @return DateTimeReturns the * {@see DateTime} object for method chaining or FALSE on failure.
*/ function date_time_set( DateTime $object, int $hour, int $minute, int $second = 0, #[PhpStormStubsElementAvailable(from: '7.1')] int $microsecond = 0 ): DateTime {} /** * Alias: * {@see DateTime::setDate} * @link https://php.net/manual/en/function.date-date-set.php * @param DateTime $objectProcedural style only: A {@see DateTime} object * returned by {@see date_create()}. * The function modifies this object.
* @param int $yearYear of the date.
* @param int $monthMonth of the date.
* @param int $dayDay of the date.
* @return DateTime|false ** Returns the * {@see DateTime} object for method chaining or FALSE on failure. *
*/ #[LanguageLevelTypeAware(["8.0" => "DateTime"], default: "DateTime|false")] function date_date_set(DateTime $object, int $year, int $month, int $day): DateTime|false {} /** * Alias: * {@see DateTime::setISODate} * @link https://php.net/manual/en/function.date-isodate-set.php * @param DateTime $object * @param int $yearYear of the date
* @param int $weekWeek of the date.
* @param int $dayOfWeek [optional]Offset from the first day of the week.
* @return DateTime|false
* Returns the {@see DateTime} object for method chaining or FALSE
on failure.
*
Procedural style only: A * {@see DateTime} object returned by * {@see date_create()}. The function modifies this object.
* @param int $timestampUnix timestamp representing the date.
* @return DateTime|false * {@see DateTime} object for call chaining or FALSE on failure */ #[LanguageLevelTypeAware(["8.0" => "DateTime"], default: "DateTime|false")] function date_timestamp_set(DateTime $object, int $timestamp): DateTime|false {} /** * Gets the unix timestamp * Alias: * {@see DateTime::getTimestamp} * @link https://php.net/manual/en/function.date-timestamp-get.php * @param DateTimeInterface $object * @return intReturns the Unix timestamp representing the date.
*/ #[Pure(true)] function date_timestamp_get(DateTimeInterface $object): int {} /** * Returns new DateTimeZone object * @link https://php.net/manual/en/function.timezone-open.php * @param string $timezone* Time zone identifier as full name (e.g. Europe/Prague) or abbreviation * (e.g. CET). *
* @return DateTimeZone|false DateTimeZone object on success or false on failure. */ #[Pure(true)] function timezone_open(string $timezone): DateTimeZone|false {} /** * Alias: * {@see DateTimeZone::getName} * @link https://php.net/manual/en/function.timezone-name-get.php * @param DateTimeZone $objectThe * {@see DateTimeZone} for which to get a name.
* @return string One of the timezone names in the list of timezones. */ #[Pure] function timezone_name_get(DateTimeZone $object): string {} /** * Returns the timezone name from abbreviation * @link https://php.net/manual/en/function.timezone-name-from-abbr.php * @param string $abbr* Time zone abbreviation. *
* @param int $utcOffset [optional]* Offset from GMT in seconds. Defaults to -1 which means that first found * time zone corresponding to abbr is returned. * Otherwise exact offset is searched and only if not found then the first * time zone with any offset is returned. *
* @param int $isDST [optional]* Daylight saving time indicator. If abbr doesn't * exist then the time zone is searched solely by * offset and isdst. *
* @return string|false time zone name on success or false on failure. * @since 5.1.3 */ #[Pure(true)] function timezone_name_from_abbr(string $abbr, int $utcOffset = -1, int $isDST = -1): string|false {} /** * Alias: * {@link DateTimeZone::getOffset} * @link https://php.net/manual/en/function.timezone-offset-get.php * @param DateTimeZone $objectProcedural style only: A * {@see DateTimeZone} object * returned by * {@see timezone_open()}
* @param DateTimeInterface $datetimeDateTime that contains the date/time to compute the offset from.
* @return int|falseReturns time zone offset in seconds on success or FALSE on failure.
*/ #[Pure(true)] #[LanguageLevelTypeAware(["8.0" => "int"], default: "int|false")] function timezone_offset_get(DateTimeZone $object, DateTimeInterface $datetime) {} /** * Returns all transitions for the timezone * Alias: * {@see DateTimeZone::getTransitions} * @link https://php.net/manual/en/function.timezone-transitions-get.php * @param DateTimeZone $objectProcedural style only: A * {@see DateTimeZone} object returned by * {@see timezone_open()}
* @param int $timestampBegin [optional]Begin timestamp
* @param int $timestampEnd [optional]End timestamp
* @return array|falseReturns numerically indexed array containing associative array with all transitions on success or FALSE on failure.
*/ #[Pure(true)] function timezone_transitions_get(DateTimeZone $object, int $timestampBegin, int $timestampEnd): array|false {} /** * Alias: * {@see DateTimeZone::getLocation} * @link https://php.net/manual/en/function.timezone-location-get.php * @param DateTimeZone $objectProcedural style only: A {@see DateTimeZone} object returned by {@see timezone_open()}
* @return array|falseArray containing location information about timezone.
*/ #[Pure(true)] #[ArrayShape([ 'country_code' => 'string', 'latitude' => 'double', 'longitude' => 'double', 'comments' => 'string', ])] function timezone_location_get(DateTimeZone $object): array|false {} /** * Returns a numerically indexed array containing all defined timezone identifiers * Alias: * {@see DateTimeZone::listIdentifiers()} * @link https://php.net/manual/en/function.timezone-identifiers-list.php * @param int $timezoneGroup [optional] One of DateTimeZone class constants. * @param string|null $countryCode [optional] A two-letter ISO 3166-1 compatible country code. * Note: This option is only used when $timezoneGroup is set to DateTimeZone::PER_COUNTRY. * @return array|false Returns array on success or FALSE on failure. */ #[Pure(true)] #[LanguageLevelTypeAware(["8.0" => "array"], default: "array|false")] function timezone_identifiers_list(int $timezoneGroup = DateTimeZone::ALL, ?string $countryCode) {} /** * Returns associative array containing dst, offset and the timezone name * Alias: * {@see DateTimeZone::listAbbreviations} * @link https://php.net/manual/en/function.timezone-abbreviations-list.php * @return arrayA date with relative parts. Specifically, the relative formats supported by the parser used for * {@see strtotime()} and * {@see DateTime} will be used to construct the * {@see DateInterval}.
* @return DateInterval|false *Returns a new DateInterval instance.
*/ #[Pure(true)] function date_interval_create_from_date_string(string $datetime): DateInterval|false {} /** * Alias: * {@see DateInterval::format} * @link https://php.net/manual/en/function.date-interval-format.php * @param DateInterval $object * @param string $format * @return string */ #[Pure(true)] function date_interval_format(DateInterval $object, string $format): string {} /** * Sets the default timezone used by all date/time functions in a script * @link https://php.net/manual/en/function.date-default-timezone-set.php * @param string $timezoneId* The timezone identifier, like UTC or * Europe/Lisbon. The list of valid identifiers is * available in the . *
* @return bool This function returns false if the * timezone_identifier isn't valid, or true * otherwise. */ function date_default_timezone_set(string $timezoneId): bool {} /** * Gets the default timezone used by all date/time functions in a script * @link https://php.net/manual/en/function.date-default-timezone-get.php * @return string a string. */ #[Pure] function date_default_timezone_get(): string {} /** * Returns time of sunrise for a given day and location * @link https://php.net/manual/en/function.date-sunrise.php * @param int $timestamp* The timestamp of the day from which the sunrise * time is taken. *
* @param int $returnFormat [optional]*
constant | *description | *example | *
SUNFUNCS_RET_STRING | *returns the result as string | *16:46 | *
SUNFUNCS_RET_DOUBLE | *returns the result as float | *16.78243132 | *
SUNFUNCS_RET_TIMESTAMP | *returns the result as integer (timestamp) | *1095034606 | *
* Defaults to North, pass in a negative value for South. * See also: date.default_latitude *
* @param float|null $longitude [optional]* Defaults to East, pass in a negative value for West. * See also: date.default_longitude *
* @param float|null $zenith [optional]* Default: date.sunrise_zenith *
* @param float|null $utcOffset [optional] * @return string|int|float|false the sunrise time in a specified format on * success or false on failure. * @deprecated in 8.1. Use {@link date_sun_info} instead */ #[Pure(true)] #[Deprecated(reason: 'in 8.1. Use date_sun_info instead', since: '8.1')] function date_sunrise(int $timestamp, int $returnFormat = SUNFUNCS_RET_STRING, ?float $latitude, ?float $longitude, ?float $zenith, ?float $utcOffset): string|int|float|false {} /** * Returns time of sunset for a given day and location * @link https://php.net/manual/en/function.date-sunset.php * @param int $timestamp* The timestamp of the day from which the sunset * time is taken. *
* @param int $returnFormat [optional]*
constant | *description | *example | *
SUNFUNCS_RET_STRING | *returns the result as string | *16:46 | *
SUNFUNCS_RET_DOUBLE | *returns the result as float | *16.78243132 | *
SUNFUNCS_RET_TIMESTAMP | *returns the result as integer (timestamp) | *1095034606 | *
* Defaults to North, pass in a negative value for South. * See also: date.default_latitude *
* @param float|null $longitude [optional]* Defaults to East, pass in a negative value for West. * See also: date.default_longitude *
* @param float|null $zenith [optional]* Default: date.sunset_zenith *
* @param float|null $utcOffset [optional] * @return string|int|float|false the sunset time in a specified format on * success or false on failure. * @deprecated in 8.1. Use {@link date_sun_info} instead */ #[Pure(true)] #[Deprecated(reason: 'in 8.1. Use date_sun_info instead', since: '8.1')] function date_sunset(int $timestamp, int $returnFormat = SUNFUNCS_RET_STRING, ?float $latitude, ?float $longitude, ?float $zenith, ?float $utcOffset): string|int|float|false {} /** * Returns an array with information about sunset/sunrise and twilight begin/end * @link https://php.net/manual/en/function.date-sun-info.php * @param int $timestamp* Timestamp. *
* @param float $latitude* Latitude in degrees. *
* @param float $longitude* Longitude in degrees. *
* @return array{ * sunrise: int|bool, * sunset: int|bool, * transit: int|bool, * civil_twilight_begin: int|bool, * civil_twilight_end: int|bool, * nautical_twilight_begin: int|bool, * nautical_twilight_end: int|bool, * astronomical_twilight_begin: int|bool, * astronomical_twilight_end: int|bool, * }|false Returns array on success orfalse
on failure. The structure of the array is detailed in the following list:
* sunrise | The timestamp of the sunrise (zenith angle = 90°35'). |
sunset | The timestamp of the sunset (zenith angle = 90°35'). |
transit | The timestamp when the sun is at its zenith, i.e. has reached its topmost point. |
civil_twilight_begin | The start of the civil dawn (zenith angle = 96°). It ends at sunrise . |
civil_twilight_end | The end of the civil dusk (zenith angle = 96°). It starts at sunset . |
nautical_twilight_begin | The start of the nautical dawn (zenith angle = 102°). It ends at civil_twilight_begin . |
nautical_twilight_end | The end of the nautical dusk (zenith angle = 102°). It starts at civil_twilight_end . |
astronomical_twilight_begin | The start of the astronomical dawn (zenith angle = 108°). It ends at nautical_twilight_begin . |
astronomical_twilight_end | The end of the astronomical dusk (zenith angle = 108°). It starts at nautical_twilight_end . |
false
if the
* sun is below the respective zenith for the whole day, or true
if the sun is
* above the respective zenith for the whole day.
* @since 5.1.2
*/
#[Pure(true)]
#[LanguageLevelTypeAware(["8.0" => "array"], default: "array|false")]
#[ArrayShape([
"sunrise" => "int",
"sunset" => "int",
"transit" => "int",
"civil_twilight_begin" => "int",
"civil_twilight_end" => "int",
"nautical_twilight_begin" => "int",
"nautical_twilight_end" => "int",
"astronomical_twilight_begin" => "int",
"astronomical_twilight_end" => "int"
])]
function date_sun_info(int $timestamp, float $latitude, float $longitude): array|false {}
// End of date v.5.3.2-0.dotdeb.1