Michaels\Manager\Traits\LoadsFilesTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	66
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	4
Bugs	0	Features	2

6 Methods

Rating	Name	Duplication	Size	Complexity
A	initializeFileLoader()	0	6	3
A	loadFiles()	0	7	1
A	loadFile()	0	4	1
A	addDecoder()	0	5	1
A	getFileLoader()	0	4	1
A	setFileLoader()	0	4	1

<?php
namespace Michaels\Manager\Traits;

/**
 * Allows a class to have file loading capabilities.
 *
 * @implements Michaels\Manager\Contracts\ManagesItemsInterface
 * @package Michaels\Manager
 */

use Michaels\Manager\Contracts\DecoderInterface;
use Michaels\Manager\FileLoader;

/**
 * Loads data from configuration-type files into Manager
 * @package Michaels\Manager\Traits
 */
trait LoadsFilesTrait
{
    use DependsOnManagesItemsTrait;

    /** @var  \Michaels\Manager\FileLoader Instance of the FileLoader */
    protected $fileLoader;

    /**
     * Makes sure a FileLoader object was created or creates one.
     * @param FileLoader $fileLoader
     */
    protected function initializeFileLoader(FileLoader $fileLoader = null)
    {
        if (!isset($this->fileLoader)) {
            $this->setFileLoader(($fileLoader) ? $fileLoader : new FileLoader());
        }
    }

    /**
     * This method adds the file loading functionality.
     *
     * @param array $files an array of SplFileInfo Objects
     * @param $append boolean true, if data should be appended to the manager.
     * @return array

Should the return type not be array|null?

     */
    public function loadFiles(array $files, $append = false)
    {
        $this->initializeFileLoader();
        $this->fileLoader->addFiles($files);
        $data = $this->fileLoader->process();
        $this->hydrate($data, $append);

It seems like hydrate() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    public function loadFile($file, $append = false)
    {
        return $this->loadFiles([$file], $append);
    }

    /**
     * Allows for the addition of a custom decoder to the manager load files system.
     *
     * @param DecoderInterface $decoder
     * @return mixed
     */
    public function addDecoder(DecoderInterface $decoder)
    {
        $this->initializeFileLoader();
        $this->fileLoader->addDecoder($decoder);
    }

    /**
     * @return FileLoader
     */
    public function getFileLoader()
    {
        return $this->fileLoader;
    }

    /**
     * @param FileLoader $fileLoader
     */
    public function setFileLoader($fileLoader)
    {
        $this->fileLoader = $fileLoader;
    }
}