Nip\MailModule\Models\EmailsTable\EmailTrait

Complexity

Total Complexity

30

Size/Duplication

Total Lines	213
Duplicated Lines	0 %

Test Coverage

Coverage

3.8%

Importance

Changes	9
Bugs	0	Features	3

17 Methods

Rating	Name	Duplication	Size	Complexity
A	getBody()	0	3	1
A	populateFromConfig()	0	5	1
A	getFrom()	0	8	2
A	getPreviewBody()	0	3	1
A	populateFromItem()	0	4	1
A	getSubject()	0	3	1
A	IsHTML()	0	7	3
A	delete()	0	4	1
A	getTos()	0	15	4
A	buildMailMessageAttachments()	0	5	2
A	getReplyTos()	0	6	2
A	getBccTos()	0	6	2
A	clearAttachments()	0	3	1
A	afterSend()	0	13	1
A	getActivitiesByEmail()	0	12	3
A	getLinksByEmail()	0	12	3
A	getCustomArgs()	0	7	1

<?php
declare(strict_types=1);

namespace Nip\MailModule\Models\EmailsTable;

use ByTIC\DataObjects\Behaviors\Timestampable\TimestampableTrait;
use ByTIC\MediaLibrary\HasMedia\HasMediaTrait;
use Nip\Mail\Message;
use Nip\Mail\Models\Mailable\RecordTrait as MailableRecordTrait;
use Nip\MailModule\Models\EmailsTable\Traits\MergeTags\MergeTagsRecordTrait;
use Nip\Records\AbstractModels\Record;
use Symfony\Component\Mailer\MailerInterface;

/**
 * Trait EmailTrait
 * @package Nip\Mail\Models\EmailsTable
 *
 * @property int $id_item
 * @property string $type
 * @property string $smtp_host
 * @property string $smtp_user
 * @property string $smtp_password
 * @property string $to
 * @property string $reply_to
 * @property string $bcc
 * @property string $subject
 * @property string $compiled_subject
 * @property string $body
 * @property string $compiled_body
 * @property string $vars
 * @property string $is_html
 * @property string $sent
 * @property string $date_sent
 * @property string $created
 */
trait EmailTrait
{
    use MailableRecordTrait;
    use HasMediaTrait;
    use MergeTagsRecordTrait;
    use TimestampableTrait;

    public ?string $body = null;

    public ?string $from = '';
    public ?string $from_name = '';

    public ?string $subject = '';

    protected static $createTimestamps = 'created';

    public function populateFromConfig()
    {
        $config = app('config');
        $this->from = $config->get('mail.from.address');
        $this->from_name = $config->get('mail.from.name');
    }

    /**
     * @param Record $item
     */
    public function populateFromItem($item)
    {
        $this->id_item = $item->id;
        $this->type = inflector()->singularize($item->getManager()->getTable());
    }

    /**
     * @inheritdoc
     * Used to decode html entities to proper chars
     */
    public function getFrom()
    {
        if (empty($this->getPropertyRaw('from'))) {

It seems like getPropertyRaw() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $config = app('config');
            $this->from = $config->get('mail.from.address');
            $this->from_name = $config->get('mail.from.name');
        }
        return html_entity_decode($this->from_name, ENT_QUOTES) . ' <' . $this->from . '>';

It seems like $this->from_name can also be of type null; however, parameter $string of html_entity_decode() does only seem to accept string, maybe add an additional type check?

    }

    /**
     * @return string
     */
    public function getPreviewBody()
    {
        return $this->getBody();
    }

    /**
     * @return string
     */
    public function getBody()
    {
        return $this->body;
    }

    /**
     * @return string
     */
    public function getSubject(): ?string
    {
        return $this->subject;
    }

    /**
     * @return array
     */
    public function getTos()
    {
        $emailsTos = [];
        if (preg_match_all('/\s*"?([^><,"]+)"?\s*((?:<[^><,]+>)?)\s*/', (string)$this->to, $matches,
                PREG_SET_ORDER) > 0) {
            foreach ($matches as $m) {
                if (!empty($m[2])) {
                    $emailsTos[trim($m[2], '<>')] = html_entity_decode($m[1]);
                } else {
                    $emailsTos[$m[1]] = '';
                }
            }
        }

        return $emailsTos;
    }

    /**
     * @return array
     */
    public function getReplyTos()
    {
        if (empty($this->reply_to)) {
            return null;
        }
        return [$this->reply_to => html_entity_decode($this->from_name, ENT_QUOTES)];

It seems like $this->from_name can also be of type null; however, parameter $string of html_entity_decode() does only seem to accept string, maybe add an additional type check?

    }

    /**
     * @return array
     */
    public function getBccTos()
    {
        if (empty($this->bcc)) {
            return null;
        }
        return [$this->bcc => ''];
    }

    public function delete()
    {
        $this->clearAttachments();
        parent::delete();
    }

    public function clearAttachments()
    {
        $this->getFiles()->delete();
    }

    /**
     * @param Message $message
     */
    public function buildMailMessageAttachments(&$message)
    {
        $emailFiles = $this->getFiles();
        foreach ($emailFiles as $emailFile) {
            $message->attachFromContent($emailFile->read(), $emailFile->getName());

The function Nip\Mail\Message::attachFromContent() has been deprecated: use attach() instead

        }
    }

    /**
     * @return array|null
     */
    protected function getCustomArgs(): ?array
    {
        $args = [];
        $args['category'] = $this->type;
        $args['id_email'] = $this->id;

        return $args;
    }

    /**
     * @param null $value

Are you sure the doc-type for parameter $value is correct as it would always require null to be passed?

     * @return bool
     * @noinspection PhpUnused
     * @noinspection PhpMethodNamingConventionInspection
     */
    public function IsHTML($value = null)
    {
        if (is_bool($value)) {

The condition is_bool($value) is always false.

            $this->is_html = $value ? 'yes' : 'no';
        }

        return $this->is_html == 'yes';
    }

    /**
     * @return mixed
     */
    public function getActivitiesByEmail()
    {
        if (!$this->getRegistry()->exists('activities-email')) {

It seems like getRegistry() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $actEmail = [];
            $activities = $this->getActivities();

The method getActivities() does not exist on Nip\MailModule\Models\EmailsTable\EmailTrait. Did you maybe mean getActivitiesByEmail()?

            foreach ($activities as $activity) {
                $actEmail[$activity->email][] = $activity;
            }
            $this->getRegistry()->set('activities-email', $actEmail);
        }

        return $this->getRegistry()->get('activities-email');
    }

    /**
     * @return mixed
     */
    public function getLinksByEmail()
    {
        if (!$this->getRegistry()->exists('links-email')) {
            $linksEmail = [];

The assignment to $linksEmail is dead and can be removed.

            $links = $this->getLinks();

The method getLinks() does not exist on Nip\MailModule\Models\EmailsTable\EmailTrait. Did you maybe mean getLinksByEmail()?

            foreach ($links as $link) {
                $actEmail[$link->url][$link->email] = $link;
            }
            $this->getRegistry()->set('links-email', $actEmail);

The variable $actEmail seems to be defined by a foreach iteration on line 222. Are you sure the iterator is never empty, otherwise this variable is not defined?

        }

        return $this->getRegistry()->get('links-email');
    }

    /**
     * @param MailerInterface $mailer
     * @param Message $message
     * @param $response
     */
    protected function afterSend($mailer, $message)

The parameter $message is not used and could be removed.

The parameter $mailer is not used and could be removed.

    {
        $this->sent = 'yes';
        $this->smtp_user = '';
        $this->smtp_host = '';
        $this->smtp_password = '';
//            $this->subject = '';
//            $this->body = '';
        //        $this->vars = '';
        $this->date_sent = date('Y-m-d H:i:s');
        $this->update();

The method update() does not exist on Nip\MailModule\Models\EmailsTable\EmailTrait. Did you maybe mean updatedTimestamps()?

        $this->clearAttachments();
    }
}