allejo\stakx\Document\ContentItem

Complexity

Total Complexity

11

Size/Duplication

Total Lines	106
Duplicated Lines	18.87 %

Coupling/Cohesion

Components	2
Dependencies	8

Test Coverage

Coverage

76.32%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	handleSpecialRedirects()	0	16	3
A	getContent()	0	12	2
A	parseMarkupLanguage()	0	21	4
A	createJail()	12	12	1
A	jsonSerialize()	8	8	1

<?php

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

namespace allejo\stakx\Document;

use allejo\stakx\Engines\Markdown\MarkdownEngine;
use allejo\stakx\Engines\PlainTextEngine;
use allejo\stakx\Engines\RST\RstEngine;
use allejo\stakx\Service;
use allejo\stakx\Templating\TemplateErrorInterface;

class ContentItem extends PermalinkFrontMatterDocument implements CollectableItem, TemplateReadyDocument
{
    use CollectableItemTrait;
    use TemplateEngineDependent;

    ///
    // Permalink management
    ///

    /**
     * {@inheritdoc}
     */
    public function handleSpecialRedirects()
    {
        $fm = $this->getFrontMatter();

Avoid variables with short names like $fm. Configured minimum length is 3.

        if (isset($fm['redirect_from']))
        {
            $redirects = $fm['redirect_from'];

            if (!is_array($redirects))
            {
                $redirects = [$redirects];
            }

            $this->redirects = array_merge($this->redirects, $redirects);
        }
    }

    ///
    // Document body transformation
    ///

    /**
     * @throws TemplateErrorInterface
     *
     * @return string
     */
    public function getContent()
    {
        if (!$this->bodyContentEvaluated)
        {
            $this->bodyContent = $this->parseTemplateLanguage($this->bodyContent);
            $this->parseMarkupLanguage();

            $this->bodyContentEvaluated = true;
        }

        return (string)$this->bodyContent;
    }

    /**
     * Transform the document's body from a markup language to HTML.
     *
     * @todo Port this to follow the same pattern as the template engine
     */
    private function parseMarkupLanguage()
    {
        switch ($this->getExtension())
        {
            case 'md':
            case 'markdown':
                $pd = new MarkdownEngine();

Avoid variables with short names like $pd. Configured minimum length is 3.

                break;

            case 'rst':
                $pd = new RstEngine();
                $pd->setIncludePolicy(true, Service::getWorkingDirectory());
                break;

            default:
                $pd = new PlainTextEngine();
                break;
        }

        $this->bodyContent = $pd->parse($this->bodyContent);
    }

    /**
     * {@inheritdoc}
     */
    public function createJail()

This method seems to be duplicated in your project.

    {
        $whiteListedFunctions = array_merge(self::$whiteListedFunctions, [
        ]);

        $jailedFunctions = [
            'getPageView'   => 'getJailedPageView',
            'getCollection' => 'getNamespace',
        ];

        return (new JailedDocument($this, $whiteListedFunctions, $jailedFunctions));
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize()

This method seems to be duplicated in your project.

    {
        return array_merge($this->getFrontMatter(), [
            'content'   => $this->getContent(),
            'permalink' => $this->getPermalink(),
            'redirects' => $this->getRedirects(),
        ]);
    }
}