Flyfinder\Finder

Complexity

Total Complexity

16

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getMethod()	0	4	1
A	setFilesystem()	0	4	1
A	handle()	0	8	4
B	yieldFilesInPath()	0	21	7
A	getAlgorithm()	0	4	1
A	setAlgorithm()	0	4	2

<?php
declare(strict_types=1);

/**
 * This file is part of phpDocumentor.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @copyright 2010-2018 Mike van Riel<mike@phpdoc.org>
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace Flyfinder;

use Flyfinder\Specification\SpecificationInterface;
use Generator;
use League\Flysystem\FilesystemInterface;
use League\Flysystem\PluginInterface;

/**
 * Flysystem plugin to add file finding capabilities to the filesystem entity.
 *
 * Note that found *directories* are **not** returned... only found *files*.
 */
class Finder implements PluginInterface
{
    const ALGORITHM_LEGACY = 0;
    const ALGORITHM_OPTIMIZED = 1;

    /** @var FilesystemInterface */
    private $filesystem;

    /** @var int */
    private $algorithm = self::ALGORITHM_LEGACY;

    /**
     * Get the method name.
     */
    public function getMethod(): string
    {
        return 'find';
    }

    /**
     * Set the Filesystem object.
     */
    public function setFilesystem(FilesystemInterface $filesystem): void
    {
        $this->filesystem = $filesystem;
    }

    /**
     * Find the specified files
     *
     * Note that only found *files* are yielded at this level,
     * which go back to the caller.
     */
    public function handle(SpecificationInterface $specification): Generator
    {
        foreach ($this->yieldFilesInPath($specification, '') as $path) {
            if (isset($path['type']) && $path['type'] === 'file') {
                yield $path;
            }
        }
    }

    /**
     * Recursively yield files that meet the specification
     *
     * Note that directories are also yielded at this level,
     * since they have to be recursed into.  Yielded directories
     * will not make their way back to the caller, as they are filtered out
     * by {@link handle()}.
     * @param SpecificationInterface $specification
     * @param string $path
     * @return Generator
     */
    private function yieldFilesInPath(SpecificationInterface $specification, string $path): Generator
    {
        $listContents = $this->filesystem->listContents($path);
        foreach ($listContents as $location) {
            if ($specification->isSatisfiedBy($location)) {
                yield $location;
            }

            if ($location['type'] === 'dir') {
                if (
                    self::ALGORITHM_OPTIMIZED === $this->algorithm
                    && !$specification->canBeSatisfiedByAnythingBelow($location)
                ) {
                    continue;
                }
                foreach ($this->yieldFilesInPath($specification, $location['path']) as $returnedLocation) {
                    yield $returnedLocation;
                }
            }
        }
    }

    /**
     * @return int
     */
    public function getAlgorithm(): int
    {
        return $this->algorithm;
    }

    /**
     * @param int $algorithm
     */
    public function setAlgorithm(int $algorithm): void
    {
        $this->algorithm = self::ALGORITHM_OPTIMIZED === $algorithm ? $algorithm : self::ALGORITHM_LEGACY;
    }
}