mirror of
https://github.com/danog/psalm.git
synced 2024-11-27 04:45:20 +01:00
b4b2bc66c7
`DateTimeImmutable` is **almost** immutable: `DateTimeImmutable::__construct()` is in fact not a pure
method, since `new DateTimeImmutable('now')` produces a different value at each instantiation (by design).
This change makes sure that `DateTimeImmutable` loses its `@psalm-immutable` class-level marker,
preventing downstream misuse of the constructor inside otherwise referentially transparent code.
Note: only pure methods are stubbed here: all other methods declared by `DateTimeImmutable` (parent interface)
are NOT present here, and are either inferred from runtime reflection, or `CallMap*.php` definitions.
Methods are sorted in the order defined by reflection on PHP 8.1.8, at the time of writing this ( https://3v4l.org/3TGg8 ).
Following simplistic snippet was used to infer the current signature:
```php
<?php
$c = new \ReflectionClass(\DateTimeImmutable::class);
$methods = array_map(function ($m) {
return $m->getName()
. '(' . implode(',', array_map(function ($p) {
return $p->getType()
. ' $' . $p->getName()
. ($p->isOptional() ? ' = ' . var_export($p->getDefaultValue(), true) : '');
}, $m->getParameters())) . ')' . ($m->getReturnType() ? (': ' . $m->getReturnType()) : '');
}, $c->getMethods());
$properties = array_map(function ($m) {
return $m->getName();
}, $c->getProperties());
var_dump($methods, $properties);
```
338 lines
6.7 KiB
PHP
338 lines
6.7 KiB
PHP
<?php
|
|
|
|
class DateTimeImmutable implements DateTimeInterface
|
|
{
|
|
public function __construct(string $datetime = "now", DateTimeZone $timezone = null) {}
|
|
|
|
/**
|
|
* @psalm-pure
|
|
* @return static|false
|
|
*/
|
|
public static function createFromFormat(string $format, string $datetime, ?DateTimeZone $timezone = null) {}
|
|
|
|
/**
|
|
* @psalm-pure
|
|
* @param string $format
|
|
* @return string
|
|
*/
|
|
public function format($format) {}
|
|
|
|
/**
|
|
* @psalm-pure
|
|
* @return DateTimeZone
|
|
*/
|
|
public function getTimezone() {}
|
|
|
|
/**
|
|
* @psalm-pure
|
|
* @return int
|
|
*/
|
|
public function getOffset() {}
|
|
|
|
/**
|
|
* @psalm-pure
|
|
* @return int
|
|
*/
|
|
public function getTimestamp() {}
|
|
|
|
/**
|
|
* @psalm-pure
|
|
* @param bool $absolute
|
|
* @return DateInterval
|
|
*/
|
|
public function diff(DateTimeInterface $targetObject, $absolute = false) {}
|
|
|
|
/**
|
|
* @psalm-pure
|
|
* @return static
|
|
*/
|
|
public function modify(string $modifier) {}
|
|
|
|
/**
|
|
* @psalm-pure
|
|
* @return static
|
|
*/
|
|
public function add(DateInterval $interval) {}
|
|
|
|
/**
|
|
* @psalm-pure
|
|
* @return static
|
|
*/
|
|
public function sub(DateInterval $interval) {}
|
|
|
|
/**
|
|
* @psalm-pure
|
|
* @return static|false
|
|
*/
|
|
public function setTimezone(DateTimeZone $timezone) {}
|
|
|
|
/**
|
|
* @psalm-pure
|
|
* @return static|false
|
|
*/
|
|
public function setTime(int $hour, int $minute, int $second = 0, int $microsecond = 0) {}
|
|
|
|
/**
|
|
* @psalm-pure
|
|
* @return static|false
|
|
*/
|
|
public function setDate(int $year, int $month, int $day) {}
|
|
|
|
/**
|
|
* @psalm-pure
|
|
* @return static|false
|
|
*/
|
|
public function setISODate(int $year, int $week, int $dayOfWeek = 1) {}
|
|
|
|
/**
|
|
* @psalm-pure
|
|
* @return static|false
|
|
*/
|
|
public function setTimestamp(int $unixtimestamp) {}
|
|
|
|
/**
|
|
* @psalm-pure
|
|
* @return static
|
|
*/
|
|
public static function createFromMutable(DateTime $object) {}
|
|
|
|
/**
|
|
* @psalm-pure
|
|
* @return self
|
|
*/
|
|
public static function createFromInterface(DateTimeInterface $object) {}
|
|
}
|
|
|
|
/**
|
|
* @psalm-immutable
|
|
*/
|
|
class DateTimeZone
|
|
{
|
|
public function __construct(string $timezone) {}
|
|
}
|
|
|
|
/**
|
|
* @psalm-immutable
|
|
*
|
|
* @template-covariant Start of string|DateTimeInterface
|
|
* @implements Traversable<int, DateTimeInterface>
|
|
*/
|
|
class DatePeriod implements Traversable
|
|
{
|
|
const EXCLUDE_START_DATE = 1;
|
|
/**
|
|
* @param Start $start
|
|
* @param (Start is string ? 0|self::EXCLUDE_START_DATE : DateInterval) $interval
|
|
* @param (Start is string ? never : DateTimeInterface|positive-int) $end
|
|
* @param (Start is string ? never : 0|self::EXCLUDE_START_DATE) $options
|
|
*/
|
|
public function __construct($start, $interval = 0, $end = 1, $options = 0) {}
|
|
}
|
|
|
|
/**
|
|
* @psalm-taint-specialize
|
|
*/
|
|
interface Throwable
|
|
{
|
|
/**
|
|
* @psalm-mutation-free
|
|
*/
|
|
public function getMessage() : string;
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
*
|
|
* @return int|string https://www.php.net/manual/en/throwable.getcode.php
|
|
*/
|
|
public function getCode();
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
*/
|
|
public function getFile() : string;
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
*/
|
|
public function getLine() : int;
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
* @return list<array{file?:string,line?:int,function?:string,class?:class-string,type?:'::'|'->',args?:array<mixed>}>
|
|
*/
|
|
public function getTrace() : array;
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
*/
|
|
public function getPrevious() : ?Throwable;
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
* @psalm-taint-source input
|
|
*/
|
|
public function getTraceAsString() : string;
|
|
|
|
/**
|
|
* @return string
|
|
* @psalm-taint-source input
|
|
*/
|
|
public function __toString();
|
|
}
|
|
|
|
/**
|
|
* @psalm-taint-specialize
|
|
*/
|
|
class Exception implements Throwable
|
|
{
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $message = '';
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
protected $code = 0;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $file = '';
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
protected $line = 0;
|
|
|
|
/**
|
|
* @psalm-external-mutation-free
|
|
* @param string $message
|
|
* @param int $code
|
|
* @param Throwable $previous
|
|
*/
|
|
public function __construct($message = "", $code = 0, Throwable $previous = null) {}
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
*/
|
|
public final function getMessage() : string {}
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
*
|
|
* @return int|string https://www.php.net/manual/en/throwable.getcode.php
|
|
*/
|
|
public final function getCode() {}
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
*/
|
|
public final function getFile(): string {}
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
*/
|
|
public final function getLine(): int {}
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
* @return list<array{file?:string,line?:int,function?:string,class?:class-string,type?:'::'|'->',args?:array<mixed>}>
|
|
*/
|
|
public final function getTrace() : array {}
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
*/
|
|
public final function getPrevious() : ?Throwable {}
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
* @psalm-taint-source input
|
|
*/
|
|
public final function getTraceAsString() : string {}
|
|
|
|
/**
|
|
* @return string
|
|
* @psalm-taint-source input
|
|
*/
|
|
public function __toString() {}
|
|
}
|
|
|
|
/**
|
|
* @psalm-taint-specialize
|
|
*/
|
|
class Error implements Throwable
|
|
{
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $message = '';
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
protected $code = 0;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $file = '';
|
|
|
|
/**
|
|
* @var int
|
|
*/
|
|
protected $line = 0;
|
|
|
|
/**
|
|
* @psalm-external-mutation-free
|
|
* @param string $message
|
|
* @param int $code
|
|
* @param Throwable $previous
|
|
*/
|
|
public function __construct($message = "", $code = 0, Throwable $previous = null) {}
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
*/
|
|
public final function getMessage() : string {}
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
*/
|
|
public final function getCode(): int {}
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
*/
|
|
public final function getFile(): string {}
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
*/
|
|
public final function getLine(): int{}
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
* @return list<array{file?:string,line?:int,function?:string,class?:class-string,type?:'::'|'->',args?:array<mixed>}>
|
|
*/
|
|
public final function getTrace() : array {}
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
*/
|
|
public final function getPrevious() : ?Throwable {}
|
|
|
|
/**
|
|
* @psalm-mutation-free
|
|
* @psalm-taint-source input
|
|
*/
|
|
public final function getTraceAsString() : string {}
|
|
|
|
/**
|
|
* @return string
|
|
* @psalm-taint-source input
|
|
*/
|
|
public function __toString() {}
|
|
}
|