allejo\stakx\Manager\CollectionManager

Complexity

Total Complexity

16

Size/Duplication

Total Lines	162
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	5

Test Coverage

Coverage

65.96%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getCollections()	0	4	1
A	createNewItem()	0	8	1
A	refreshItem()	0	4	1
A	getContentItem()	0	9	2
A	getJailedCollections()	0	14	3
B	parseCollections()	0	36	4
A	handleTrackableItem()	0	17	1
A	getTentativeCollectionName()	0	12	3

<?php

/**
 * @copyright 2017 Vladimir Jimenez
 * @license   https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
 */

namespace allejo\stakx\Manager;

use allejo\stakx\Exception\TrackedItemNotFoundException;
use allejo\stakx\Object\ContentItem;
use allejo\stakx\Object\JailObject;

/**
 * The class that reads and saves information about all of the collections
 *
 * @package allejo\stakx\Manager
 */
class CollectionManager extends TrackingManager
{
    /**
     * A copy of the collection definitions to be available for later usage
     *
     * @var string[][]
     */
    private $collectionDefinitions;

    /**
     * Get all of the ContentItems grouped by Collection name
     *
     * @return ContentItem[][]
     */
    public function &getCollections ()
    {
        return $this->trackedItems;
    }

    /**
     * Get a ContentItem from a Collection pased on it's path
     *
     * @param  string $filePath
     *
     * @throws TrackedItemNotFoundException
     *
     * @return ContentItem
     */
    public function &getContentItem ($filePath)
    {
        if (!isset($this->trackedItemsFlattened[$filePath]))
        {
            throw new TrackedItemNotFoundException("The ContentItem at '$filePath' was not found.");
        }

        return $this->trackedItemsFlattened[$filePath];
    }

    /**
     * A jailed representation of CollectionManager::getCollections()
     *
     * @return JailObject[][]
     */
    public function getJailedCollections ()
    {
        $jailItems = array();

        foreach ($this->trackedItems as $key => $items)
        {
            foreach ($items as $name => $contentItem)
            {
                $jailItems[$key][$name] = $contentItem->createJail();
            }
        }

        return $jailItems;
    }

    /**
     * Parse every collection and store them in the manager
     *
     * @param string[][] $collections An array of definitions for collections
     */
    public function parseCollections ($collections)
    {
        if ($collections === null)
        {
            $this->output->debug("No collections found, nothing to parse.");
            return;
        }

        $this->collectionDefinitions = $collections;

        /**
         * The information which each collection has taken from the configuration file
         *
         * $collection['name']      string The name of the collection
         *            ['folder']    string The folder where this collection has its ContentItems
         *
         * @var $collection array
         */
        foreach ($collections as $collection)
        {
            $this->output->notice("Loading '{$collection['name']}' collection...");

            $collectionFolder = $this->fs->absolutePath($collection['folder']);

            if (!$this->fs->exists($collectionFolder))
            {
                $this->output->warning("The folder '{$collection['folder']}' could not be found for the '{$collection['name']}' collection");
                continue;
            }

            $this->saveFolderDefinition($collection['folder'], $collection);
            $this->scanTrackableItems($collectionFolder, array(
                'namespace' => $collection['name']
            ));
        }
    }

    /**
     * {@inheritdoc}
     */
    public function createNewItem($filePath)
    {
        $collection = $this->getTentativeCollectionName($filePath);

        return $this->handleTrackableItem($filePath, array(
            'namespace' => $collection
        ));
    }

    /**
     * {@inheritdoc}
     */
    public function refreshItem($filePath)
    {
        return;
    }

    /**
     * {@inheritdoc}
     */
    protected function handleTrackableItem($filePath, $options = array())
    {
        $collectionName = $options['namespace'];

        $contentItem = new ContentItem($filePath);
        $contentItem->setCollection($collectionName);

        $this->addObjectToTracker($contentItem, $contentItem->getName(), $collectionName);

        $this->output->info(sprintf(
            "Loading ContentItem into '%s' collection: %s",
            $collectionName,
            $this->fs->getRelativePath($filePath)
        ));

        return $contentItem;
    }

    /**
     * Get the name of the Collection this Content Item belongs to
     *
     * @param  string $filePath
     *
     * @return string
     */
    private function getTentativeCollectionName ($filePath)
    {
        foreach ($this->collectionDefinitions as $collection)
        {
            if (strpos($filePath, $collection['folder']) === 0)
            {
                return $collection['name'];
            }
        }

        return '';
    }

}