PageManager::handleTrackableItem() - Code Metrics - Inspection of "Move markup engines to a DI setup in the container" - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#61)

by Vladimir

created 2018-05-09 06:39 UTC

PageManager::handleTrackableItem() B

↳ Parent: PageManager

Complexity

Conditions	4
Paths	4

Size

Total Lines	29
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	4.1054

Importance

Changes

Metric	Value
dl	0
loc	29
rs	8.5806
c	0
b	0
f	0
ccs	13
cts	16
cp	0.8125
cc	4
eloc	18
nc	4
nop	2
crap	4.1054

<?php

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

namespace allejo\stakx\Manager;

use allejo\stakx\Configuration;
use allejo\stakx\Document\BasePageView;
use allejo\stakx\Document\ContentItem;
use allejo\stakx\Document\DataItem;
use allejo\stakx\Document\DynamicPageView;
use allejo\stakx\Document\JailedDocument;
use allejo\stakx\Document\RepeaterPageView;
use allejo\stakx\Document\StaticPageView;
use allejo\stakx\Filesystem\File;
use allejo\stakx\Filesystem\FilesystemLoader as fs;
use allejo\stakx\Event\PageViewsCompleted;
use allejo\stakx\Exception\CollectionNotFoundException;
use allejo\stakx\Filesystem\FileExplorer;
use Psr\Log\LoggerInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;

/**
 * This class is responsible for handling all of the PageViews within a website.
 *
 * PageManager will parse all available dynamic and static PageViews. After, dynamic PageViews will be prepared by
 * setting the appropriate values for each ContentItem such as permalinks.
 */
class PageManager extends TrackingManager
{
    /** @var StaticPageView[] A place to store a reference to static PageViews with titles. */
    private $staticPages;
    private $configuration;
    private $collectionManager;
    private $dataManager;
    private $eventDispatcher;
    private $logger;

    /**
     * PageManager constructor.
     */
    public function __construct(Configuration $configuration, CollectionManager $collectionManager, DataManager $dataManager, EventDispatcherInterface $eventDispatcher, LoggerInterface $logger)
    {
        $this->trackedItems = [
            BasePageView::STATIC_TYPE   => [],
            BasePageView::DYNAMIC_TYPE  => [],
            BasePageView::REPEATER_TYPE => [],
        ];
        $this->staticPages = [];
        $this->configuration = $configuration;
        $this->collectionManager = $collectionManager;
        $this->dataManager = $dataManager;
        $this->eventDispatcher = $eventDispatcher;
        $this->logger = $logger;
    }

    /**
     * {@inheritdoc}
     */
    public function compileManager()
    {
        $this->parsePageViews($this->configuration->getPageViewFolders());
    }

    /**
     * Go through all of the PageView directories and create a respective PageView for each and classify them by type.
     *
     * @param string[] $pageViewFolders
     *
     * @since 0.1.0
     */
    public function parsePageViews(array $pageViewFolders)
    {
        foreach ($pageViewFolders as $pageViewFolderName)
        {
            $pageViewFolderPath = fs::absolutePath($pageViewFolderName);

            if (!fs::exists($pageViewFolderPath))
            {
                $this->logger->warning("The '$pageViewFolderName' folder could not be found");
                continue;
            }

            $this->scanTrackableItems($pageViewFolderPath, [
                'fileExplorer' => FileExplorer::INCLUDE_ONLY_FILES,
            ], ['/.html$/', '/.twig$/']);
        }
    }

    /**
     * Get all of the PageViews in an associative array with PageView types as the keys.
     *
     * @since  0.1.1
     *
     * @return BasePageView[][]
     */
    public function &getPageViews()
    {
        return $this->trackedItems;
    }

    /**
     * Get all of the PageViews in flat array.
     *
     * @since  0.1.1
     *
     * @return BasePageView[]
     */
    public function &getPageViewsFlattened()
    {
        return $this->trackedItemsFlattened;
    }

    /**
     * Get the static PageViews tracked by this manager indexed by their title.
     *
     * @since 0.1.0
     *
     * @return StaticPageView[]
     */
    public function getStaticPageViews()
    {
        return $this->staticPages;
    }

    /**
     * Get the jailed version of the static PageViews indexed by their title.
     *
     * @since 0.1.0
     *
     * @return JailedDocument[]
     */
    public function getJailedStaticPageViews()
    {
        $jailedObjects = array();

        foreach ($this->staticPages as $key => $value)
        {
            $jailedObjects[$key] = $value->createJail();
        }

        return $jailedObjects;
    }

    /**
     * Add a new ContentItem to the respective parent PageView of the ContentItem.
     *
     * @param ContentItem $contentItem
     *
     * @since 0.1.0
     */
    public function trackNewContentItem(&$contentItem)
    {
        $collection = $contentItem->getNamespace();
        $this->trackedItems[BasePageView::DYNAMIC_TYPE][$collection]->addCollectableItem($contentItem);
    }

    /**
     * {@inheritdoc}
     */
    protected function &handleTrackableItem(File $filePath, array $options = array())
    {
        $pageView = BasePageView::create($filePath, [
            'site' => $this->configuration->getConfiguration(),
        ]);
        $namespace = $pageView->getType();

        switch ($namespace)
        {
            case BasePageView::STATIC_TYPE:
                $this->handleTrackableStaticPageView($pageView);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                break;

            case BasePageView::DYNAMIC_TYPE:
                $this->handleTrackableDynamicPageView($pageView);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                break;

            case BasePageView::REPEATER_TYPE:
                $this->handleTrackableRepeaterPageView($pageView);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                break;

            default:
                break;
        }

        $this->addObjectToTracker($pageView, $namespace);

        return $pageView;
    }

    /**
     * Handle special behavior and treatment for static PageViews while we're iterating through them.
     *
     * @param StaticPageView $pageView
     *
     * @since 0.1.0
     */
    private function handleTrackableStaticPageView(&$pageView)
    {
        $pageView->evaluateFrontMatter([], [
            'site' => $this->configuration->getConfiguration(),
        ]);

        if (empty($pageView['title']))
        {
            return;
        }

        $this->staticPages[$pageView['title']] = &$pageView;
    }

    /**
     * Handle special behavior and treatment for dynamic PageViews while we're iterating through them.
     *
     * @param DynamicPageView $pageView
     *
     * @since 0.1.0
     *
     * @throws \Exception
     */
    private function handleTrackableDynamicPageView(&$pageView)
    {
        $frontMatter = $pageView->getRawFrontMatter();
        $dataSource = null;
        $namespace = null;

        if (isset($frontMatter['collection']))
        {
            $dataSource = &$this->collectionManager->getCollections();
            $namespace = 'collection';
        }
        elseif (isset($frontMatter['dataset']))
        {
            $dataSource = &$this->dataManager->getDataItems();
            $namespace = 'dataset';
        }

        if ($dataSource === null)
        {
            throw new \Exception('Invalid Dynamic PageView defined');
        }

        $collection = $frontMatter[$namespace];

        if (!isset($dataSource[$collection]))
        {
            throw new CollectionNotFoundException("The '$collection' $namespace is not defined");
        }

        /** @var ContentItem|DataItem $item */
        foreach ($dataSource[$collection] as &$item)
        {
            $item->evaluateFrontMatter($frontMatter, [
                'site' => $this->configuration->getConfiguration(),
            ]);
            $item->setParentPageView($pageView);
            $item->buildPermalink(true);

            $pageView->addCollectableItem($item);
        }
    }

    /**
     * Handle special behavior and treatment for repeater PageViews while we're iterating through them.
     *
     * @param RepeaterPageView $pageView
     *
     * @since 0.2.0
     */
    private function handleTrackableRepeaterPageView(&$pageView)
    {
        $pageView->evaluateFrontMatter([], [
            'site' => $this->configuration->getConfiguration(),
        ]);
        $pageView->configurePermalinks();
    }
}


1		<?php
2
3		/**
4		* @copyright 2017 Vladimir Jimenez
5		* @license https://github.com/allejo/stakx/blob/master/LICENSE.md MIT
6		*/
7
8		namespace allejo\stakx\Manager;
9
10		use allejo\stakx\Configuration;
11		use allejo\stakx\Document\BasePageView;
12		use allejo\stakx\Document\ContentItem;
13		use allejo\stakx\Document\DataItem;
14		use allejo\stakx\Document\DynamicPageView;
15		use allejo\stakx\Document\JailedDocument;
16		use allejo\stakx\Document\RepeaterPageView;
17		use allejo\stakx\Document\StaticPageView;
18		use allejo\stakx\Filesystem\File;
19		use allejo\stakx\Filesystem\FilesystemLoader as fs;
20		use allejo\stakx\Event\PageViewsCompleted;
21		use allejo\stakx\Exception\CollectionNotFoundException;
22		use allejo\stakx\Filesystem\FileExplorer;
23		use Psr\Log\LoggerInterface;
24		use Symfony\Component\EventDispatcher\EventDispatcherInterface;
25
26		/**
27		* This class is responsible for handling all of the PageViews within a website.
28		*
29		* PageManager will parse all available dynamic and static PageViews. After, dynamic PageViews will be prepared by
30		* setting the appropriate values for each ContentItem such as permalinks.
31		*/
32		class PageManager extends TrackingManager
33		{
34		/** @var StaticPageView[] A place to store a reference to static PageViews with titles. */
35		private $staticPages;
36		private $configuration;
37		private $collectionManager;
38		private $dataManager;
39		private $eventDispatcher;
40		private $logger;
41
42		/**
43		* PageManager constructor.
44		*/
45	15	public function __construct(Configuration $configuration, CollectionManager $collectionManager, DataManager $dataManager, EventDispatcherInterface $eventDispatcher, LoggerInterface $logger)
46		{
47	15	$this->trackedItems = [
48	15	BasePageView::STATIC_TYPE => [],
49	15	BasePageView::DYNAMIC_TYPE => [],
50	15	BasePageView::REPEATER_TYPE => [],
51		];
52	15	$this->staticPages = [];
53	15	$this->configuration = $configuration;
54	15	$this->collectionManager = $collectionManager;
55	15	$this->dataManager = $dataManager;
56	15	$this->eventDispatcher = $eventDispatcher;
57	15	$this->logger = $logger;
58	15	}
59
60		/**
61		* {@inheritdoc}
62		*/
63	3	public function compileManager()
64		{
65	3	$this->parsePageViews($this->configuration->getPageViewFolders());
66	3	}
67
68		/**
69		* Go through all of the PageView directories and create a respective PageView for each and classify them by type.
70		*
71		* @param string[] $pageViewFolders
72		*
73		* @since 0.1.0
74		*/
75	15	public function parsePageViews(array $pageViewFolders)
76		{
77	15	foreach ($pageViewFolders as $pageViewFolderName)
78		{
79	15	$pageViewFolderPath = fs::absolutePath($pageViewFolderName);
80
81	15	if (!fs::exists($pageViewFolderPath))
82		{
83	1	$this->logger->warning("The '$pageViewFolderName' folder could not be found");
84	1	continue;
85		}
86
87	14	$this->scanTrackableItems($pageViewFolderPath, [
88	14	'fileExplorer' => FileExplorer::INCLUDE_ONLY_FILES,
89	14	], ['/.html$/', '/.twig$/']);
90		}
91	15	}
92
93		/**
94		* Get all of the PageViews in an associative array with PageView types as the keys.
95		*
96		* @since 0.1.1
97		*
98		* @return BasePageView[][]
99		*/
100		public function &getPageViews()
101		{
102		return $this->trackedItems;
103		}
104
105		/**
106		* Get all of the PageViews in flat array.
107		*
108		* @since 0.1.1
109		*
110		* @return BasePageView[]
111		*/
112	14	public function &getPageViewsFlattened()
113		{
114	14	return $this->trackedItemsFlattened;
115		}
116
117		/**
118		* Get the static PageViews tracked by this manager indexed by their title.
119		*
120		* @since 0.1.0
121		*
122		* @return StaticPageView[]
123		*/
124	1	public function getStaticPageViews()
125		{
126	1	return $this->staticPages;
127		}
128
129		/**
130		* Get the jailed version of the static PageViews indexed by their title.
131		*
132		* @since 0.1.0
133		*
134		* @return JailedDocument[]
135		*/
136	13	public function getJailedStaticPageViews()
137		{
138	13	$jailedObjects = array();
139
140	13	foreach ($this->staticPages as $key => $value)
141		{
142	1	$jailedObjects[$key] = $value->createJail();
143		}
144
145	13	return $jailedObjects;
146		}
147
148		/**
149		* Add a new ContentItem to the respective parent PageView of the ContentItem.
150		*
151		* @param ContentItem $contentItem
152		*
153		* @since 0.1.0
154		*/
155		public function trackNewContentItem(&$contentItem)
156		{
157		$collection = $contentItem->getNamespace();
158		$this->trackedItems[BasePageView::DYNAMIC_TYPE][$collection]->addCollectableItem($contentItem);
159		}
160
161		/**
162		* {@inheritdoc}
163		*/
164	14	protected function &handleTrackableItem(File $filePath, array $options = array())
165		{
166	14	$pageView = BasePageView::create($filePath, [
167	14	'site' => $this->configuration->getConfiguration(),
168		]);
169	14	$namespace = $pageView->getType();
170
171		switch ($namespace)
172		{
173	14	case BasePageView::STATIC_TYPE:
174	11	$this->handleTrackableStaticPageView($pageView);
		0 ignored issues – show Bug introduced 2018-02-18 08:51 UTC by Report Bug Copy Issue Report It seems like `$pageView` defined by `\allejo\stakx\Document\B...n->getConfiguration()))` on line `166` can also be of type `object<allejo\stakx\Document\DynamicPageView>` or `object<allejo\stakx\Document\RepeaterPageView>`; however, `allejo\stakx\Manager\Pag...ackableStaticPageView()` does only seem to accept `object<allejo\stakx\Document\StaticPageView>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
175	11	break;
176
177	3	case BasePageView::DYNAMIC_TYPE:
178		$this->handleTrackableDynamicPageView($pageView);
		0 ignored issues – show Bug introduced 2018-02-18 08:51 UTC by Report Bug Copy Issue Report It seems like `$pageView` defined by `\allejo\stakx\Document\B...n->getConfiguration()))` on line `166` can also be of type `object<allejo\stakx\Document\RepeaterPageView>` or `object<allejo\stakx\Document\StaticPageView>`; however, `allejo\stakx\Manager\Pag...ckableDynamicPageView()` does only seem to accept `object<allejo\stakx\Document\DynamicPageView>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
179		break;
180
181	3	case BasePageView::REPEATER_TYPE:
182	3	$this->handleTrackableRepeaterPageView($pageView);
		0 ignored issues – show Bug introduced 2018-02-18 08:51 UTC by Report Bug Copy Issue Report It seems like `$pageView` defined by `\allejo\stakx\Document\B...n->getConfiguration()))` on line `166` can also be of type `object<allejo\stakx\Document\DynamicPageView>` or `object<allejo\stakx\Document\StaticPageView>`; however, `allejo\stakx\Manager\Pag...kableRepeaterPageView()` does only seem to accept `object<allejo\stakx\Document\RepeaterPageView>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
183	3	break;
184
185		default:
186		break;
187		}
188
189	14	$this->addObjectToTracker($pageView, $namespace);
190
191	14	return $pageView;
192		}
193
194		/**
195		* Handle special behavior and treatment for static PageViews while we're iterating through them.
196		*
197		* @param StaticPageView $pageView
198		*
199		* @since 0.1.0
200		*/
201	11	private function handleTrackableStaticPageView(&$pageView)
202		{
203	11	$pageView->evaluateFrontMatter([], [
204	11	'site' => $this->configuration->getConfiguration(),
205		]);
206
207	11	if (empty($pageView['title']))
208		{
209	11	return;
210		}
211
212	2	$this->staticPages[$pageView['title']] = &$pageView;
213	2	}
214
215		/**
216		* Handle special behavior and treatment for dynamic PageViews while we're iterating through them.
217		*
218		* @param DynamicPageView $pageView
219		*
220		* @since 0.1.0
221		*
222		* @throws \Exception
223		*/
224		private function handleTrackableDynamicPageView(&$pageView)
225		{
226		$frontMatter = $pageView->getRawFrontMatter();
227		$dataSource = null;
228		$namespace = null;
229
230		if (isset($frontMatter['collection']))
231		{
232		$dataSource = &$this->collectionManager->getCollections();
233		$namespace = 'collection';
234		}
235		elseif (isset($frontMatter['dataset']))
236		{
237		$dataSource = &$this->dataManager->getDataItems();
238		$namespace = 'dataset';
239		}
240
241		if ($dataSource === null)
242		{
243		throw new \Exception('Invalid Dynamic PageView defined');
244		}
245
246		$collection = $frontMatter[$namespace];
247
248		if (!isset($dataSource[$collection]))
249		{
250		throw new CollectionNotFoundException("The '$collection' $namespace is not defined");
251		}
252
253		/** @var ContentItem\|DataItem $item */
254		foreach ($dataSource[$collection] as &$item)
255		{
256		$item->evaluateFrontMatter($frontMatter, [
257		'site' => $this->configuration->getConfiguration(),
258		]);
259		$item->setParentPageView($pageView);
260		$item->buildPermalink(true);
261
262		$pageView->addCollectableItem($item);
263		}
264		}
265
266		/**
267		* Handle special behavior and treatment for repeater PageViews while we're iterating through them.
268		*
269		* @param RepeaterPageView $pageView
270		*
271		* @since 0.2.0
272		*/
273	3	private function handleTrackableRepeaterPageView(&$pageView)
274		{
275	3	$pageView->evaluateFrontMatter([], [
276	3	'site' => $this->configuration->getConfiguration(),
277		]);
278	3	$pageView->configurePermalinks();
279	3	}
280		}
281

stakx-io / stakx

Pull Request — master (#61)

PageManager::handleTrackableItem() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like