allejo\stakx\Document\PermalinkDocument

Complexity

Total Complexity

12

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

97.56%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getTargetFile()	0	13	2
A	getPermalink()	0	10	1
A	getRedirects()	0	11	2
B	getPathPermalink()	0	24	3
B	sanitizePermalink()	0	30	3
	evaluateFrontMatter()	0	1	?
	buildPermalink()	0	1	?
A	handleSpecialRedirects()	0	3	1

<?php

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

namespace allejo\stakx\Document;

use allejo\stakx\Service;
use allejo\stakx\System\ReadableFile;

/**
 * A document that will have a permalink
 */
abstract class PermalinkDocument extends ReadableFile
{
    /** @var array */
    protected $permalink;

    /** @var array */
    protected $redirects;

    /**
     * Get the destination of where this Content Item would be written to when the website is compiled.
     *
     * @return string
     */
    final public function getTargetFile()
    {
        $permalink = $this->getPermalink();
        $missingFile = (substr($permalink, -1) == '/');
        $permalink = str_replace('/', DIRECTORY_SEPARATOR, $permalink);

        if ($missingFile)
        {
            $permalink = rtrim($permalink, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . 'index.html';
        }

        return ltrim($permalink, DIRECTORY_SEPARATOR);
    }

    /**
     * Get the permalink of this Content Item.
     *
     * @throws \Exception
     *
     * @return string
     */
    final public function getPermalink()
    {
        $this->buildPermalink();

        $this->permalink = $this->sanitizePermalink($this->permalink);

$this->permalink is of type array, but the function expects a string.

It seems like $this->sanitizePermalink($this->permalink) of type string is incompatible with the declared type array of property $permalink.

        $this->permalink = str_replace(DIRECTORY_SEPARATOR, '/', $this->permalink);

It seems like str_replace(DIRECTORY_SEPARATOR, '/', $this->permalink) of type string is incompatible with the declared type array of property $permalink.

        $this->permalink = '/' . ltrim($this->permalink, '/'); // Permalinks should always use '/' and not be OS specific

It seems like '/' . ltrim($this->permalink, '/') of type string is incompatible with the declared type array of property $permalink.

        return $this->permalink;
    }

    /**
     * Get an array of URLs that will redirect to.
     *
     * @return string[]

Should the return type not be null|array?

     */
    final public function getRedirects()
    {
        if (is_null($this->redirects))
        {
            $this->getPermalink();
        }

        $this->handleSpecialRedirects();

        return $this->redirects;
    }

    /**
     * Get the permalink based off the location of where the file is relative to the website. This permalink is to be
     * used as a fallback in the case that a permalink is not explicitly specified in the Front Matter.
     *
     * @return string
     */
    protected function getPathPermalink()
    {
        // Remove the protocol of the path, if there is one and prepend a '/' to the beginning
        $cleanPath = preg_replace('/[\w|\d]+:\/\//', '', $this->getRelativeFilePath());
        $cleanPath = ltrim($cleanPath, DIRECTORY_SEPARATOR);

        // Handle vfs:// paths by replacing their forward slashes with the OS appropriate directory separator
        if (DIRECTORY_SEPARATOR !== '/')
        {
            $cleanPath = str_replace('/', DIRECTORY_SEPARATOR, $cleanPath);
        }

        // Check the first folder and see if it's a data folder (starts with an underscore) intended for stakx
        $folders = explode(DIRECTORY_SEPARATOR, $cleanPath);

        if (substr($folders[0], 0, 1) === '_')
        {
            array_shift($folders);
        }

        $cleanPath = implode(DIRECTORY_SEPARATOR, $folders);

        return $cleanPath;
    }

    /**
     * Sanitize a permalink to remove unsupported characters or multiple '/' and replace spaces with hyphens.
     *
     * @param string $permalink A permalink
     *
     * @return string $permalink The sanitized permalink
     */
    protected function sanitizePermalink($permalink)
    {
        // Remove multiple '/' together
        $permalink = preg_replace('/\/+/', '/', $permalink);

Consider using a different name than the parameter $permalink. This often makes code more readable.

        // Replace all spaces with hyphens
        $permalink = str_replace(' ', '-', $permalink);

Consider using a different name than the parameter $permalink. This often makes code more readable.

        // Remove all disallowed characters
        $permalink = preg_replace('/[^0-9a-zA-Z-_\/\\\.]/', '', $permalink);

Consider using a different name than the parameter $permalink. This often makes code more readable.

        // Handle unnecessary extensions
        $extensionsToStrip = array('twig');

        if (in_array($this->fs->getExtension($permalink), $extensionsToStrip))
        {
            $permalink = $this->fs->removeExtension($permalink);

Consider using a different name than the parameter $permalink. This often makes code more readable.

        }

        // Remove any special characters before a sane value
        $permalink = preg_replace('/^[^0-9a-zA-Z-_]*/', '', $permalink);

Consider using a different name than the parameter $permalink. This often makes code more readable.

        // Convert permalinks to lower case
        if (!Service::getParameter('build.preserveCase'))
        {
            $permalink = mb_strtolower($permalink, 'UTF-8');

Consider using a different name than the parameter $permalink. This often makes code more readable.

        }

        return $permalink;
    }

    /**
     * Evaluate the FrontMatter for the document.
     *
     * This FrontMatter can be the user-defined FrontMatter in a FrontMatterDocument but it can also be used as internal
     * settings used for objects that do not have user-defined FrontMatter such as DataItems.
     *
     * @param array $variables
     *
     * @return void
     */
    abstract public function evaluateFrontMatter($variables = array());

    /**
     * @return void
     */
    abstract public function buildPermalink($force = false);

    /**
     * If a document has extra redirects defined in a special manner, overload this function.
     */
    public function handleSpecialRedirects()
    {
    }
}