MailTemplate - Code Metrics - Inspection of "[Enhancement] Make it depending on interface" - spatie/laravel-database-mail-templates - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#7)

unknown

created 2018-11-06 11:30 UTC

MailTemplate A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	51
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes

Metric	Value
dl	0
loc	51
c	0
b	0
f	0
wmc	9
lcom	0
cbo	3
rs	10

7 Methods

Rating	Name	Size	Complexity
A	getVariablesAttribute()	4	1
A	scopeForMailable()	4	1
A	findForMailable()	10	2
A	getLayout()	4	1
A	getVariables()	10	2
A	subject()	4	1
A	template()	4	1

<?php

namespace Spatie\MailTemplates\Models;

use Illuminate\Contracts\Mail\Mailable;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;
use Spatie\MailTemplates\Exceptions\MissingMailTemplate;
use Spatie\MailTemplates\Interfaces\MailTemplateInterface;

class MailTemplate extends Model implements MailTemplateInterface
{
    protected $guarded = [];

    public function scopeForMailable(Builder $query, Mailable $mailable): Builder
    {
        return $query->where('mailable', get_class($mailable));
    }

    public static function findForMailable(Mailable $mailable): self
    {
        $mailTemplate = static::forMailable($mailable)->first();


        if (! $mailTemplate) {
            throw MissingMailTemplate::forMailable($mailable);
        }

        return $mailTemplate;
    }

    public function getLayout(): ?string
    {
        return null;
    }

    public function getVariables(): array
    {
        $mailableClass = $this->mailable;
<?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 (! class_exists($mailableClass)) {
            return [];
        }

        return $mailableClass::getVariables();
    }

    public function getVariablesAttribute(): array
    {
        return $this->getVariables();
    }

    public function subject(): string
    {
        return $this->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.");
        }
    }

}
    }

    public function template(): string
    {
        return $this->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.");
        }
    }

}
    }
}


1			<?php
2
3			namespace Spatie\MailTemplates\Models;
4
5			use Illuminate\Contracts\Mail\Mailable;
6			use Illuminate\Database\Eloquent\Model;
7			use Illuminate\Database\Eloquent\Builder;
8			use Spatie\MailTemplates\Exceptions\MissingMailTemplate;
9			use Spatie\MailTemplates\Interfaces\MailTemplateInterface;
10
11			class MailTemplate extends Model implements MailTemplateInterface
12			{
13			protected $guarded = [];
14
15			public function scopeForMailable(Builder $query, Mailable $mailable): Builder
16			{
17			return $query->where('mailable', get_class($mailable));
18			}
19
20			public static function findForMailable(Mailable $mailable): self
21			{
22			$mailTemplate = static::forMailable($mailable)->first();
			0 ignored issues – show Bug introduced 2018-10-11 15:19 UTC by Report Bug Copy Issue Report The method `forMailable()` does not exist on `Spatie\MailTemplates\Models\MailTemplate`. Did you maybe mean `scopeForMailable()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
23
24			if (! $mailTemplate) {
25			throw MissingMailTemplate::forMailable($mailable);
26			}
27
28			return $mailTemplate;
29			}
30
31			public function getLayout(): ?string
32			{
33			return null;
34			}
35
36			public function getVariables(): array
37			{
38			$mailableClass = $this->mailable;
			0 ignored issues – show Documentation introduced 2018-10-11 15:19 UTC by Report Bug Copy Issue Report The property `mailable` does not exist on `object<Spatie\MailTemplates\Models\MailTemplate>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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
40			if (! class_exists($mailableClass)) {
41			return [];
42			}
43
44			return $mailableClass::getVariables();
45			}
46
47			public function getVariablesAttribute(): array
48			{
49			return $this->getVariables();
50			}
51
52			public function subject(): string
53			{
54			return $this->subject;
			0 ignored issues – show Documentation introduced 2018-11-06 11:41 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...
55			}
56
57			public function template(): string
58			{
59			return $this->template;
			0 ignored issues – show Documentation introduced 2018-11-06 11:41 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...
60			}
61			}
62

spatie / laravel-database-mail-templates

Pull Request — master (#7)

MailTemplate A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

Duplication Side-by-Side

Filter issues like