Add union types

Author: nicolas-grekas

Filesystem.php

@@ -82,11 +82,9 @@ public function copy(string $originFile, string $targetFile, bool $overwriteNewe
     /**
      * Creates a directory recursively.
      *
-     * @param string|iterable $dirs The directory path
-     *
      * @throws IOException On any directory creation failure
      */
-    public function mkdir($dirs, int $mode = 0777)
+    public function mkdir(string|iterable $dirs, int $mode = 0777)
     {
         foreach ($this->toIterable($dirs) as $dir) {
             if (is_dir($dir)) {
@@ -102,11 +100,9 @@ public function mkdir($dirs, int $mode = 0777)
     /**
      * Checks the existence of files or directories.
      *
-     * @param string|iterable $files A filename, an array of files, or a \Traversable instance to check
-     *
      * @return bool true if the file exists, false otherwise
      */
-    public function exists($files)
+    public function exists(string|iterable $files)
     {
         $maxPathLength = \PHP_MAXPATHLEN - 2;
 
@@ -126,13 +122,12 @@ public function exists($files)
     /**
      * Sets access and modification time of file.
      *
-     * @param string|iterable $files A filename, an array of files, or a \Traversable instance to create
-     * @param int|null        $time  The touch time as a Unix timestamp, if not supplied the current system time is used
-     * @param int|null        $atime The access time as a Unix timestamp, if not supplied the current system time is used
+     * @param int|null $time  The touch time as a Unix timestamp, if not supplied the current system time is used
+     * @param int|null $atime The access time as a Unix timestamp, if not supplied the current system time is used
      *
      * @throws IOException When touch fails
      */
-    public function touch($files, int $time = null, int $atime = null)
+    public function touch(string|iterable $files, int $time = null, int $atime = null)
     {
         foreach ($this->toIterable($files) as $file) {
             if (!($time ? self::box('touch', $file, $time, $atime) : self::box('touch', $file))) {
@@ -144,11 +139,9 @@ public function touch($files, int $time = null, int $atime = null)
     /**
      * Removes files or directories.
      *
-     * @param string|iterable $files A filename, an array of files, or a \Traversable instance to remove
-     *
      * @throws IOException When removal fails
      */
-    public function remove($files)
+    public function remove(string|iterable $files)
     {
         if ($files instanceof \Traversable) {
             $files = iterator_to_array($files, false);
@@ -208,14 +201,13 @@ private static function doRemove(array $files, bool $isRecursive): void
     /**
      * Change mode for an array of files or directories.
      *
-     * @param string|iterable $files     A filename, an array of files, or a \Traversable instance to change mode
-     * @param int             $mode      The new mode (octal)
-     * @param int             $umask     The mode mask (octal)
-     * @param bool            $recursive Whether change the mod recursively or not
+     * @param int  $mode      The new mode (octal)
+     * @param int  $umask     The mode mask (octal)
+     * @param bool $recursive Whether change the mod recursively or not
      *
      * @throws IOException When the change fails
      */
-    public function chmod($files, int $mode, int $umask = 0000, bool $recursive = false)
+    public function chmod(string|iterable $files, int $mode, int $umask = 0000, bool $recursive = false)
     {
         foreach ($this->toIterable($files) as $file) {
             if (\is_int($mode) && !self::box('chmod', $file, $mode & ~$umask)) {
@@ -230,13 +222,12 @@ public function chmod($files, int $mode, int $umask = 0000, bool $recursive = fa
     /**
      * Change the owner of an array of files or directories.
      *
-     * @param string|iterable $files     A filename, an array of files, or a \Traversable instance to change owner
-     * @param string|int      $user      A user name or number
-     * @param bool            $recursive Whether change the owner recursively or not
+     * @param string|int $user      A user name or number
+     * @param bool       $recursive Whether change the owner recursively or not
      *
      * @throws IOException When the change fails
      */
-    public function chown($files, $user, bool $recursive = false)
+    public function chown(string|iterable $files, string|int $user, bool $recursive = false)
     {
         foreach ($this->toIterable($files) as $file) {
             if ($recursive && is_dir($file) && !is_link($file)) {
@@ -257,13 +248,12 @@ public function chown($files, $user, bool $recursive = false)
     /**
      * Change the group of an array of files or directories.
      *
-     * @param string|iterable $files     A filename, an array of files, or a \Traversable instance to change group
-     * @param string|int      $group     A group name or number
-     * @param bool            $recursive Whether change the group recursively or not
+     * @param string|int $group     A group name or number
+     * @param bool       $recursive Whether change the group recursively or not
      *
      * @throws IOException When the change fails
      */
-    public function chgrp($files, $group, bool $recursive = false)
+    public function chgrp(string|iterable $files, string|int $group, bool $recursive = false)
     {
         foreach ($this->toIterable($files) as $file) {
             if ($recursive && is_dir($file) && !is_link($file)) {
@@ -362,7 +352,7 @@ public function symlink(string $originDir, string $targetDir, bool $copyOnWindow
      * @throws FileNotFoundException When original file is missing or not a file
      * @throws IOException           When link fails, including if link already exists
      */
-    public function hardlink(string $originFile, $targetFiles)
+    public function hardlink(string $originFile, string|iterable $targetFiles)
     {
         if (!$this->exists($originFile)) {
             throw new FileNotFoundException(null, 0, null, $originFile);
@@ -712,9 +702,9 @@ public function appendToFile(string $filename, $content)
         }
     }
 
-    private function toIterable($files): iterable
+    private function toIterable(string|iterable $files): iterable
     {
-        return \is_array($files) || $files instanceof \Traversable ? $files : [$files];
+        return \is_string($files) ? [$files] : $files;
     }
 
     /**
@@ -727,12 +717,7 @@ private function getSchemeAndHierarchy(string $filename): array
         return 2 === \count($components) ? [$components[0], $components[1]] : [null, $components[0]];
     }
 
-    /**
-     * @param mixed ...$args
-     *
-     * @return mixed
-     */
-    private static function box(callable $func, ...$args)
+    private static function box(callable $func, mixed ...$args): mixed
     {
         self::$lastError = null;
         set_error_handler(__CLASS__.'::handleError');
@@ -751,7 +736,7 @@ private static function box(callable $func, ...$args)
     /**
      * @internal
      */
-    public static function handleError($type, $msg)
+    public static function handleError(int $type, string $msg)
     {
         self::$lastError = $msg;
     }

Tests/Fixtures/MockStream/MockStream.php

@@ -26,18 +26,18 @@ class MockStream
      * @param string $opened_path If the path is opened successfully, and STREAM_USE_PATH is set in options,
      *                            opened_path should be set to the full path of the file/resource that was actually opened
      */
-    public function stream_open($path, $mode, $options, &$opened_path): bool
+    public function stream_open(string $path, string $mode, int $options, string &$opened_path = null): bool
     {
         return true;
     }
 
     /**
      * @param string $path  The file path or URL to stat
-     * @param array  $flags Holds additional flags set by the streams API
+     * @param int    $flags Holds additional flags set by the streams API
      *
      * @return array File stats
      */
-    public function url_stat($path, $flags): array
+    public function url_stat(string $path, int $flags): array
     {
         return [];
     }