path: root/ext/date/php_date.stub.php

<?php

/** @generate-function-entries */

function strtotime(string $datetime, ?int $baseTimestamp = null): int|false {}

function date(string $format, ?int $timestamp = null): string {}

function idate(string $format, ?int $timestamp = null): int|false {}

function gmdate(string $format, ?int $timestamp = null): string {}

function mktime(
    int $hour, ?int $minute = null, ?int $second = null,
    ?int $month = null, ?int $day = null, ?int $year = null): int|false {}

function gmmktime(
    int $hour, ?int $minute = null, ?int $second = null,
    ?int $month = null, ?int $day = null, ?int $year = null): int|false {}

function checkdate(int $month, int $day, int $year): bool {}

function strftime(string $format, ?int $timestamp = null): string|false {}

function gmstrftime(string $format, ?int $timestamp = null): string|false {}

function time(): int {}

function localtime(?int $timestamp = null, bool $associative = false): array {}

function getdate(?int $timestamp = null): array {}

function date_create(string $datetime = "now", ?DateTimeZone $timezone = null): DateTime|false {}

function date_create_immutable(
    string $datetime = "now", ?DateTimeZone $timezone = null): DateTimeImmutable|false {}

function date_create_from_format(
    string $format, string $datetime, ?DateTimeZone $timezone = null): DateTime|false {}

function date_create_immutable_from_format(
    string $format, string $datetime, ?DateTimeZone $timezone = null): DateTimeImmutable|false {}

function date_parse(string $datetime): array {}

function date_parse_from_format(string $format, string $datetime): array {}

function date_get_last_errors(): array|false {}

function date_format(DateTimeInterface $object, string $format): string {}

function date_modify(DateTime $object, string $modifier): DateTime|false {}

function date_add(DateTime $object, DateInterval $interval): DateTime {}

function date_sub(DateTime $object, DateInterval $interval): DateTime {}

function date_timezone_get(DateTimeInterface $object): DateTimeZone|false {}

function date_timezone_set(DateTime $object, DateTimeZone $timezone): DateTime {}

function date_offset_get(DateTimeInterface $object): int {}

function date_diff(
    DateTimeInterface $baseObject, DateTimeInterface $targetObject, bool $absolute = false): DateInterval {}

function date_time_set(
    DateTime $object, int $hour, int $minute, int $second = 0, int $microsecond = 0): DateTime {}

function date_date_set(DateTime $object, int $year, int $month, int $day): DateTime {}

function date_isodate_set(DateTime $object, int $year, int $week, int $dayOfWeek = 1): DateTime {}

function date_timestamp_set(DateTime $object, int $timestamp): DateTime {}

function date_timestamp_get(DateTimeInterface $object): int {}

function timezone_open(string $timezone): DateTimeZone|false {}

function timezone_name_get(DateTimeZone $object): string {}

function timezone_name_from_abbr(string $abbr, int $utcOffset = -1, int $isDST = -1): string|false {}

function timezone_offset_get(DateTimeZone $object, DateTimeInterface $datetime): int {}

function timezone_transitions_get(
    DateTimeZone $object, int $timestampBegin = PHP_INT_MIN, int $timestampEnd = PHP_INT_MAX): array|false {}

function timezone_location_get(DateTimeZone $object): array|false {}

function timezone_identifiers_list(int $timezoneGroup = DateTimeZone::ALL, ?string $countryCode = null): array {}

function timezone_abbreviations_list(): array {}

function timezone_version_get(): string {}

function date_interval_create_from_date_string(string $datetime): DateInterval|false {}

function date_interval_format(DateInterval $object, string $format): string {}

function date_default_timezone_set(string $timezoneId): bool {}

function date_default_timezone_get(): string {}

function date_sunrise(
    int $timestamp, int $returnFormat = SUNFUNCS_RET_STRING,
    ?float $latitude = null, ?float $longitude = null, ?float $zenith = null,
    ?float $utcOffset = null): string|int|float|false {}

function date_sunset(
    int $timestamp, int $returnFormat = SUNFUNCS_RET_STRING,
    ?float $latitude = null, ?float $longitude = null, ?float $zenith = null,
    ?float $utcOffset = null): string|int|float|false {}

function date_sun_info(int $timestamp, float $latitude, float $longitude): array {}

// NB: Adding return types to methods is a BC break!
// For now only using @return annotations here.

interface DateTimeInterface
{
    /** @return string */
    public function format(string $format);

    /** @return DateTimeZone|false */
    public function getTimezone();

    /** @return int */
    public function getOffset();

    /** @return int|false */
    public function getTimestamp();

    /** @return DateInterval|false */
    public function diff(DateTimeInterface $targetObject, bool $absolute = false);

    /** @return void */
    public function __wakeup();
}

class DateTime implements DateTimeInterface
{
    public function __construct(string $datetime = "now", ?DateTimeZone $timezone = null) {}

    /** @return void */
    public function __wakeup() {}

    /** @return DateTime */
    public static function __set_state(array $array) {}

    /** @return DateTime */
    public static function createFromImmutable(DateTimeImmutable $object) {}

    public static function createFromInterface(DateTimeInterface $object): DateTime {}

    /**
     * @return DateTime|false
     * @alias date_create_from_format
     */
    public static function createFromFormat(string $format, string $datetime, ?DateTimeZone $timezone = null) {}

    /**
     * @return array|false
     * @alias date_get_last_errors
     */
    public static function getLastErrors() {}

    /**
     * @return string
     * @alias date_format
     */
    public function format(string $format) {}

    /**
     * @return DateTime|false
     * @alias date_modify
     */
    public function modify(string $modifier) {}

    /**
     * @return DateTime
     * @alias date_add
     */
    public function add(DateInterval $interval) {}

    /**
     * @return DateTime
     * @alias date_sub
     */
    public function sub(DateInterval $interval) {}

    /**
     * @return DateTimeZone|false
     * @alias date_timezone_get
     */
    public function getTimezone() {}

    /**
     * @return DateTime
     * @alias date_timezone_set
     */
    public function setTimezone(DateTimeZone $timezone) {}

    /**
     * @return int
     * @alias date_offset_get
     */
    public function getOffset() {}

    /**
     * @return DateTime
     * @alias date_time_set
     */
    public function setTime(int $hour, int $minute, int $second = 0, int $microsecond = 0) {}

    /**
     * @return DateTime
     * @alias date_date_set
     */
    public function setDate(int $year, int $month, int $day) {}

    /**
     * @return DateTime
     * @alias date_isodate_set
     */
    public function setISODate(int $year, int $week, int $dayOfWeek = 1) {}

    /**
     * @return DateTime
     * @alias date_timestamp_set
     */
    public function setTimestamp(int $timestamp) {}

    /**
     * @return int
     * @alias date_timestamp_get
     */
    public function getTimestamp() {}

    /**
     * @return DateInterval
     * @alias date_diff
     */
    public function diff(DateTimeInterface $targetObject, bool $absolute = false) {}
}

class DateTimeImmutable implements DateTimeInterface
{
    public function __construct(string $datetime = "now", ?DateTimeZone $timezone = null) {}

    /** @return void */
    public function __wakeup() {}

    /** @return DateTimeImmutable */
    public static function __set_state(array $array) {}

    /**
     * @return DateTimeImmutable|false
     * @alias date_create_immutable_from_format
     */
    public static function createFromFormat(string $format, string $datetime, ?DateTimeZone $timezone = null) {}

    /**
     * @return array|false
     * @alias date_get_last_errors
     */
    public static function getLastErrors() {}

    /**
     * @return string
     * @alias date_format
     */
    public function format(string $format) {}

    /**
     * @return DateTimeZone|false
     * @alias date_timezone_get
     */
    public function getTimezone() {}

    /**
     * @return int
     * @alias date_offset_get
     */
    public function getOffset() {}

    /**
     * @return int
     * @alias date_timestamp_get
     */
    public function getTimestamp() {}

    /**
     * @return DateInterval
     * @alias date_diff
     */
    public function diff(DateTimeInterface $targetObject, bool $absolute = false) {}

    /** @return DateTimeImmutable|false */
    public function modify(string $modifier) {}

    /** @return DateTimeImmutable */
    public function add(DateInterval $interval) {}

    /** @return DateTimeImmutable */
    public function sub(DateInterval $interval) {}

    /** @return DateTimeImmutable */
    public function setTimezone(DateTimeZone $timezone) {}

    /** @return DateTimeImmutable */
    public function setTime(int $hour, int $minute, int $second = 0, int $microsecond = 0) {}

    /** @return DateTimeImmutable */
    public function setDate(int $year, int $month, int $day) {}

    /** @return DateTimeImmutable */
    public function setISODate(int $year, int $week, int $dayOfWeek = 1) {}

    /** @return DateTimeImmutable */
    public function setTimestamp(int $timestamp) {}

    /** @return DateTimeImmutable */
    public static function createFromMutable(DateTime $object) {}

    public static function createFromInterface(DateTimeInterface $object): DateTimeImmutable {}
}

class DateTimeZone
{
    public function __construct(string $timezone) {}

    /**
     * @return string
     * @alias timezone_name_get
     */
    public function getName() {}

    /**
     * @return int
     * @alias timezone_offset_get
     */
    public function getOffset(DateTimeInterface $datetime) {}

    /**
     * @return array|false
     * @alias timezone_transitions_get
     */
    public function getTransitions(int $timestampBegin = PHP_INT_MIN, int $timestampEnd = PHP_INT_MAX) {}

    /**
     * @return array|false
     * @alias timezone_location_get
     */
    public function getLocation() {}

    /**
     * @return array
     * @alias timezone_abbreviations_list
     */
    public static function listAbbreviations() {}

    /**
     * @return array
     * @alias timezone_identifiers_list
     */
    public static function listIdentifiers(int $timezoneGroup = DateTimeZone::ALL, ?string $countryCode = null) {}

    /** @return void */
    public function __wakeup() {}

    /** @return DateTimeZone */
    public static function __set_state(array $array) {}
}

class DateInterval
{
    public function __construct(string $duration) {}

    /**
     * @return DateInterval|false
     * @alias date_interval_create_from_date_string
     */
    public static function createFromDateString(string $datetime) {}

    /**
     * @return string
     * @alias date_interval_format
     */
    public function format(string $format) {}

    /** @return void */
    public function __wakeup() {}

    /** @return DateInterval */
    public static function __set_state(array $array) {}
}

class DatePeriod implements IteratorAggregate
{
    /**
     * @param DateTimeInterface|string $start
     * @param DateInterval|int $interval
     * @param DateTimeInterface|int $end
     * @param int $options
     */
    public function __construct($start, $interval = UNKNOWN, $end = UNKNOWN, $options = UNKNOWN) {}

    /** @return DateTimeInterface */
    public function getStartDate() {}

    /** @return DateTimeInterface|null */
    public function getEndDate() {}

    /** @return DateInterval */
    public function getDateInterval() {}

    /** @return int|null */
    public function getRecurrences() {}

    /** @return void */
    public function __wakeup() {}

    /** @return DatePeriod */
    public static function __set_state(array $array) {}

    public function getIterator(): Iterator {}
}