library\components\DocumentComponent

Complexity

Total Complexity

17

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	8
Bugs	2	Features	3

7 Methods

Rating	Name	Duplication	Size	Complexity
A	run()	0	12	2
A	checkParameters()	0	6	2
A	runLikeApplicationComponent()	0	9	2
A	runLikeRegularComponent()	0	8	2
A	runWithoutRegex()	0	8	2
B	runWithRegex()	0	25	6
A	runByDocumentParameter()	0	4	1

<?php
namespace library\components {

	use library\storage\Storage;

	/**
	 * Class DocumentComponent
	 *
	 * Has optional parameter `folder` to prefix the relative url with a folder
	 * Has optional parameter `document` to select a given document
	 * Has optional parameter `documentParameterName` to select the parametername to be used
	 * 		to set the found document to.
	 *
	 * @package library\components
	 */
	class DocumentComponent extends BaseComponent
	{
		protected $documentParameterName = 'document';

		/**
		 * @param Storage $storage
		 * @return mixed|void
		 * @throws \Exception
		 */
		public function run(Storage $storage)
		{
			parent::run($storage);

			$this->checkParameters();

			if ($this->matchedSitemapItem === null) { // If no sitemapitem, its an application component
				$this->runLikeApplicationComponent();
			} else {
				$this->runLikeRegularComponent();
			}
		}

		/**
		 * Checks to see if any parameters were defined in the cms and acts according
		 */
		private function checkParameters()
		{
			if (isset($this->parameters['documentParameterName'])) {
				$this->documentParameterName = $this->parameters['documentParameterName'];
			}
		}

		/**
		 * Run as application component
		 *
		 * @throws \Exception
		 */
		private function runLikeApplicationComponent()
		{
			if (isset($this->parameters['document'])) {
				$this->parameters[$this->documentParameterName] = $this->storage->getDocumentBySlug($this->parameters['document']);
				unset($this->parameters['document']);
			} else {
				throw new \Exception('When used as application component, you need to specify a document.');
			}
		}

		/**
		 * Run as regular component
		 *
		 * @throws \Exception
		 */
		private function runLikeRegularComponent()
		{
			if ($this->matchedSitemapItem->regex == false) {
				$this->runWithoutRegex();
			} else {
				$this->runWithRegex();
			}
		}

		/**
		 * Run without regex
		 *
		 * @throws \Exception
		 */
		private function runWithoutRegex()
		{
			if (isset($this->parameters['document'])) {
				$this->runByDocumentParameter();
			} else {
				throw new \Exception('When not using a regex, you need to set the parameter `document` with the path to the document in this sitemap item: ' . $this->matchedSitemapItem->title);
			}
		}

		/**
		 * Run with regex
		 *
		 * @throws \Exception
		 */
		private function runWithRegex()
		{
			if (isset($this->parameters['document'])) {
				$this->runByDocumentParameter();
			} else {
				$relativeDocumentUri = current($this->matchedSitemapItem->matches[1]);
				if (isset($this->parameters['folder'])) {
					if (substr($this->parameters['folder'], -1) !== '/') {
						$this->parameters['folder'] = $this->parameters['folder'] . '/';
					}
					$relativeDocumentUri = $this->parameters['folder'] . $relativeDocumentUri;
				}

				$document = $this->storage->getDocumentBySlug($relativeDocumentUri);

				if ($document->type == 'folder') {
					throw new \Exception('The found document is a folder.');
				}

				if ($document->state != 'published') {
					throw new \Exception('Found document is unpublished.');
				}
				$this->parameters[$this->documentParameterName] = $document;
			}
		}

		/**
		 * Run using the given `document` parameter
		 */
		private function runByDocumentParameter()
		{
			$this->parameters[$this->documentParameterName] = $this->storage->getDocumentBySlug($this->parameters['document']);
		}
	}
}