Markdown::compile() - Code Metrics - Inspection of "Merge pull request #333 from hydephp/merge-markdow..." - hydephp/develop - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ef5451...9c1fbd )

by Caen

created 2022-08-04 13:26 UTC

Markdown::compile() A

↳ Parent: Markdown

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

namespace Hyde\Framework\Models;

use Hyde\Framework\Modules\Markdown\MarkdownConverter;
use Hyde\Framework\Services\MarkdownService;
use Illuminate\Contracts\Support\Arrayable;

/**
 * A simple object representation of a Markdown file, with helpful methods to interact with it.
 *
 * @see \Hyde\Framework\Testing\Unit\MarkdownDocumentTest
 */
class Markdown implements Arrayable
{
    public string $body;

    public function __construct(string $body = '')
    {
        $this->body = $body;
    }

    public static function fromFile(string $localFilepath): static
    {
        return MarkdownDocument::parseFile($localFilepath)->markdown();
        return /** @scrutinizer ignore-deprecated */ MarkdownDocument::parseFile($localFilepath)->markdown();
    }

    public function compile(): string
    {
        return static::render($this->body);
    }

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

    /**
     * Return the Markdown document body explored by line into an array.
     *
     * @return string[]
     */
    public function toArray(): array
    {
        return explode("\n", $this->body);
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

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

    /**
     * Render a Markdown string into HTML.
     *
     * If a source model is provided, the Markdown will be converted using the dynamic MarkdownService,
     * otherwise, the pre-configured singleton from the service container will be used instead.
     *
     * @return string $html
     */
    public static function render(string $markdown, ?string $sourceModel = null): string
    {
        return $sourceModel !== null
            ? (new MarkdownService($markdown, $sourceModel))->parse()
            : app(MarkdownConverter::class)->convert($markdown);
    }
}


hydephp / develop

Push — master ( ef5451...9c1fbd )

Markdown::compile() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like