Skip to content

Typed constants in date extension #12361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 22, 2024
Merged

Typed constants in date extension #12361

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b1d82e2
Typed constants in date extension
jorgsowa Oct 4, 2023
f80bbf2
Added note about typed class constants in Date extension
jorgsowa Oct 6, 2023
d3d7005
Inline the phpdocs of the class constants in date extension
jorgsowa Oct 6, 2023
aa7ead2
Inline PHPDoc comments
jorgsowa Oct 8, 2023
4a2c8f1
Update stub generated file
jorgsowa Nov 26, 2023
114422f
Updated auto-generated date header from stub
jorgsowa Mar 14, 2024
9fbd3ff
Reverted PHPDoc squashing
jorgsowa Mar 19, 2024
0a3986a
Updated date stub
jorgsowa Mar 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions UPGRADING
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,6 +484,9 @@ PHP 8.4 UPGRADE NOTES
- Curl:
. The Curl extension now requires at least libcurl 7.61.0.

- Date:
. The class constants are typed now.

- Intl:
. The class constants are typed now.

Expand Down
216 changes: 72 additions & 144 deletions ext/date/php_date.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,34 +284,34 @@ function date_sun_info(int $timestamp, float $latitude, float $longitude): array

interface DateTimeInterface
{
/** @var string */
public const ATOM = DATE_ATOM;
/** @var string */
public const COOKIE = DATE_COOKIE;
/** @var string */
public const ISO8601 = DATE_ISO8601;
/** @var string */
public const ISO8601_EXPANDED = DATE_ISO8601_EXPANDED;
/** @var string */
public const RFC822 = DATE_RFC822;
/** @var string */
public const RFC850 = DATE_RFC850;
/** @var string */
public const RFC1036 = DATE_RFC1036;
/** @var string */
public const RFC1123 = DATE_RFC1123;
/** @var string */
public const RFC7231 = DATE_RFC7231;
/** @var string */
public const RFC2822 = DATE_RFC2822;
/** @var string */
public const RFC3339 = DATE_RFC3339;
/** @var string */
public const RFC3339_EXTENDED = DATE_RFC3339_EXTENDED;
/** @var string */
public const RSS = DATE_RSS;
/** @var string */
public const W3C = DATE_W3C;

public const string ATOM = DATE_ATOM;

public const string COOKIE = DATE_COOKIE;

public const string ISO8601 = DATE_ISO8601;

public const string ISO8601_EXPANDED = DATE_ISO8601_EXPANDED;

public const string RFC822 = DATE_RFC822;

public const string RFC850 = DATE_RFC850;

public const string RFC1036 = DATE_RFC1036;

public const string RFC1123 = DATE_RFC1123;

public const string RFC7231 = DATE_RFC7231;

public const string RFC2822 = DATE_RFC2822;

public const string RFC3339 = DATE_RFC3339;

public const string RFC3339_EXTENDED = DATE_RFC3339_EXTENDED;

public const string RSS = DATE_RSS;

public const string W3C = DATE_W3C;

/** @tentative-return-type */
public function format(string $format): string;
Expand Down Expand Up @@ -380,9 +380,7 @@ public static function getLastErrors(): array|false {}
*/
public function format(string $format): string {}

/**
* @tentative-return-type
*/
/** @tentative-return-type */
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't make unnecessary formatting changes.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, IMO this is an useful change, makes the stub much shorter and easier to overview. Actually, I asked the same in different extensions.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They shouldn't be in the same commit (which it will end up in after squashing), and hence, shouldn't be part of this PR to begin with.

public function modify(string $modifier): DateTime|false {}

/**
Expand All @@ -391,9 +389,7 @@ public function modify(string $modifier): DateTime|false {}
*/
public function add(DateInterval $interval): DateTime {}

/**
* @tentative-return-type
*/
/** @tentative-return-type */
public function sub(DateInterval $interval): DateTime {}

/**
Expand Down Expand Up @@ -555,76 +551,34 @@ public static function createFromInterface(DateTimeInterface $object): DateTimeI

class DateTimeZone
{
/**
* @var int
* @cvalue PHP_DATE_TIMEZONE_GROUP_AFRICA
*/
public const AFRICA = UNKNOWN;
/**
* @var int
* @cvalue PHP_DATE_TIMEZONE_GROUP_AMERICA
*/
public const AMERICA = UNKNOWN;
/**
* @var int
* @cvalue PHP_DATE_TIMEZONE_GROUP_ANTARCTICA
*/
public const ANTARCTICA = UNKNOWN;
/**
* @var int
* @cvalue PHP_DATE_TIMEZONE_GROUP_ARCTIC
*/
public const ARCTIC = UNKNOWN;
/**
* @var int
* @cvalue PHP_DATE_TIMEZONE_GROUP_ASIA
*/
public const ASIA = UNKNOWN;
/**
* @var int
* @cvalue PHP_DATE_TIMEZONE_GROUP_ATLANTIC
*/
public const ATLANTIC = UNKNOWN;
/**
* @var int
* @cvalue PHP_DATE_TIMEZONE_GROUP_AUSTRALIA
*/
public const AUSTRALIA = UNKNOWN;
/**
* @var int
* @cvalue PHP_DATE_TIMEZONE_GROUP_EUROPE
*/
public const EUROPE = UNKNOWN;
/**
* @var int
* @cvalue PHP_DATE_TIMEZONE_GROUP_INDIAN
*/
public const INDIAN = UNKNOWN;
/**
* @var int
* @cvalue PHP_DATE_TIMEZONE_GROUP_PACIFIC
*/
public const PACIFIC = UNKNOWN;
/**
* @var int
* @cvalue PHP_DATE_TIMEZONE_GROUP_UTC
*/
public const UTC = UNKNOWN;
/**
* @var int
* @cvalue PHP_DATE_TIMEZONE_GROUP_ALL
*/
public const ALL = UNKNOWN;
/**
* @var int
* @cvalue PHP_DATE_TIMEZONE_GROUP_ALL_W_BC
*/
public const ALL_WITH_BC = UNKNOWN;
/**
* @var int
* @cvalue PHP_DATE_TIMEZONE_PER_COUNTRY
*/
public const PER_COUNTRY = UNKNOWN;
/** @cvalue PHP_DATE_TIMEZONE_GROUP_AFRICA */
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't make unnecessary formatting changes (just remove the @var int line).

public const int AFRICA = UNKNOWN;
/** @cvalue PHP_DATE_TIMEZONE_GROUP_AMERICA */
public const int AMERICA = UNKNOWN;
/** @cvalue PHP_DATE_TIMEZONE_GROUP_ANTARCTICA */
public const int ANTARCTICA = UNKNOWN;
/** @cvalue PHP_DATE_TIMEZONE_GROUP_ARCTIC */
public const int ARCTIC = UNKNOWN;
/** @cvalue PHP_DATE_TIMEZONE_GROUP_ASIA */
public const int ASIA = UNKNOWN;
/** @cvalue PHP_DATE_TIMEZONE_GROUP_ATLANTIC */
public const int ATLANTIC = UNKNOWN;
/** @cvalue PHP_DATE_TIMEZONE_GROUP_AUSTRALIA */
public const int AUSTRALIA = UNKNOWN;
/** @cvalue PHP_DATE_TIMEZONE_GROUP_EUROPE */
public const int EUROPE = UNKNOWN;
/** @cvalue PHP_DATE_TIMEZONE_GROUP_INDIAN */
public const int INDIAN = UNKNOWN;
/** @cvalue PHP_DATE_TIMEZONE_GROUP_PACIFIC */
public const int PACIFIC = UNKNOWN;
/** @cvalue PHP_DATE_TIMEZONE_GROUP_UTC */
public const int UTC = UNKNOWN;
/** @cvalue PHP_DATE_TIMEZONE_GROUP_ALL */
public const int ALL = UNKNOWN;
/** @cvalue PHP_DATE_TIMEZONE_GROUP_ALL_W_BC */
public const int ALL_WITH_BC = UNKNOWN;
/** @cvalue PHP_DATE_TIMEZONE_PER_COUNTRY */
public const int PER_COUNTRY = UNKNOWN;

public function __construct(string $timezone) {}

Expand Down Expand Up @@ -683,9 +637,7 @@ class DateInterval
{
public function __construct(string $duration) {}

/**
* @tentative-return-type
*/
/** @tentative-return-type */
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't make unnecessary formatting changes.

public static function createFromDateString(string $datetime): DateInterval|false {}

/**
Expand All @@ -707,16 +659,10 @@ public static function __set_state(array $array): DateInterval {}

class DatePeriod implements IteratorAggregate
{
/**
* @var int
* @cvalue PHP_DATE_PERIOD_EXCLUDE_START_DATE
*/
public const EXCLUDE_START_DATE = UNKNOWN;
/**
* @var int
* @cvalue PHP_DATE_PERIOD_INCLUDE_END_DATE
*/
public const INCLUDE_END_DATE = UNKNOWN;
/** @cvalue PHP_DATE_PERIOD_EXCLUDE_START_DATE */
public const int EXCLUDE_START_DATE = UNKNOWN;
/** @cvalue PHP_DATE_PERIOD_INCLUDE_END_DATE */
public const int INCLUDE_END_DATE = UNKNOWN;

/** @readonly */
public ?DateTimeInterface $start;
Expand Down Expand Up @@ -768,65 +714,47 @@ public static function __set_state(array $array): DatePeriod {}
public function getIterator(): Iterator {}
}

/**
* @strict-properties
*/
/** @strict-properties */
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't make unnecessary formatting changes.

class DateError extends Error
{
}

/**
* @strict-properties
*/
/** @strict-properties */
class DateObjectError extends DateError
{
}

/**
* @strict-properties
*/
/** @strict-properties */
class DateRangeError extends DateError
{
}

/**
* @strict-properties
*/
/** @strict-properties */
class DateException extends Exception
{
}

/**
* @strict-properties
*/
/** @strict-properties */
class DateInvalidTimeZoneException extends DateException
{
}

/**
* @strict-properties
*/
/** @strict-properties */
class DateInvalidOperationException extends DateException
{
}

/**
* @strict-properties
*/
/** @strict-properties */
class DateMalformedStringException extends DateException
{
}

/**
* @strict-properties
*/
/** @strict-properties */
class DateMalformedIntervalStringException extends DateException
{
}

/**
* @strict-properties
*/
/** @strict-properties */
class DateMalformedPeriodStringException extends DateException
{
}
Loading