Iterator.php

<?php

declare (strict_types=1);

/*
 * This file is part of phpunit/php-file-iterator.
 *
 * (c) Sebastian Bergmann <sebastian@phpunit.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace SebastianBergmann\FileIterator;

use function assert;
use function preg_match;
use function realpath;
use function str_ends_with;
use function str_replace;
use function str_starts_with;
use AppendIterator;
use FilterIterator;
use SplFileInfo;

/**
 * @template-extends FilterIterator<int, string, AppendIterator>
 *
 * @internal This class is not covered by the backward compatibility promise for phpunit/php-file-iterator
 */
final class Iterator extends FilterIterator {
    public const PREFIX = 0;
    public const SUFFIX = 1;
    private string|false $basePath;
    
    /**
     * @psalm-var list<string>
     */
    private array $suffixes;
    
    /**
     * @psalm-var list<string>
     */
    private array $prefixes;
    
    /**
     * @psalm-param list<string> $suffixes
     * @psalm-param list<string> $prefixes
     */
    public function __construct(string $basePath, \Iterator $iterator, array $suffixes = [], array $prefixes = []) {
        $this->basePath = realpath($basePath);
        $this->prefixes = $prefixes;
        $this->suffixes = $suffixes;
        parent::__construct($iterator);
    }
    public function accept() : bool {
        $current = $this->getInnerIterator()
            ->current();
        assert($current instanceof SplFileInfo);
        $filename = $current->getFilename();
        $realPath = $current->getRealPath();
        if ($realPath === false) {
            // @codeCoverageIgnoreStart
            return false;
            // @codeCoverageIgnoreEnd
        }
        return $this->acceptPath($realPath) && $this->acceptPrefix($filename) && $this->acceptSuffix($filename);
    }
    private function acceptPath(string $path) : bool {
        // Filter files in hidden directories by checking path that is relative to the base path.
        if (preg_match('=/\\.[^/]*/=', str_replace((string) $this->basePath, '', $path))) {
            return false;
        }
        return true;
    }
    private function acceptPrefix(string $filename) : bool {
        return $this->acceptSubString($filename, $this->prefixes, self::PREFIX);
    }
    private function acceptSuffix(string $filename) : bool {
        return $this->acceptSubString($filename, $this->suffixes, self::SUFFIX);
    }
    
    /**
     * @psalm-param list<string> $subStrings
     */
    private function acceptSubString(string $filename, array $subStrings, int $type) : bool {
        if (empty($subStrings)) {
            return true;
        }
        foreach ($subStrings as $string) {
            if ($type === self::PREFIX && str_starts_with($filename, $string) || $type === self::SUFFIX && str_ends_with($filename, $string)) {
                return true;
            }
        }
        return false;
    }

}