archived-doctrine-website/lib/Builder/SourceFile.php

<?php

declare(strict_types=1);

namespace Doctrine\Website\Builder;

use DateTime;
use function count;
use function explode;
use function in_array;
use function sprintf;
use function strpos;
use function strtotime;

class SourceFile
{
    private const TWIG_EXTENSIONS = ['html', 'md', 'rst', 'xml', 'txt'];

    private const NEEDS_LAYOUT_EXTENSIONS = ['html', 'md', 'rst'];

    private const MARKDOWN_EXTENSION = 'md';

    /** @var string */
    private $extension;

    /** @var string */
    private $writePath;

    /** @var string */
    private $contents;

    /** @var mixed[] */
    private $parameters = [];

    /**
     * @param mixed[] $parameters
     */
    public function __construct(
        string $extension,
        string $writePath,
        string $contents,
        array $parameters
    ) {
        $this->extension  = $extension;
        $this->writePath  = $writePath;
        $this->contents   = $contents;
        $this->parameters = $parameters;
    }

    public function getWritePath() : string
    {
        return $this->writePath;
    }

    public function getUrl() : string
    {
        return $this->parameters['url'];
    }

    public function getDate() : DateTime
    {
        $e = explode('/', $this->getUrl());

        if (count($e) < 4) {
            return new DateTime();
        }

        $date = strtotime(sprintf('%s/%s/%s', $e[1], $e[2], $e[3]));

        if ($date === false) {
            return new DateTime();
        }

        return (new DateTime())->setTimestamp($date);
    }

    public function getExtension() : string
    {
        return $this->extension;
    }

    public function isMarkdown() : bool
    {
        return $this->getExtension() === self::MARKDOWN_EXTENSION;
    }

    public function isTwig() : bool
    {
        return in_array($this->getExtension(), self::TWIG_EXTENSIONS, true) && $this->isApiDocs() === false;
    }

    public function isLayoutNeeded() : bool
    {
        return in_array($this->getExtension(), self::NEEDS_LAYOUT_EXTENSIONS, true);
    }

    public function isApiDocs() : bool
    {
        return strpos($this->getUrl(), '/api/') === 0;
    }

    public function getContents() : string
    {
        return $this->contents;
    }

    /**
     * @return mixed[]
     */
    public function getParameters() : array
    {
        return $this->parameters;
    }

    /**
     * @return mixed
     */
    public function getParameter(string $key)
    {
        return $this->parameters[$key] ?? '';
    }
}