Cecil\Collection\Page\Page

Complexity

Total Complexity

44

Size/Duplication

Total Lines	515
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	6

Importance

Changes

0

31 Methods

Rating	Name	Duplication	Size	Complexity
A	getPermalink()	0	8	2
A	getFrontmatter()	0	4	1
A	getBody()	0	4	1
A	setHtml()	0	6	1
A	getContent()	0	4	1
A	setLayout()	0	6	1
A	getLayout()	0	4	1
B	__construct()	0	62	8
A	hasPrefix()	0	8	2
A	getPrefix()	0	8	2
A	subPrefix()	0	8	2
A	urlize()	0	6	1
A	isVirtual()	0	4	1
A	parse()	0	9	1
A	setName()	0	6	1
A	getName()	0	4	1
A	setPath()	0	6	1
A	getPath()	0	4	1
A	setPathname()	0	6	1
A	getPathname()	0	4	1
A	setSection()	0	6	1
A	getSection()	0	8	3
A	setTitle()	0	6	1
A	getTitle()	0	4	1
A	setDate()	0	6	1
A	getDate()	0	4	1
A	setWeight()	0	6	1
A	getWeight()	0	4	1
A	setPermalink()	0	9	1
A	setType()	0	6	1
A	getType()	0	4	1

<?php
/*
 * Copyright (c) Arnaud Ligny <arnaud@ligny.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cecil\Collection\Page;

use Cecil\Collection\Item;
use Cecil\Page\Type;
use Cecil\Page\Parser;
use Cecil\Page\VariableTrait;
use Cocur\Slugify\Slugify;
use Symfony\Component\Finder\SplFileInfo;

/**
 * Class Page.
 */
class Page extends Item
{
    use VariableTrait;

    const SLUGIFY_PATTERN = '/(^\/|[^a-z0-9\/]|-)+/';
    // https://regex101.com/r/tJWUrd/1
    const PREFIX_PATTERN = '^(.*?)(([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])|[0-9]+)(-|_|\.)(.*)$';

    /**
     * @var SplFileInfo
     */
    protected $file;
    /**
     * @var string
     */
    protected $fileExtension;
    /**
     * @var string
     */
    protected $filePath;
    /**
     * @var string
     */
    protected $fileName;
    /**
     * @var string
     */
    protected $fileId;
    /**
     * @var bool
     */
    protected $virtual = false;
    /**
     * @var string
     */
    protected $type;
    /**
     * @var string
     */
    protected $id;
    /**
     * @var string
     */
    protected $pathname;
    /**
     * @var string
     */
    protected $path;
    /**
     * @var string
     */
    protected $name;
    /**
     * @var string
     */
    protected $frontmatter;
    /**
     * @var string
     */
    protected $body;
    /**
     * @var string
     */
    protected $html;

    /**
     * Constructor.
     *
     * @param SplFileInfo|null $file
     */
    public function __construct(SplFileInfo $file = null)
    {
        $this->file = $file;

        if ($this->file instanceof SplFileInfo) {
            // file extension: "md"
            $this->fileExtension = pathinfo($this->file, PATHINFO_EXTENSION);
            // file path: "Blog"
            $this->filePath = str_replace(DIRECTORY_SEPARATOR, '/', $this->file->getRelativePath());
            // file name: "Post 1"
            $this->fileName = basename($this->file->getBasename(), '.'.$this->fileExtension);
            // file id: "Blog/Post 1"
            $this->fileId = ($this->filePath ? $this->filePath.'/' : '')
                .($this->filePath && $this->fileName == 'index' ? '' : $this->fileName);
            /*
             * variables default values
             */
            // id - ie: "blog/post-1"
            $this->id = $this->urlize(self::subPrefix($this->fileId));
            // pathname - ie: "blog/post-1"
            $this->pathname = $this->urlize(self::subPrefix($this->fileId));
            // path - ie: "blog"
            $this->path = $this->urlize($this->filePath);
            // name - ie: "post-1"
            $this->name = $this->urlize(self::subPrefix($this->fileName));
            /*
             * front matter default values
             */
            // title - ie: "Post 1"
            $this->setTitle(self::subPrefix($this->fileName));
            // section - ie: "blog"
            $this->setSection(explode('/', $this->path)[0]);
            // date from file meta
            $this->setDate(filemtime($this->file->getPathname()));
            // file as a prefix?
            if (false !== self::getPrefix($this->fileId)) {
                // prefix is a valid date?
                $isValidDate = function ($date, $format = 'Y-m-d') {
                    $d = \DateTime::createFromFormat($format, $date);

                    return $d && $d->format($format) === $date;
                };
                if ($isValidDate(self::getPrefix($this->fileId))) {
                    $this->setDate((string) self::getPrefix($this->fileId));
                } else {
                    // prefix is an integer
                    $this->setWeight((int) self::getPrefix($this->fileId));
                }
            }
            // permalink
            $this->setPermalink($this->pathname);

            parent::__construct($this->id);
        } else {
            $this->virtual = true;

            parent::__construct();
        }
        $this->setVariable('virtual', $this->virtual);
        $this->setVariable('published', true);
        $this->setVariable('content_template', 'page.content.twig');
    }

    /**
     * Return matches array if prefix exist or false.
     *
     * @param string $string
     *
     * @return string[]|false
     */
    public static function hasPrefix(string $string)
    {
        if (preg_match('/'.self::PREFIX_PATTERN.'/', $string, $matches)) {
            return $matches;
        } else {
            return false;
        }
    }

    /**
     * Return prefix if prefix or false.
     *
     * @param string $string
     *
     * @return string[]|false

Should the return type not be string|false?

     */
    public static function getPrefix(string $string)
    {
        if (false !== ($matches = self::hasPrefix($string))) {
            return $matches[2];
        }

        return false;
    }

    /**
     * Return string without prefix (if exist).
     *
     * @param string $string
     *
     * @return string
     */
    public static function subPrefix(string $string): string
    {
        if (false !== ($matches = self::hasPrefix($string))) {
            return $matches[1].$matches[7];
        }

        return $string;
    }

    /**
     * Format string into URL.
     *
     * @param string $string
     *
     * @return string
     */
    public static function urlize(string $string): string
    {
        return Slugify::create([
            'regexp' => self::SLUGIFY_PATTERN,
        ])->slugify($string);
    }

    /**
     * Is current page is virtual?
     *
     * @return bool
     */
    public function isVirtual(): bool
    {
        return $this->virtual;
    }

    /**
     * Set page type.
     *
     * @param string $type
     *
     * @return self
     */
    public function setType(string $type): self
    {
        $this->type = new Type($type);

It seems like new \Cecil\Page\Type($type) of type object<Cecil\Page\Type> is incompatible with the declared type string of property $type.

        return $this;
    }

    /**
     * Get page type.
     *
     * @return string|null
     */
    public function getType(): ?string
    {
        return $this->type;
    }

    /**
     * Parse file content.
     *
     * @return self
     */
    public function parse(): self
    {
        $parser = new Parser($this->file);
        $parsed = $parser->parse();
        $this->frontmatter = $parsed->getFrontmatter();
        $this->body = $parsed->getBody();

        return $this;
    }

    /**
     * Set name.
     *
     * @param string $name
     *
     * @return self
     */
    public function setName(string $name): self
    {
        $this->name = $name;

        return $this;
    }

    /**
     * Get name.
     *
     * @return string|null
     */
    public function getName(): ?string
    {
        return $this->name;
    }

    /**
     * Set path.
     *
     * @param $path
     *
     * @return self
     */
    public function setPath(string $path): self
    {
        $this->path = $path;

        return $this;
    }

    /**
     * Get path.
     *
     * @return string
     */
    public function getPath(): string
    {
        return $this->path;
    }

    /**
     * Set path name.
     *
     * @param string $pathname
     *
     * @return self
     */
    public function setPathname(string $pathname): self
    {
        $this->pathname = $pathname;

        return $this;
    }

    /**
     * Get path name.
     *
     * @return string
     */
    public function getPathname(): string
    {
        return $this->pathname;
    }

    /**
     * Set section.
     *
     * @param string $section
     *
     * @return self
     */
    public function setSection(string $section): self
    {
        $this->setVariable('section', $section);

        return $this;
    }

    /**
     * Get section.
     *
     * @return string|false
     */
    public function getSection(): ?string
    {
        if (empty($this->getVariable('section')) && !empty($this->path)) {
            $this->setSection(explode('/', $this->path)[0]);
        }

        return $this->getVariable('section');
    }

    /**
     * Set title.
     *
     * @param string $title
     *
     * @return self
     */
    public function setTitle(string $title): self
    {
        $this->setVariable('title', $title);

        return $this;
    }

    /**
     * Get title.
     *
     * @return string|false
     */
    public function getTitle(): ?string
    {
        return $this->getVariable('title');
    }

    /**
     * Set date.
     *
     * @param string|\DateTime $date
     *
     * @return self
     */
    public function setDate($date): self
    {
        $this->setVariable('date', $date);

        return $this;
    }

    /**
     * Get Date.
     *
     * @return \DateTime|false
     */
    public function getDate(): ?\DateTime
    {
        return $this->getVariable('date');
    }

    /**
     * Set weight.
     *
     * @param int $weight
     *
     * @return self
     */
    public function setWeight(int $weight): self
    {
        $this->setVariable('weight', $weight);

        return $this;
    }

    /**
     * Get weight.
     *
     * @return int|null
     */
    public function getWeight(): ?int
    {
        return $this->getVariable('weight');
    }

    /**
     * Set permalink.
     *
     * @param string $permalink
     *
     * @return self
     */
    public function setPermalink(string $permalink): self
    {
        // https://regex101.com/r/45oTKm/1
        $permalink = preg_replace('/index$/i', '', $permalink);

        $this->setVariable('permalink', $permalink);

        return $this;
    }

    /**
     * Get permalink.
     *
     * @return string|false
     */
    public function getPermalink(): ?string
    {
        if (empty($this->getVariable('permalink'))) {
            $this->setPermalink($this->getPathname());
        }

        return $this->getVariable('permalink');
    }

    /**
     * Get frontmatter.
     *
     * @return string|null
     */
    public function getFrontmatter(): ?string
    {
        return $this->frontmatter;
    }

    /**
     * Get body.
     *
     * @return string
     */
    public function getBody(): string
    {
        return $this->body;
    }

    /**
     * Set HTML.
     *
     * @param string $html
     *
     * @return self
     */
    public function setHtml(string $html): self
    {
        $this->html = $html;

        return $this;
    }

    /**
     * Get HTML alias.
     *
     * @return string|null
     */
    public function getContent(): ?string
    {
        return $this->html;
    }

    /**
     * Set layout.
     *
     * @param string $layout
     *
     * @return self
     */
    public function setLayout(string $layout): self
    {
        $this->setVariable('layout', $layout);

        return $this;
    }

    /**
     * Get layout.
     *
     * @return string|false
     */
    public function getLayout(): ?string
    {
        return $this->getVariable('layout');
    }
}