FileHelper::findFiles() - Code Metrics - Inspection of "Add methods FileHelper::findDirectories() and File..." - yiisoft/files - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#39)

by Sergei

created 2020-12-16 21:18 UTC

FileHelper::findFiles() B

↳ Parent: FileHelper

Complexity

Conditions	10
Paths	7

Size

Total Lines	31
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	17
CRAP Score	10.017

Importance

Changes

Metric	Value
eloc	17
c	0
b	0
f	0
dl	0
loc	31
ccs	17
cts	18
cp	0.9444
rs	7.6666
cc	10
nc	7
nop	2
crap	10.017

How to fix Complexity

<?php

declare(strict_types=1);

namespace Yiisoft\Files;

use Exception;
use FilesystemIterator;
use InvalidArgumentException;
use LogicException;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use RuntimeException;
use Throwable;

/**
 * FileHelper provides useful methods to manage files and directories
 */
class FileHelper
{
    /**
     * Opens a file or URL.
     *
     * This method is similar to the PHP `fopen()` function, except that it suppresses the `E_WARNING`
     * level error and throws the `\RuntimeException` exception if it can't open the file.
     *
     * @param string $filename The file or URL.
     * @param string $mode The type of access.
     * @param bool $useIncludePath Whether to search for a file in the include path.
     * @param resource|null $context The stream context or `null`.
     *
     * @throws RuntimeException If the file could not be opened.
     *
     * @return resource The file pointer resource.
     *
     * @psalm-suppress PossiblyNullArgument
     */
    public static function openFile(string $filename, string $mode, bool $useIncludePath = false, $context = null)
    {
        $filePointer = @fopen($filename, $mode, $useIncludePath, $context);

        if ($filePointer === false) {
            throw new RuntimeException("The file \"{$filename}\" could not be opened.");
        }

        return $filePointer;
    }

    /**
     * Creates a new directory.
     *
     * This method is similar to the PHP `mkdir()` function except that it uses `chmod()` to set the permission of the
     * created directory in order to avoid the impact of the `umask` setting.
     *
     * @param string $path path of the directory to be created.
     * @param int $mode the permission to be set for the created directory.
     *
     * @return bool whether the directory is created successfully.
     */
    public static function createDirectory(string $path, int $mode = 0775): bool
    {
        $path = static::normalizePath($path);

        try {
            if (!mkdir($path, $mode, true) && !is_dir($path)) {
                return false;
            }
        } catch (Exception $e) {
            if (!is_dir($path)) {
                throw new RuntimeException(
                    'Failed to create directory "' . $path . '": ' . $e->getMessage(),
                    (int)$e->getCode(),
                    $e
                );
            }
        }

        return chmod($path, $mode);
    }

    /**
     * Normalizes a file/directory path.
     *
     * The normalization does the following work:
     *
     * - Convert all directory separators into `/` (e.g. "\a/b\c" becomes "/a/b/c")
     * - Remove trailing directory separators (e.g. "/a/b/c/" becomes "/a/b/c")
     * - Turn multiple consecutive slashes into a single one (e.g. "/a///b/c" becomes "/a/b/c")
     * - Remove ".." and "." based on their meanings (e.g. "/a/./b/../c" becomes "/a/c")
     *
     * @param string $path the file/directory path to be normalized
     *
     * @return string the normalized file/directory path
     */
    public static function normalizePath(string $path): string
    {
        $isWindowsShare = strpos($path, '\\\\') === 0;

        if ($isWindowsShare) {
            $path = substr($path, 2);
        }

        $path = rtrim(strtr($path, '/\\', '//'), '/');

        if (strpos('/' . $path, '/.') === false && strpos($path, '//') === false) {
            return $isWindowsShare ? "\\\\$path" : $path;
        }

        $parts = [];

        foreach (explode('/', $path) as $part) {
            if ($part === '..' && !empty($parts) && end($parts) !== '..') {
                array_pop($parts);
            } elseif ($part !== '.' && ($part !== '' || empty($parts))) {
                $parts[] = $part;
            }
        }

        $path = implode('/', $parts);

        if ($isWindowsShare) {
            $path = '\\\\' . $path;
        }

        return $path === '' ? '.' : $path;
    }

    /**
     * Removes a directory (and all its content) recursively.
     *
     * @param string $directory the directory to be deleted recursively.
     * @param array $options options for directory remove ({@see clearDirectory()}).
     */
    public static function removeDirectory(string $directory, array $options = []): void
    {
        try {
            static::clearDirectory($directory, $options);
        } catch (InvalidArgumentException $e) {
            return;
        }

        if (is_link($directory)) {
            self::unlink($directory);
        } else {
            rmdir($directory);
        }
    }

    /**
     * Clear all directory content.
     *
     * @param string $directory the directory to be cleared.
     * @param array $options options for directory clear . Valid options are:
     *
     * - traverseSymlinks: boolean, whether symlinks to the directories should be traversed too.
     *   Defaults to `false`, meaning the content of the symlinked directory would not be deleted.
     *   Only symlink would be removed in that default case.
     *
     * @throws InvalidArgumentException if unable to open directory
     */
    public static function clearDirectory(string $directory, array $options = []): void
    {
        $handle = static::openDirectory($directory);
        if (!empty($options['traverseSymlinks']) || !is_link($directory)) {
            while (($file = readdir($handle)) !== false) {
                if ($file === '.' || $file === '..') {
                    continue;
                }
                $path = $directory . '/' . $file;
                if (is_dir($path)) {
                    self::removeDirectory($path, $options);
                } else {
                    self::unlink($path);
                }
            }
            closedir($handle);
        }
    }

    /**
     * Removes a file or symlink in a cross-platform way.
     *
     * @param string $path
     *
     * @return bool
     */
    public static function unlink(string $path): bool
    {
        $isWindows = DIRECTORY_SEPARATOR === '\\';

        if (!$isWindows) {
            return unlink($path);
        }

        if (is_link($path)) {
            try {
                return unlink($path);
            } catch (Throwable $e) {
                return rmdir($path);
            }
        }

        if (file_exists($path) && !is_writable($path)) {
            chmod($path, 0777);
        }

        return unlink($path);
    }

    /**
     * Tells whether the path is a empty directory
     *
     * @param string $path
     *
     * @return bool
     */
    public static function isEmptyDirectory(string $path): bool
    {
        if (!is_dir($path)) {
            return false;
        }

        return !(new FilesystemIterator($path))->valid();
    }

    /**
     * Copies a whole directory as another one.
     *
     * The files and sub-directories will also be copied over.
     *
     * @param string $source the source directory.
     * @param string $destination the destination directory.
     * @param array $options options for directory copy. Valid options are:
     *
     * - dirMode: integer, the permission to be set for newly copied directories. Defaults to 0775.
     * - fileMode: integer, the permission to be set for newly copied files. Defaults to the current environment
     *   setting.
     * - filter: a filter to apply while copying files. It should be an instance of {@see PathMatcherInterface}.
     * - recursive: boolean, whether the files under the subdirectories should also be copied. Defaults to true.
     * - beforeCopy: callback, a PHP callback that is called before copying each sub-directory or file. If the callback
     *   returns false, the copy operation for the sub-directory or file will be cancelled. The signature of the
     *   callback should be: `function ($from, $to)`, where `$from` is the sub-directory or file to be copied from,
     *   while `$to` is the copy target.
     * - afterCopy: callback, a PHP callback that is called after each sub-directory or file is successfully copied.
     *   The signature of the callback should be: `function ($from, $to)`, where `$from` is the sub-directory or file
     *   copied from, while `$to` is the copy target.
     * - copyEmptyDirectories: boolean, whether to copy empty directories. Set this to false to avoid creating
     *   directories that do not contain files. This affects directories that do not contain files initially as well as
     *   directories that do not contain files at the target destination because files have been filtered via `only` or
     *   `except`. Defaults to true.
     *
     * @throws InvalidArgumentException if unable to open directory
     * @throws Exception
     *
     * @psalm-param array{
     *   dirMode?: int,
     *   fileMode?: int,
     *   filter?: \Yiisoft\Files\PathMatcher\PathMatcherInterface,
     *   recursive?: bool,
     *   beforeCopy?: callable,
     *   afterCopy?: callable,
     *   copyEmptyDirectories?: bool,
     * } $options
     */
    public static function copyDirectory(string $source, string $destination, array $options = []): void
    {
        $source = static::normalizePath($source);
        $destination = static::normalizePath($destination);

        static::assertNotSelfDirectory($source, $destination);

        $destinationExists = is_dir($destination);
        if (
            !$destinationExists &&
            (!isset($options['copyEmptyDirectories']) || $options['copyEmptyDirectories'])
        ) {
            static::createDirectory($destination, $options['dirMode'] ?? 0775);
            $destinationExists = true;
        }

        $handle = static::openDirectory($source);

        if (!isset($options['basePath'])) {
            $options['basePath'] = realpath($source);
        }

        while (($file = readdir($handle)) !== false) {
            if ($file === '.' || $file === '..') {
                continue;
            }

            $from = $source . '/' . $file;
            $to = $destination . '/' . $file;

            if (!isset($options['filter']) || $options['filter']->match($from)) {
                if (is_file($from)) {
                    if (!$destinationExists) {
                        static::createDirectory($destination, $options['dirMode'] ?? 0775);
                        $destinationExists = true;
                    }
                    copy($from, $to);
                    if (isset($options['fileMode'])) {
                        chmod($to, $options['fileMode']);
                    }
                } elseif (!isset($options['recursive']) || $options['recursive']) {
                    static::copyDirectory($from, $to, $options);
                }
            }
        }

        closedir($handle);
    }

    /**
     * Check copy it self directory.
     *
     * @param string $source
     * @param string $destination
     *
     * @throws InvalidArgumentException
     */
    private static function assertNotSelfDirectory(string $source, string $destination): void
    {
        if ($source === $destination || strpos($destination, $source . '/') === 0) {
            throw new InvalidArgumentException('Trying to copy a directory to itself or a subdirectory.');
        }
    }

    /**
     * Open directory handle.
     *
     * @param string $directory
     *
     * @throws InvalidArgumentException
     *
     * @return resource
     */
    private static function openDirectory(string $directory)
    {
        $handle = @opendir($directory);

        if ($handle === false) {
            throw new InvalidArgumentException("Unable to open directory: $directory");
        }

        return $handle;
    }

    /**
     * Returns the last modification time for the given path.
     *
     * If the path is a directory, any nested files/directories will be checked as well.
     *
     * @param string ...$paths the directory to be checked
     *
     * @throws LogicException when path not set
     *
     * @return int Unix timestamp representing the last modification time
     */
    public static function lastModifiedTime(string ...$paths): int
    {
        if (empty($paths)) {
            throw new LogicException('Path is required.');
        }

        $times = [];

        foreach ($paths as $path) {
            $times[] = static::modifiedTime($path);

            if (is_file($path)) {
                continue;
            }

            /** @var iterable<string, string> $iterator */
            $iterator = new RecursiveIteratorIterator(
                new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS),
                RecursiveIteratorIterator::SELF_FIRST
            );

            foreach ($iterator as $p => $info) {
                $times[] = static::modifiedTime($p);
            }
        }

        /** @psalm-suppress ArgumentTypeCoercion */
        return max($times);
    }

    private static function modifiedTime(string $path): int
    {
        return (int)filemtime($path);
    }

    /**
     * Returns the directories found under the specified directory and subdirectories.
     *
     * @param string $directory the directory under which the files will be looked for.
     * @param array $options options for directory searching. Valid options are:
     *
     * - filter: a filter to apply while looked directories. It should be an instance of {@see PathMatcherInterface}.
     * - recursive: boolean, whether the subdirectories should also be looked for. Defaults to `true`.
     *
     * @psalm-param array{
     *   filter?: \Yiisoft\Files\PathMatcher\PathMatcherInterface,
     *   recursive?: bool,
     * } $options
     *
     * @throws InvalidArgumentException if the directory is invalid.
     *
     * @return string[] directories found under the directory, in no particular order.
     * Ordering depends on the files system used.
     */
    public static function findDirectories(string $directory, array $options = []): array
    {
        if (!is_dir($directory)) {
            throw new InvalidArgumentException("The \"directory\" argument must be a directory: $directory");
        }
        $directory = static::normalizePath($directory);

        $result = [];

        $handle = static::openDirectory($directory);
        while (false !== $file = readdir($handle)) {
            if ($file === '.' || $file === '..') {
                continue;
            }

            $path = $directory . '/' . $file;
            if (is_file($path)) {
                continue;
            }

            if (!isset($options['filter']) || $options['filter']->match($path)) {
                $result[] = $path;
            }

            if (!isset($options['recursive']) || $options['recursive']) {
                $result = array_merge($result, static::findDirectories($path, $options));
            }
        }
        closedir($handle);

        return $result;
    }

    /**
     * Returns the files found under the specified directory and subdirectories.
     *
     * @param string $directory the directory under which the files will be looked for.
     * @param array $options options for file searching. Valid options are:
     *
     * - filter: a filter to apply while looked files. It should be an instance of {@see PathMatcherInterface}.
     * - recursive: boolean, whether the files under the subdirectories should also be looked for. Defaults to `true`.
     *
     * @psalm-param array{
     *   filter?: \Yiisoft\Files\PathMatcher\PathMatcherInterface,
     *   recursive?: bool,
     * } $options
     *
     * @throws InvalidArgumentException if the dir is invalid.
     *
     * @return array files found under the directory, in no particular order.
     * Ordering depends on the files system used.
     */
    public static function findFiles(string $directory, array $options = []): array
    {
        if (!is_dir($directory)) {
            throw new InvalidArgumentException("The \"directory\" argument must be a directory: $directory");
        }
        $directory = static::normalizePath($directory);

        $result = [];

        $handle = static::openDirectory($directory);
        while (false !== $file = readdir($handle)) {
            if ($file === '.' || $file === '..') {
                continue;
            }

            $path = $directory . '/' . $file;

            if (is_file($path)) {
                if (!isset($options['filter']) || $options['filter']->match($path)) {
                    $result[] = $path;
                }
                continue;
            }

            if (!isset($options['recursive']) || $options['recursive']) {
                $result = array_merge($result, static::findFiles($path, $options));
            }
        }
        closedir($handle);

        return $result;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Files;
6
7		use Exception;
8		use FilesystemIterator;
9		use InvalidArgumentException;
10		use LogicException;
11		use RecursiveDirectoryIterator;
12		use RecursiveIteratorIterator;
13		use RuntimeException;
14		use Throwable;
15
16		/**
17		* FileHelper provides useful methods to manage files and directories
18		*/
19		class FileHelper
20		{
21		/**
22		* Opens a file or URL.
23		*
24		* This method is similar to the PHP `fopen()` function, except that it suppresses the `E_WARNING`
25		* level error and throws the `\RuntimeException` exception if it can't open the file.
26		*
27		* @param string $filename The file or URL.
28		* @param string $mode The type of access.
29		* @param bool $useIncludePath Whether to search for a file in the include path.
30		* @param resource\|null $context The stream context or `null`.
31		*
32		* @throws RuntimeException If the file could not be opened.
33		*
34		* @return resource The file pointer resource.
35		*
36		* @psalm-suppress PossiblyNullArgument
37		*/
38	3	public static function openFile(string $filename, string $mode, bool $useIncludePath = false, $context = null)
39		{
40	3	$filePointer = @fopen($filename, $mode, $useIncludePath, $context);
41
42	3	if ($filePointer === false) {
43	1	throw new RuntimeException("The file \"{$filename}\" could not be opened.");
44		}
45
46	2	return $filePointer;
47		}
48
49		/**
50		* Creates a new directory.
51		*
52		* This method is similar to the PHP `mkdir()` function except that it uses `chmod()` to set the permission of the
53		* created directory in order to avoid the impact of the `umask` setting.
54		*
55		* @param string $path path of the directory to be created.
56		* @param int $mode the permission to be set for the created directory.
57		*
58		* @return bool whether the directory is created successfully.
59		*/
60	52	public static function createDirectory(string $path, int $mode = 0775): bool
61		{
62	52	$path = static::normalizePath($path);
63
64		try {
65	52	if (!mkdir($path, $mode, true) && !is_dir($path)) {
66	52	return false;
67		}
68	2	} catch (Exception $e) {
69	2	if (!is_dir($path)) {
70	1	throw new RuntimeException(
71	1	'Failed to create directory "' . $path . '": ' . $e->getMessage(),
72	1	(int)$e->getCode(),
73		$e
74		);
75		}
76		}
77
78	52	return chmod($path, $mode);
79		}
80
81		/**
82		* Normalizes a file/directory path.
83		*
84		* The normalization does the following work:
85		*
86		* - Convert all directory separators into `/` (e.g. "\a/b\c" becomes "/a/b/c")
87		* - Remove trailing directory separators (e.g. "/a/b/c/" becomes "/a/b/c")
88		* - Turn multiple consecutive slashes into a single one (e.g. "/a///b/c" becomes "/a/b/c")
89		* - Remove ".." and "." based on their meanings (e.g. "/a/./b/../c" becomes "/a/c")
90		*
91		* @param string $path the file/directory path to be normalized
92		*
93		* @return string the normalized file/directory path
94		*/
95	52	public static function normalizePath(string $path): string
96		{
97	52	$isWindowsShare = strpos($path, '\\\\') === 0;
98
99	52	if ($isWindowsShare) {
100	1	$path = substr($path, 2);
101		}
102
103	52	$path = rtrim(strtr($path, '/\\', '//'), '/');
104
105	52	if (strpos('/' . $path, '/.') === false && strpos($path, '//') === false) {
106	52	return $isWindowsShare ? "\\\\$path" : $path;
107		}
108
109	1	$parts = [];
110
111	1	foreach (explode('/', $path) as $part) {
112	1	if ($part === '..' && !empty($parts) && end($parts) !== '..') {
113	1	array_pop($parts);
114	1	} elseif ($part !== '.' && ($part !== '' \|\| empty($parts))) {
115	1	$parts[] = $part;
116		}
117		}
118
119	1	$path = implode('/', $parts);
120
121	1	if ($isWindowsShare) {
122	1	$path = '\\\\' . $path;
123		}
124
125	1	return $path === '' ? '.' : $path;
126		}
127
128		/**
129		* Removes a directory (and all its content) recursively.
130		*
131		* @param string $directory the directory to be deleted recursively.
132		* @param array $options options for directory remove ({@see clearDirectory()}).
133		*/
134	52	public static function removeDirectory(string $directory, array $options = []): void
135		{
136		try {
137	52	static::clearDirectory($directory, $options);
138	1	} catch (InvalidArgumentException $e) {
139	1	return;
140		}
141
142	52	if (is_link($directory)) {
143	2	self::unlink($directory);
144		} else {
145	52	rmdir($directory);
146		}
147	52	}
148
149		/**
150		* Clear all directory content.
151		*
152		* @param string $directory the directory to be cleared.
153		* @param array $options options for directory clear . Valid options are:
154		*
155		* - traverseSymlinks: boolean, whether symlinks to the directories should be traversed too.
156		* Defaults to `false`, meaning the content of the symlinked directory would not be deleted.
157		* Only symlink would be removed in that default case.
158		*
159		* @throws InvalidArgumentException if unable to open directory
160		*/
161	52	public static function clearDirectory(string $directory, array $options = []): void
162		{
163	52	$handle = static::openDirectory($directory);
164	52	if (!empty($options['traverseSymlinks']) \|\| !is_link($directory)) {
165	52	while (($file = readdir($handle)) !== false) {
166	52	if ($file === '.' \|\| $file === '..') {
167	52	continue;
168		}
169	37	$path = $directory . '/' . $file;
170	37	if (is_dir($path)) {
171	36	self::removeDirectory($path, $options);
172		} else {
173	27	self::unlink($path);
174		}
175		}
176	52	closedir($handle);
177		}
178	52	}
179
180		/**
181		* Removes a file or symlink in a cross-platform way.
182		*
183		* @param string $path
184		*
185		* @return bool
186		*/
187	31	public static function unlink(string $path): bool
188		{
189	31	$isWindows = DIRECTORY_SEPARATOR === '\\';
190
191	31	if (!$isWindows) {
192	31	return unlink($path);
193		}
194
195		if (is_link($path)) {
196		try {
197		return unlink($path);
198		} catch (Throwable $e) {
199		return rmdir($path);
200		}
201		}
202
203		if (file_exists($path) && !is_writable($path)) {
204		chmod($path, 0777);
205		}
206
207		return unlink($path);
208		}
209
210		/**
211		* Tells whether the path is a empty directory
212		*
213		* @param string $path
214		*
215		* @return bool
216		*/
217	1	public static function isEmptyDirectory(string $path): bool
218		{
219	1	if (!is_dir($path)) {
220	1	return false;
221		}
222
223	1	return !(new FilesystemIterator($path))->valid();
224		}
225
226		/**
227		* Copies a whole directory as another one.
228		*
229		* The files and sub-directories will also be copied over.
230		*
231		* @param string $source the source directory.
232		* @param string $destination the destination directory.
233		* @param array $options options for directory copy. Valid options are:
234		*
235		* - dirMode: integer, the permission to be set for newly copied directories. Defaults to 0775.
236		* - fileMode: integer, the permission to be set for newly copied files. Defaults to the current environment
237		* setting.
238		* - filter: a filter to apply while copying files. It should be an instance of {@see PathMatcherInterface}.
239		* - recursive: boolean, whether the files under the subdirectories should also be copied. Defaults to true.
240		* - beforeCopy: callback, a PHP callback that is called before copying each sub-directory or file. If the callback
241		* returns false, the copy operation for the sub-directory or file will be cancelled. The signature of the
242		* callback should be: `function ($from, $to)`, where `$from` is the sub-directory or file to be copied from,
243		* while `$to` is the copy target.
244		* - afterCopy: callback, a PHP callback that is called after each sub-directory or file is successfully copied.
245		* The signature of the callback should be: `function ($from, $to)`, where `$from` is the sub-directory or file
246		* copied from, while `$to` is the copy target.
247		* - copyEmptyDirectories: boolean, whether to copy empty directories. Set this to false to avoid creating
248		* directories that do not contain files. This affects directories that do not contain files initially as well as
249		* directories that do not contain files at the target destination because files have been filtered via `only` or
250		* `except`. Defaults to true.
251		*
252		* @throws InvalidArgumentException if unable to open directory
253		* @throws Exception
254		*
255		* @psalm-param array{
256		* dirMode?: int,
257		* fileMode?: int,
258		* filter?: \Yiisoft\Files\PathMatcher\PathMatcherInterface,
259		* recursive?: bool,
260		* beforeCopy?: callable,
261		* afterCopy?: callable,
262		* copyEmptyDirectories?: bool,
263		* } $options
264		*/
265	12	public static function copyDirectory(string $source, string $destination, array $options = []): void
266		{
267	12	$source = static::normalizePath($source);
268	12	$destination = static::normalizePath($destination);
269
270	12	static::assertNotSelfDirectory($source, $destination);
271
272	10	$destinationExists = is_dir($destination);
273		if (
274	10	!$destinationExists &&
275	10	(!isset($options['copyEmptyDirectories']) \|\| $options['copyEmptyDirectories'])
276		) {
277	6	static::createDirectory($destination, $options['dirMode'] ?? 0775);
278	6	$destinationExists = true;
279		}
280
281	10	$handle = static::openDirectory($source);
282
283	9	if (!isset($options['basePath'])) {
284	9	$options['basePath'] = realpath($source);
285		}
286
287	9	while (($file = readdir($handle)) !== false) {
288	9	if ($file === '.' \|\| $file === '..') {
289	9	continue;
290		}
291
292	7	$from = $source . '/' . $file;
293	7	$to = $destination . '/' . $file;
294
295	7	if (!isset($options['filter']) \|\| $options['filter']->match($from)) {
296	7	if (is_file($from)) {
297	7	if (!$destinationExists) {
298	2	static::createDirectory($destination, $options['dirMode'] ?? 0775);
299	2	$destinationExists = true;
300		}
301	7	copy($from, $to);
302	7	if (isset($options['fileMode'])) {
303	7	chmod($to, $options['fileMode']);
304		}
305	6	} elseif (!isset($options['recursive']) \|\| $options['recursive']) {
306	5	static::copyDirectory($from, $to, $options);
307		}
308		}
309		}
310
311	9	closedir($handle);
312	9	}
313
314		/**
315		* Check copy it self directory.
316		*
317		* @param string $source
318		* @param string $destination
319		*
320		* @throws InvalidArgumentException
321		*/
322	12	private static function assertNotSelfDirectory(string $source, string $destination): void
323		{
324	12	if ($source === $destination \|\| strpos($destination, $source . '/') === 0) {
325	2	throw new InvalidArgumentException('Trying to copy a directory to itself or a subdirectory.');
326		}
327	10	}
328
329		/**
330		* Open directory handle.
331		*
332		* @param string $directory
333		*
334		* @throws InvalidArgumentException
335		*
336		* @return resource
337		*/
338	52	private static function openDirectory(string $directory)
339		{
340	52	$handle = @opendir($directory);
341
342	52	if ($handle === false) {
343	3	throw new InvalidArgumentException("Unable to open directory: $directory");
344		}
345
346	52	return $handle;
347		}
348
349		/**
350		* Returns the last modification time for the given path.
351		*
352		* If the path is a directory, any nested files/directories will be checked as well.
353		*
354		* @param string ...$paths the directory to be checked
355		*
356		* @throws LogicException when path not set
357		*
358		* @return int Unix timestamp representing the last modification time
359		*/
360	2	public static function lastModifiedTime(string ...$paths): int
361		{
362	2	if (empty($paths)) {
363	1	throw new LogicException('Path is required.');
364		}
365
366	1	$times = [];
367
368	1	foreach ($paths as $path) {
369	1	$times[] = static::modifiedTime($path);
370
371	1	if (is_file($path)) {
372	1	continue;
373		}
374
375		/** @var iterable<string, string> $iterator */
376	1	$iterator = new RecursiveIteratorIterator(
377	1	new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS),
378	1	RecursiveIteratorIterator::SELF_FIRST
379		);
380
381	1	foreach ($iterator as $p => $info) {
382	1	$times[] = static::modifiedTime($p);
383		}
384		}
385
386		/** @psalm-suppress ArgumentTypeCoercion */
387	1	return max($times);
388		}
389
390	1	private static function modifiedTime(string $path): int
391		{
392	1	return (int)filemtime($path);
393		}
394
395		/**
396		* Returns the directories found under the specified directory and subdirectories.
397		*
398		* @param string $directory the directory under which the files will be looked for.
399		* @param array $options options for directory searching. Valid options are:
400		*
401		* - filter: a filter to apply while looked directories. It should be an instance of {@see PathMatcherInterface}.
402		* - recursive: boolean, whether the subdirectories should also be looked for. Defaults to `true`.
403		*
404		* @psalm-param array{
405		* filter?: \Yiisoft\Files\PathMatcher\PathMatcherInterface,
406		* recursive?: bool,
407		* } $options
408		*
409		* @throws InvalidArgumentException if the directory is invalid.
410		*
411		* @return string[] directories found under the directory, in no particular order.
412		* Ordering depends on the files system used.
413		*/
414	5	public static function findDirectories(string $directory, array $options = []): array
415		{
416	5	if (!is_dir($directory)) {
417	1	throw new InvalidArgumentException("The \"directory\" argument must be a directory: $directory");
418		}
419	4	$directory = static::normalizePath($directory);
420
421	4	$result = [];
422
423	4	$handle = static::openDirectory($directory);
424	4	while (false !== $file = readdir($handle)) {
425	4	if ($file === '.' \|\| $file === '..') {
426	4	continue;
427		}
428
429	4	$path = $directory . '/' . $file;
430	4	if (is_file($path)) {
431	3	continue;
432		}
433
434	4	if (!isset($options['filter']) \|\| $options['filter']->match($path)) {
435	4	$result[] = $path;
436		}
437
438	4	if (!isset($options['recursive']) \|\| $options['recursive']) {
439	3	$result = array_merge($result, static::findDirectories($path, $options));
440		}
441		}
442	4	closedir($handle);
443
444	4	return $result;
445		}
446
447		/**
448		* Returns the files found under the specified directory and subdirectories.
449		*
450		* @param string $directory the directory under which the files will be looked for.
451		* @param array $options options for file searching. Valid options are:
452		*
453		* - filter: a filter to apply while looked files. It should be an instance of {@see PathMatcherInterface}.
454		* - recursive: boolean, whether the files under the subdirectories should also be looked for. Defaults to `true`.
455		*
456		* @psalm-param array{
457		* filter?: \Yiisoft\Files\PathMatcher\PathMatcherInterface,
458		* recursive?: bool,
459		* } $options
460		*
461		* @throws InvalidArgumentException if the dir is invalid.
462		*
463		* @return array files found under the directory, in no particular order.
464		* Ordering depends on the files system used.
465		*/
466	4	public static function findFiles(string $directory, array $options = []): array
467		{
468	4	if (!is_dir($directory)) {
469		throw new InvalidArgumentException("The \"directory\" argument must be a directory: $directory");
470		}
471	4	$directory = static::normalizePath($directory);
472
473	4	$result = [];
474
475	4	$handle = static::openDirectory($directory);
476	4	while (false !== $file = readdir($handle)) {
477	4	if ($file === '.' \|\| $file === '..') {
478	4	continue;
479		}
480
481	4	$path = $directory . '/' . $file;
482
483	4	if (is_file($path)) {
484	4	if (!isset($options['filter']) \|\| $options['filter']->match($path)) {
485	4	$result[] = $path;
486		}
487	4	continue;
488		}
489
490	4	if (!isset($options['recursive']) \|\| $options['recursive']) {
491	3	$result = array_merge($result, static::findFiles($path, $options));
492		}
493		}
494	4	closedir($handle);
495
496	4	return $result;
497		}
498		}
499

yiisoft / files

Pull Request — master (#39)

FileHelper::findFiles() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like