MarkdownDocument::__construct() - Code Metrics - Inspection of "Merge pull request #335 from hydephp/update-markdo..." - hydephp/develop - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ef3441...70573f )

by Caen

created 2022-08-04 13:54 UTC

MarkdownDocument::__construct() A

↳ Parent: MarkdownDocument

Complexity

Conditions	3
Paths	4

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	3
c	0
b	0
f	0
nc	4
nop	2
dl	0
loc	6
rs	10

<?php

namespace Hyde\Framework\Models;

use Hyde\Framework\Contracts\MarkdownDocumentContract;
use Hyde\Framework\Hyde;
use Hyde\Framework\Modules\Markdown\MarkdownFileParser;

/**
 * A MarkdownDocument is a simpler alternative to a MarkdownPage.
 *
 * It's an object that contains a parsed FrontMatter split from the body of the Markdown file.
 *
 * @see \Hyde\Framework\Testing\Unit\MarkdownDocumentTest
 */
class MarkdownDocument implements MarkdownDocumentContract
{
    public FrontMatter $matter;
    public Markdown $markdown;

    /** @deprecated */
    public string $body;

    public function __construct(FrontMatter|array $matter = [], Markdown|string $body = '')
    {
        $this->matter = $matter instanceof FrontMatter ? $matter : new FrontMatter($matter);

        $this->markdown = $body instanceof Markdown ? $body : new Markdown($body);

        $this->body = $this->markdown->body;
        /** @scrutinizer ignore-deprecated */ $this->body = $this->markdown->body;
    }

    public function __toString(): string
    {
        return $this->markdown;
    }

    public function matter(string $key = null, mixed $default = null): mixed
    {
        return $key ? $this->matter->get($key, $default) : $this->matter;
    }

    public function markdown(): Markdown
    {
        return $this->markdown;
    }

    /**
     * @deprecated v0.56.0 - Use static::parse() instead
     */
    public static function parseFile(string $localFilepath): static
    {
        return static::parse($localFilepath);
    }

    public static function parse(string $localFilepath): static
    {
        return (new MarkdownFileParser(Hyde::path($localFilepath)))->get();
    }
}


hydephp / develop

Push — master ( ef3441...70573f )

MarkdownDocument::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like