TemplateMailableRenderer - Code Metrics - Inspection of "wip on tests" - spatie/laravel-database-mail-templates - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( aa8b87...f1e278 )

unknown

created 2018-10-11 16:20 UTC

TemplateMailableRenderer A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
wmc	9
lcom	1
cbo	4
dl	0
loc	72
rs	10
c	0
b	0
f	0

5 Methods

Rating	Name	Size	Complexity
A	__construct()	9	1
A	render()	13	2
A	renderTextView()	9	2
A	renderSubject()	7	1
A	renderInLayout()	15	3

<?php

namespace Spatie\MailTemplates;

use Illuminate\Mail\Markdown;
use Illuminate\Support\Facades\Mail;
use Mustache_Engine;
use Spatie\MailTemplates\Exceptions\CannotRenderTemplateMailable;
use Spatie\MailTemplates\Models\MailTemplate;

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

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

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

    /** @var Markdown */
    protected $markdown;

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

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

    public function render(array $data = []): string
    {
        $renderer = ($this->mailTemplate->isMarkdown()
            ? $this->markdown->theme($this->mailTemplate->markdown_theme ?? 'default')
<?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.");
        }
    }

}
            : $this->mustache);

        $html = $renderer->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 renderTextView(array $data = []): ?string
    {
        if ($this->mailTemplate->isMarkdown()) {
            return $this->templateMailable->textView
                ?? $this->markdown->renderText($this->mailTemplate->template, $data);
<?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.");
        }
    }

}
        }

        return $this->templateMailable->textView ?? null;
    }

    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 }}}';

        // TODO: Regex for finding {{{ body }}} in layout string
        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 Illuminate\Mail\Markdown;
6			use Illuminate\Support\Facades\Mail;
7			use Mustache_Engine;
8			use Spatie\MailTemplates\Exceptions\CannotRenderTemplateMailable;
9			use Spatie\MailTemplates\Models\MailTemplate;
10
11			class TemplateMailableRenderer
12			{
13			/** @var TemplateMailable */
14			protected $templateMailable;
15
16			/** @var MailTemplate */
17			protected $mailTemplate;
18
19			/** @var Mustache_Engine */
20			protected $mustache;
21
22			/** @var Markdown */
23			protected $markdown;
24
25			public function __construct(TemplateMailable $templateMailable, Mustache_Engine $mustache, Markdown $markdown)
26			{
27			$this->templateMailable = $templateMailable;
28			$this->mustache = $mustache;
29			$this->markdown = $markdown;
30
31			$templateModel = $this->templateMailable->getTemplateModel();
32			$this->mailTemplate = $templateModel::findForMailable($templateMailable);
33			}
34
35			public function render(array $data = []): string
36			{
37			$renderer = ($this->mailTemplate->isMarkdown()
38			? $this->markdown->theme($this->mailTemplate->markdown_theme ?? 'default')
			0 ignored issues – show Documentation introduced 2018-10-11 16:22 UTC by Report Bug Copy Issue Report The property `markdown_theme` 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...
39			: $this->mustache);
40
41			$html = $renderer->render(
42			$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...
43			$data
44			);
45
46			return $this->renderInLayout($html, $data);
47			}
48
49			public function renderTextView(array $data = []): ?string
50			{
51			if ($this->mailTemplate->isMarkdown()) {
52			return $this->templateMailable->textView
53			?? $this->markdown->renderText($this->mailTemplate->template, $data);
			0 ignored issues – show Documentation introduced 2018-10-11 16:22 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...
54			}
55
56			return $this->templateMailable->textView ?? null;
57			}
58
59			public function renderSubject(array $data = []): string
60			{
61			return $this->mustache->render(
62			$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...
63			$data
64			);
65			}
66
67			protected function renderInLayout(string $html, array $data = []): string
68			{
69			$layout = $this->templateMailable->getLayout()
70			?? $this->mailTemplate->getLayout()
71			?? '{{{ body }}}';
72
73			// TODO: Regex for finding {{{ body }}} in layout string
74			if ($layout && ! str_contains($layout, ['{{{body}}}', '{{{ body }}}', '{{body}}', '{{ body }}'])) {
75			throw CannotRenderTemplateMailable::layoutDoesNotContainABodyPlaceHolder($this->templateMailable, $this->mailTemplate, $layout);
76			}
77
78			$data = array_merge(['body' => $html], $data);
79
80			return $this->mustache->render($layout, $data);
81			}
82			}
83

spatie / laravel-database-mail-templates

Push — master ( aa8b87...f1e278 )

TemplateMailableRenderer A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Duplication Side-by-Side

Filter issues like