Naneau\ProjectVersioner\Reader\Finder\Finder

Complexity

Total Complexity

7

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	18	3
A	canRead()	0	12	2
A	getFinder()	0	4	1
A	setFinder()	0	6	1

<?php
/**
 * Finder.php
 *
 * @package         ProjectVersioner
 * @subpackage      Reader
 */

namespace Naneau\ProjectVersioner\Reader\Finder;

use Naneau\ProjectVersioner\ReaderInterface;

use Symfony\Component\Finder\Finder as SfFinder;

/**
 * Finder
 *
 * Base class for finder based readers
 *
 * @category        Naneau
 * @package         ProjectVersioner
 * @subpackage      Reader
 */
abstract class Finder implements ReaderInterface
{
    /**
     * the finder
     *
     * @var SfFinder
     */
    private $finder;

    /**
     * Constructor
     *
     * @param  string   $name   limiting names
     * @param  SfFinder $finder
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     **/
    public function __construct($name = null, SfFinder $finder = null)
    {
        // Create finder if not given
        if ($finder === null) {
            $finder = new SfFinder;
        }

        // Set name if given
        if (!empty($name)) {
            $finder->name($name);
        }

        // Sort by name
        $finder->sortByName();

        // Set the finder
        $this->setFinder($finder);
    }

    /**
     * {@inheritdoc}
     **/
    public function canRead($directory)
    {
        // Update finder directory
        $this->getFinder()->in($directory);

        // If at least one file/dir can be found, assume we can read
        foreach ($this->getFinder() as $file) {
            return true;
        }

        return false;
    }

    /**
     * Get the finder
     *
     * @return SfFinder
     */
    public function getFinder()
    {
        return $this->finder;
    }

    /**
     * Set the finder
     *
     * @param  SfFinder $finder
     * @return SfFinder
     */
    public function setFinder(SfFinder $finder)
    {
        $this->finder = $finder;

        return $this;
    }
}