As3\Modlr\Metadata\Driver\FileLocator

Complexity

Total Complexity

13

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getDirectories()	0	4	1
A	findFileForMixin()	0	4	1
A	findFileForType()	0	4	1
A	findFile()	0	10	3
A	findAllTypes()	0	19	4
A	getFilename()	0	4	1
A	__construct()	0	6	1
A	findFileForEmbed()	0	4	1

<?php

namespace As3\Modlr\Metadata\Driver;

/**
 * File locator service for locating metadata files for use in creating EntityMetadata instances.
 *
 * @author Jacob Bare <jacob.bare@gmail.com>
 */
final class FileLocator implements FileLocatorInterface
{
    /**
     * Directories to search in.
     *
     * @var array
     */
    private $directories = [
        'model'     => [],
        'mixin'     => [],
        'embed'     => [],
    ];

    /**
     * Constructor.
     *
     * @param   string|array   $modelDirs
     * @param   string|array   $mixinDirs
     * @param   string|array   $embedDirs
     */
    public function __construct($modelDirs, $mixinDirs = [], $embedDirs = [])
    {
        $this->directories['model'] = (Array) $modelDirs;
        $this->directories['mixin'] = (Array) $mixinDirs;
        $this->directories['embed'] = (Array) $embedDirs;
    }

    /**
     * Gets the directories to search in.
     *
     * @param   string  $type   The directory type, either model or mixin.
     * @return  array
     */
    protected function getDirectories($type)
    {
        return $this->directories[$type];
    }

    /**
     * {@inheritDoc}
     */
    public function findFileForEmbed($embedName, $extension)
    {
        return $this->findFile('embed', $embedName, $extension);
    }

    /**
     * {@inheritDoc}
     */
    public function findFileForMixin($mixinName, $extension)
    {
        return $this->findFile('mixin', $mixinName, $extension);
    }

    /**
     * {@inheritDoc}
     */
    public function findFileForType($modelType, $extension)
    {
        return $this->findFile('model', $modelType, $extension);
    }

    /**
     * Finds a file based on a directory type (model or mixin) and a key.
     *
     * @param   string  $dirType
     * @param   string  $key
     * @param   string  $extension
     * @return  string|null
     */
    protected function findFile($dirType, $key, $extension)
    {
        foreach ($this->getDirectories($dirType) as $dir) {
            $path = sprintf('%s/%s', $dir, $this->getFilename($key, $extension));
            if (file_exists($path)) {
                return $path;
            }
        }
        return null;
    }

    /**
     * {@inheritDoc}
     */
    public function findAllTypes($extension)
    {
        $types = [];
        $extension = sprintf('.%s', $extension);

        foreach ($this->getDirectories('model') as $dir) {
            $iterator = new \RecursiveIteratorIterator(
                new \RecursiveDirectoryIterator($dir),
                \RecursiveIteratorIterator::LEAVES_ONLY
            );
            foreach ($iterator as $file) {
                if (($fileName = $file->getBasename($extension)) == $file->getBasename()) {
                    continue;
                }
                $types[] = str_replace($extension, '', $fileName);
            }
        }
        return $types;
    }

    /**
     * Gets the filename for a metadata entity or mixin.
     *
     * @param   string      $key
     * @param   string      $extension
     * @return  string
     */
    protected function getFilename($key, $extension)
    {
        return sprintf('%s.%s', $key, $extension);
    }
}