[phpstorm-stubs] update stubs to migration version for php 8.1

Author: isfedorov

.github/workflows/main.yml

@@ -7,30 +7,30 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
-    name: Run tests against php 8.0
+    name: Run tests against php 8.1
     steps:
       - name: Checkout
         uses: actions/checkout@v2
 
       - name: Build Docker Container
         run: docker-compose -f docker-compose.yml build >/dev/null
         env:
-          PHP_VERSION: '8.0'
+          PHP_VERSION: '8.1'
 
       - name: Composer Install
-        run: docker-compose -f docker-compose.yml run -e PHP_VERSION=8.0 test_runner composer update
+        run: docker-compose -f docker-compose.yml run -e PHP_VERSION=8.1 test_runner composer update
         env:
-          PHP_VERSION: '8.0'
+          PHP_VERSION: '8.1'
 
       - name: Dump Reflection To File
-        run: docker-compose -f docker-compose.yml run -e PHP_VERSION=8.0 php_under_test /usr/local/bin/php tests/Tools/dump-reflection-to-file.php ReflectionData.json
+        run: docker-compose -f docker-compose.yml run -e PHP_VERSION=8.1 php_under_test /usr/local/bin/php tests/Tools/dump-reflection-to-file.php ReflectionData.json
         env:
-          PHP_VERSION: '8.0'
+          PHP_VERSION: '8.1'
 
       - name: Run Tests
-        run: docker-compose -f docker-compose.yml run -e PHP_VERSION=8.0 test_runner vendor/bin/phpunit --testsuite PHP_8.0
+        run: docker-compose -f docker-compose.yml run -e PHP_VERSION=8.1 test_runner vendor/bin/phpunit --testsuite PHP_8.1
         env:
-          PHP_VERSION: '8.0'
+          PHP_VERSION: '8.1'
   additional:
     runs-on: ubuntu-latest
     name: Run cs-fixer and stubs structure tests

Core/Core.php

@@ -335,7 +335,7 @@ function error_reporting(?int $error_level): int {}
  * </p>
  * @return bool true on success or false on failure.
  */
-function define(string $constant_name, $value, #[Deprecated(since: "7.3")] bool $case_insensitive = false): bool {}
+function define(string $constant_name, mixed $value, #[Deprecated(since: "7.3")] bool $case_insensitive = false): bool {}
 
 /**
  * Checks whether a given named constant exists
@@ -475,6 +475,21 @@ function interface_exists(string $interface, bool $autoload = true): bool {}
 #[Pure(true)]
 function function_exists(string $function): bool {}
 
+/**
+ * Checks if the enum has been defined
+ * @link https://php.net/manual/en/function.enum-exists.php
+ * @param string $enum <p>
+ * The enum name. The name is matched in a case-insensitive manner.
+ * </p>
+ * @param bool $autoload [optional] <p>
+ * Whether or not to call autoload by default.
+ * </p>
+ * @return bool true if <i>enum</i> is a defined enum,
+ * false otherwise.
+ * @since 8.1
+ */
+function enum_exists(string $enum, bool $autoload = true): bool {}
+
 /**
  * Creates an alias for a class
  * @link https://php.net/manual/en/function.class-alias.php

Core/Core_c.php

@@ -295,6 +295,76 @@ interface Stringable
     public function __toString(): string;
 }
 
+/**
+ * @since 8.1
+ */
+interface UnitEnum
+{
+    /**
+     * @return static[]
+     */
+    #[Pure]
+    public static function cases(): array;
+}
+
+/**
+ * @since 8.1
+ */
+interface BackedEnum extends UnitEnum
+{
+    /**
+     * @param int|string $value
+     * @return static
+     */
+    #[Pure]
+    public static function from(int|string $value): static;
+
+    /**
+     * @param int|string $value
+     * @return static|null
+     */
+    #[Pure]
+    public static function tryFrom(int|string $value): ?static;
+}
+
+/**
+ * @since 8.1
+ * @internal
+ *
+ * Internal interface to ensure precise type inference
+ */
+interface IntBackedEnum extends BackedEnum
+{
+    /**
+     * @param int $value
+     * @return static
+     */
+    #[Pure]
+    public static function from(int $value): static;
+
+    /**
+     * @param int $value
+     * @return static|null
+     */
+    #[Pure]
+    public static function tryFrom(int $value): ?static;
+}
+
+/**
+ * @since 8.1
+ * @internal
+ *
+ * Internal interface to ensure precise type inference
+ */
+interface StringBackedEnum extends BackedEnum
+{
+    #[Pure]
+    public static function from(string $value): static;
+
+    #[Pure]
+    public static function tryFrom(string $value): ?static;
+}
+
 /**
  * Created by typecasting to object.
  * @link https://php.net/manual/en/reserved.classes.php
@@ -315,10 +385,10 @@ class Exception implements Throwable
     protected $code;
 
     /** The filename where the error happened  */
-    protected $file;
+    protected string $file;
 
     /** The line where the error happened */
-    protected $line;
+    protected int $line;
 
     /**
      * Construct the exception. Note: The message is NOT binary safe.
@@ -407,7 +477,7 @@ public function __wakeup(): void {}
      * @link https://php.net/manual/en/exception.clone.php
      * @return void
      */
-    final private function __clone(): void {}
+    private function __clone(): void {}
 }
 
 /**
@@ -424,10 +494,10 @@ class Error implements Throwable
     protected $code;
 
     /** The filename where the error happened  */
-    protected $file;
+    protected string $file;
 
     /** The line where the error happened */
-    protected $line;
+    protected int $line;
 
     /**
      * Construct the error object.
@@ -514,7 +584,7 @@ public function __wakeup(): void {}
      * @return void
      * @link https://php.net/manual/en/error.clone.php
      */
-    final private function __clone(): void {}
+    private function __clone(): void {}
 }
 
 class ValueError extends Error {}
@@ -579,7 +649,7 @@ class UnhandledMatchError extends Error {}
  */
 class ErrorException extends Exception
 {
-    protected $severity;
+    protected int $severity;
 
     /**
      * Constructs the exception
@@ -842,3 +912,119 @@ public function valid(): bool {}
 
     public function rewind(): void {}
 }
+
+/**
+ * @since 8.1
+ *
+ * @template TStart
+ * @template TResume
+ * @template TReturn
+ * @template TSuspend
+ */
+final class Fiber
+{
+    /**
+     * @param callable $callback Function to invoke when starting the fiber.
+     */
+    public function __construct(callable $callback) {}
+
+    /**
+     * @return self|null Returns the currently executing fiber instance or NULL if in {main}.
+     */
+    public static function getCurrent(): ?Fiber {}
+
+    /**
+     * Suspend execution of the fiber. The fiber may be resumed with {@see Fiber::resume()} or {@see Fiber::throw()}.
+     *
+     * Cannot be called from {main}.
+     *
+     * @param TSuspend $value Value to return from {@see Fiber::resume()} or {@see Fiber::throw()}.
+     *
+     * @return TResume Value provided to {@see Fiber::resume()}.
+     *
+     * @throws FiberError Thrown if not within a fiber (i.e., if called from {main}).
+     * @throws Throwable Exception provided to {@see Fiber::throw()}.
+     */
+    public static function suspend(mixed $value = null): mixed {}
+
+    /**
+     * Starts execution of the fiber. Returns when the fiber suspends or terminates.
+     *
+     * @param TStart ...$args Arguments passed to fiber function.
+     *
+     * @return TSuspend|null Value from the first suspension point or NULL if the fiber returns.
+     *
+     * @throws FiberError If the fiber has already been started.
+     * @throws Throwable If the fiber callable throws an uncaught exception.
+     */
+    public function start(mixed ...$args): mixed {}
+
+    /**
+     * Resumes the fiber, returning the given value from {@see Fiber::suspend()}.
+     * Returns when the fiber suspends or terminates.
+     *
+     * @param TResume $value
+     *
+     * @return TSuspend|null Value from the next suspension point or NULL if the fiber returns.
+     *
+     * @throws FiberError If the fiber has not started, is running, or has terminated.
+     * @throws Throwable If the fiber callable throws an uncaught exception.
+     */
+    public function resume(mixed $value = null): mixed {}
+
+    /**
+     * Throws the given exception into the fiber from {@see Fiber::suspend()}.
+     * Returns when the fiber suspends or terminates.
+     *
+     * @param Throwable $exception
+     *
+     * @return TSuspend|null Value from the next suspension point or NULL if the fiber returns.
+     *
+     * @throws FiberError If the fiber has not started, is running, or has terminated.
+     * @throws Throwable If the fiber callable throws an uncaught exception.
+     */
+    public function throw(Throwable $exception): mixed {}
+
+    /**
+     * @return bool True if the fiber has been started.
+     */
+    public function isStarted(): bool {}
+
+    /**
+     * @return bool True if the fiber is suspended.
+     */
+    public function isSuspended(): bool {}
+
+    /**
+     * @return bool True if the fiber is currently running.
+     */
+    public function isRunning(): bool {}
+
+    /**
+     * @return bool True if the fiber has completed execution (returned or threw).
+     */
+    public function isTerminated(): bool {}
+
+    /**
+     * @return TReturn Return value of the fiber callback. NULL is returned if the fiber does not have a return statement.
+     *
+     * @throws FiberError If the fiber has not terminated or the fiber threw an exception.
+     */
+    public function getReturn(): mixed {}
+}
+
+/**
+ * @since 8.1
+ */
+final class FiberError extends Error
+{
+    public function __construct() {}
+}
+
+/**
+ * @since 8.1
+ */
+final class ReturnTypeWillChange
+{
+    public function __construct() {}
+}

PDO/PDO.php

@@ -23,7 +23,7 @@ function pdo_drivers(): array {}
  */
 class PDOException extends RuntimeException
 {
-    public $errorInfo;
+    public array|null $errorInfo;
     protected $code;
 }
 
@@ -762,6 +762,11 @@ class PDO
      */
     public const MYSQL_ATTR_SSL_VERIFY_SERVER_CERT = 1014;
 
+    /**
+     * @since 8.1
+     */
+    public const MYSQL_ATTR_LOCAL_INFILE_DIRECTORY = 1015;
+
     #[Deprecated("Use PDO::ATTR_EMULATE_PREPARES instead")]
     public const PGSQL_ASSOC = 1;
 
@@ -924,9 +929,9 @@ class PDO
      * Creates a PDO instance representing a connection to a database
      * @link https://php.net/manual/en/pdo.construct.php
      * @param string $dsn
-     * @param string|null $username [optional]
-     * @param string|null $password [optional]
-     * @param array|null $options [optional]
+     * @param string $username [optional]
+     * @param string $password [optional]
+     * @param array $options [optional]
      * @throws PDOException if the attempt to connect to the requested database fails.
      */
     public function __construct(string $dsn, string|null $username = null, string|null $password = null, array|null $options = null) {}
@@ -1420,7 +1425,7 @@ class PDOStatement implements IteratorAggregate
     /**
      * @var string
      */
-    public $queryString;
+    public string $queryString;
 
     /**
      * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)<br/>
@@ -1845,5 +1850,5 @@ public function getIterator(): Iterator {}
 
 final class PDORow
 {
-    public $queryString;
+    public string $queryString;
 }