TemplateMailableRenderer::renderInLayout() - Code Metrics - Inspection of "remove markdown" - spatie/laravel-database-mail-templates - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1118bf...6dbe9f )

unknown

created 2018-10-14 13:41 UTC

TemplateMailableRenderer::renderInLayout() A

↳ Parent: TemplateMailableRenderer

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0
cc	3
nc	2
nop	2

<?php

namespace Spatie\MailTemplates;

use Mustache_Engine;
use Spatie\MailTemplates\Models\MailTemplate;
use Spatie\MailTemplates\Exceptions\CannotRenderTemplateMailable;

class TemplateMailableRenderer
{
    /** @var TemplateMailable */
    protected $templateMailable;

    /** @var MailTemplate */
    protected $mailTemplate;

    /** @var Mustache_Engine */
    protected $mustache;

    public function __construct(TemplateMailable $templateMailable, Mustache_Engine $mustache)
    {
        $this->templateMailable = $templateMailable;
        $this->mustache = $mustache;

        $templateModel = $this->templateMailable->getTemplateModel();
        $this->mailTemplate = $templateModel::findForMailable($templateMailable);
    }

    public function render(array $data = []): string
    {
        $html = $this->mustache->render(
            $this->mailTemplate->template,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $data
        );

        return $this->renderInLayout($html, $data);
    }

    public function renderSubject(array $data = []): string
    {
        return $this->mustache->render(
            $this->mailTemplate->subject,
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $data
        );
    }

    protected function renderInLayout(string $html, array $data = []): string
    {
        $layout = $this->templateMailable->getLayout()
            ?? $this->mailTemplate->getLayout()
            ?? '{{{ body }}}';

        if ($layout && ! str_contains($layout, ['{{{body}}}', '{{{ body }}}', '{{body}}', '{{ body }}'])) {
            throw CannotRenderTemplateMailable::layoutDoesNotContainABodyPlaceHolder($this->templateMailable, $this->mailTemplate, $layout);
        }

        $data = array_merge(['body' => $html], $data);

        return $this->mustache->render($layout, $data);
    }
}


1			<?php
2
3			namespace Spatie\MailTemplates;
4
5			use Mustache_Engine;
6			use Spatie\MailTemplates\Models\MailTemplate;
7			use Spatie\MailTemplates\Exceptions\CannotRenderTemplateMailable;
8
9			class TemplateMailableRenderer
10			{
11			/** @var TemplateMailable */
12			protected $templateMailable;
13
14			/** @var MailTemplate */
15			protected $mailTemplate;
16
17			/** @var Mustache_Engine */
18			protected $mustache;
19
20			public function __construct(TemplateMailable $templateMailable, Mustache_Engine $mustache)
21			{
22			$this->templateMailable = $templateMailable;
23			$this->mustache = $mustache;
24
25			$templateModel = $this->templateMailable->getTemplateModel();
26			$this->mailTemplate = $templateModel::findForMailable($templateMailable);
27			}
28
29			public function render(array $data = []): string
30			{
31			$html = $this->mustache->render(
32			$this->mailTemplate->template,
			0 ignored issues – show Documentation introduced 2018-10-11 15:19 UTC by Report Bug Copy Issue Report The property `template` does not exist on `object<Spatie\MailTemplates\Models\MailTemplate>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
33			$data
34			);
35
36			return $this->renderInLayout($html, $data);
37			}
38
39			public function renderSubject(array $data = []): string
40			{
41			return $this->mustache->render(
42			$this->mailTemplate->subject,
			0 ignored issues – show Documentation introduced 2018-10-11 15:19 UTC by Report Bug Copy Issue Report The property `subject` does not exist on `object<Spatie\MailTemplates\Models\MailTemplate>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
43			$data
44			);
45			}
46
47			protected function renderInLayout(string $html, array $data = []): string
48			{
49			$layout = $this->templateMailable->getLayout()
50			?? $this->mailTemplate->getLayout()
51			?? '{{{ body }}}';
52
53			if ($layout && ! str_contains($layout, ['{{{body}}}', '{{{ body }}}', '{{body}}', '{{ body }}'])) {
54			throw CannotRenderTemplateMailable::layoutDoesNotContainABodyPlaceHolder($this->templateMailable, $this->mailTemplate, $layout);
55			}
56
57			$data = array_merge(['body' => $html], $data);
58
59			return $this->mustache->render($layout, $data);
60			}
61			}
62

spatie / laravel-database-mail-templates

Push — master ( 1118bf...6dbe9f )

TemplateMailableRenderer::renderInLayout() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like