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

Completed

Push — master ( 284849...6c8a74 )

by Freek

created 2018-10-14 20:41 UTC

guardAgainstInvalidLayout() A

↳ Parent: TemplateMailableRenderer

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.9
c	0
b	0
f	0
cc	2
nc	2
nop	1

<?php

namespace Spatie\MailTemplates;

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

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

    /** @var \Spatie\MailTemplates\Models\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 }}}';

        $this->guardAgainstInvalidLayout($layout);

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

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

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


1			<?php
2
3			namespace Spatie\MailTemplates;
4
5			use Mustache_Engine;
6			use Spatie\MailTemplates\Exceptions\CannotRenderTemplateMailable;
7
8			class TemplateMailableRenderer
9			{
10			/** @var \Spatie\MailTemplates\TemplateMailable */
11			protected $templateMailable;
12
13			/** @var \Spatie\MailTemplates\Models\MailTemplate */
14			protected $mailTemplate;
15
16			/** @var \Mustache_Engine */
17			protected $mustache;
18
19			public function __construct(TemplateMailable $templateMailable, Mustache_Engine $mustache)
20			{
21			$this->templateMailable = $templateMailable;
22			$this->mustache = $mustache;
23
24			$templateModel = $this->templateMailable->getTemplateModel();
25			$this->mailTemplate = $templateModel::findForMailable($templateMailable);
26			}
27
28			public function render(array $data = []): string
29			{
30			$html = $this->mustache->render(
31			$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...
32			$data
33			);
34
35			return $this->renderInLayout($html, $data);
36			}
37
38			public function renderSubject(array $data = []): string
39			{
40			return $this->mustache->render(
41			$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...
42			$data
43			);
44			}
45
46			protected function renderInLayout(string $html, array $data = []): string
47			{
48			$layout = $this->templateMailable->getLayout()
49			?? $this->mailTemplate->getLayout()
50			?? '{{{ body }}}';
51
52			$this->guardAgainstInvalidLayout($layout);
53
54			$data = array_merge(['body' => $html], $data);
55
56			return $this->mustache->render($layout, $data);
57			}
58
59			protected function guardAgainstInvalidLayout(string $layout)
60			{
61			if (!str_contains($layout, [
62			'{{{body}}}',
63			'{{{ body }}}',
64			'{{body}}',
65			'{{ body }}'
66			])) {
67			throw CannotRenderTemplateMailable::layoutDoesNotContainABodyPlaceHolder($this->templateMailable, $this->mailTemplate, $layout);
68			}
69			}
70			}
71

spatie / laravel-database-mail-templates

Push — master ( 284849...6c8a74 )

guardAgainstInvalidLayout() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like