Markdown::render() - Code Metrics - Inspection of "Merge pull request #532 from hydephp/update-namesp..." - hydephp/develop - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 37b230...58190a )

by Caen

created 2022-09-14 20:12 UTC

Markdown::render() A

↳ Parent: Markdown

Complexity

Conditions	2
Paths	2

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Hyde\Framework\Models\Markdown;

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, \Stringable
{
    public string $body;

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

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

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

    public function compile(?string $sourceModel = null): string
    {
        return static::render($this->body, $sourceModel);
    }

    /**
     * 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 static function fromFile(string $localFilepath): static
    {
        return MarkdownDocument::parse($localFilepath)->markdown();
    }

    /**
     * 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);
    }
}


1			<?php
2
3			namespace Hyde\Framework\Models\Markdown;
4
5			use Hyde\Framework\Modules\Markdown\MarkdownConverter;
6			use Hyde\Framework\Services\MarkdownService;
7			use Illuminate\Contracts\Support\Arrayable;
8
9			/**
10			* A simple object representation of a Markdown file, with helpful methods to interact with it.
11			*
12			* @see \Hyde\Framework\Testing\Unit\MarkdownDocumentTest
13			*/
14			class Markdown implements Arrayable, \Stringable
15			{
16			public string $body;
17
18			public function __construct(string $body = '')
19			{
20			$this->body = $body;
21			}
22
23			public function __toString(): string
24			{
25			return $this->body;
26			}
27
28			public function body(): string
29			{
30			return $this->body;
31			}
32
33			public function compile(?string $sourceModel = null): string
34			{
35			return static::render($this->body, $sourceModel);
36			}
37
38			/**
39			* Return the Markdown document body explored by line into an array.
40			*
41			* @return string[]
42			*/
43			public function toArray(): array
44			{
45			return explode("\n", $this->body);
			0 ignored issues – show Bug Best Practice introduced 2022-08-03 15:51 UTC by Report Bug Copy Issue Report The expression `return explode(' ', $this->body)` returns the type `string[]` which is incompatible with the return type mandated by `Illuminate\Contracts\Support\Arrayable::toArray()` of `Illuminate\Contracts\Support\TValue[]`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: 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. } } Loading history...
46			}
47
48			public static function fromFile(string $localFilepath): static
49			{
50			return MarkdownDocument::parse($localFilepath)->markdown();
51			}
52
53			/**
54			* Render a Markdown string into HTML.
55			*
56			* If a source model is provided, the Markdown will be converted using the dynamic MarkdownService,
57			* otherwise, the pre-configured singleton from the service container will be used instead.
58			*
59			* @return string $html
60			*/
61			public static function render(string $markdown, ?string $sourceModel = null): string
62			{
63			return $sourceModel !== null
64			? (new MarkdownService($markdown, $sourceModel))->parse()
65			: app(MarkdownConverter::class)->convert($markdown);
66			}
67			}
68

hydephp / develop

Push — master ( 37b230...58190a )

Markdown::render() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like