AzineMailgunMailerService::sendSpamComplaintNotification() - Code Metrics - Inspection of "add phpDocs" - azine/AzineMailgunWebhooksBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — issue/AZ_53_respond_to_spam_ev... ( b7bb66 )

by Dominik

created 2017-11-06 10:28 UTC

sendSpamComplaintNotification() B

↳ Parent: AzineMailgunMailerService

Complexity

Conditions	6
Paths	12

Size

Total Lines	48
Code Lines	28

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
dl	0
loc	48
rs	8.551
c	2
b	0
f	0
cc	6
eloc	28
nc	12
nop	1

<?php


namespace Azine\MailgunWebhooksBundle\Services;

use Symfony\Component\Translation\Translator;
use Symfony\Component\Translation\TranslatorInterface;
use Azine\MailgunWebhooksBundle\Entity\EmailTrafficStatistics;
use Doctrine\ORM\EntityManager;

class AzineMailgunMailerService
{
    /**
     * @var \Swift_Mailer
     */
    private $mailer;

    /**
     * @var \Twig_Environment
     */
    private $twig;

    /**
     * @var TranslatorInterface
     */
    private $translator;

    /**
     * @var string
     */
    private $fromEmail;

    /**
     * @var string
     */
    private $ticketId;

    /**
     * @var string
     */
    private $ticketSubject;

    /**
     * @var string
     */
    private $ticketMessage;

    /**
     * @var string
     */
    private $spamAlertsRecipientEmail;

    /**
     * @var EntityManager
     */
    private $entityManager;

    /**
     * @var int
     */
    private $sendNotificationsInterval;

    /**
     * AzineMailgunMailerService constructor.
     *
     * @param \Swift_Mailer $mailer
     * @param \Twig_Environment $twig
     * @param TranslatorInterface $translator
     * @param string $fromEmail
     * @param string $ticketId
     * @param string $ticketSubject
     * @param string $ticketMessage
     * @param string $spamAlertsRecipientEmail
     * @param EntityManager $entityManager
     * @param int $sendNotificationsInterval
     */
    public function __construct(
        \Swift_Mailer $mailer,
        \Twig_Environment $twig,
        TranslatorInterface $translator,
        $fromEmail,
        $ticketId,
        $ticketSubject,
        $ticketMessage,
        $spamAlertsRecipientEmail,
        EntityManager $entityManager,
function someFunction(ManagerRegistry $registry) {
    $em = $registry->getManager();
    $em->getConnection()->beginTransaction();
    try {
        // Do something.
        $em->getConnection()->commit();
    } catch (\Exception $ex) {
        $em->getConnection()->rollback();
        $em->close();

        throw $ex;
    }
}
        $sendNotificationsInterval
    ) {
        $this->mailer = $mailer;
        $this->twig = $twig;
        $this->translator = $translator;
        $this->fromEmail = $fromEmail;
        $this->ticketId = $ticketId;
        $this->ticketSubject = $ticketSubject;
        $this->ticketMessage = $ticketMessage;
        $this->spamAlertsRecipientEmail = $spamAlertsRecipientEmail;
        $this->entityManager = $entityManager;
        $this->sendNotificationsInterval = $sendNotificationsInterval;
    }

    /**
     * @param string $eventId
     * @throws \Exception
     * @return int $messagesSent
     */
    public function  sendSpamComplaintNotification($eventId)
    {
        $messagesSent = 0;
        $failedRecipients = [];

        /** @var \Swift_Message $message */
        $message = $this->mailer->createMessage();
        $message->setTo($this->spamAlertsRecipientEmail)
            ->setFrom($this->fromEmail)
            ->setSubject($this->translator->trans('notification.spam_complaint_received'))
            ->setBody(
                $this->twig->render('@AzineMailgunWebhooks/Email/notification.html.twig', array('eventId' => $eventId, 'ticketId' => $this->ticketId)),
                'text/html'
            );

        $lastSpamReport = $this->entityManager->getRepository(EmailTrafficStatistics::class)
            ->getLastByAction(EmailTrafficStatistics::SPAM_ALERT_SENT);

        if($lastSpamReport instanceof EmailTrafficStatistics) {

            $time = new \DateTime();
            $timeDiff = $time->diff($lastSpamReport->getCreated());

            if($timeDiff->i > $this->sendNotificationsInterval) {

                $messagesSent = $this->mailer->send($message, $failedRecipients);
            }

        }else{

            $messagesSent = $this->mailer->send($message, $failedRecipients);
        }

        if($messagesSent > 0) {

            $spamAlert = new EmailTrafficStatistics();
            $spamAlert->setAction(EmailTrafficStatistics::SPAM_ALERT_SENT);
            $this->entityManager->persist($spamAlert);
            $this->entityManager->flush($spamAlert);
            $this->entityManager->clear();
        }

        if($messagesSent == 0 && !empty($failedRecipients)){

            throw new \Exception('Tried to send notification about spam complaint but no messages were sent');
        }
        return $messagesSent;
    }
}

1			<?php
2
3
4			namespace Azine\MailgunWebhooksBundle\Services;
5
6			use Symfony\Component\Translation\Translator;
7			use Symfony\Component\Translation\TranslatorInterface;
8			use Azine\MailgunWebhooksBundle\Entity\EmailTrafficStatistics;
9			use Doctrine\ORM\EntityManager;
10
11			class AzineMailgunMailerService
12			{
13			/**
14			* @var \Swift_Mailer
15			*/
16			private $mailer;
17
18			/**
19			* @var \Twig_Environment
20			*/
21			private $twig;
22
23			/**
24			* @var TranslatorInterface
25			*/
26			private $translator;
27
28			/**
29			* @var string
30			*/
31			private $fromEmail;
32
33			/**
34			* @var string
35			*/
36			private $ticketId;
37
38			/**
39			* @var string
40			*/
41			private $ticketSubject;
42
43			/**
44			* @var string
45			*/
46			private $ticketMessage;
47
48			/**
49			* @var string
50			*/
51			private $spamAlertsRecipientEmail;
52
53			/**
54			* @var EntityManager
55			*/
56			private $entityManager;
57
58			/**
59			* @var int
60			*/
61			private $sendNotificationsInterval;
62
63			/**
64			* AzineMailgunMailerService constructor.
65			*
66			* @param \Swift_Mailer $mailer
67			* @param \Twig_Environment $twig
68			* @param TranslatorInterface $translator
69			* @param string $fromEmail
70			* @param string $ticketId
71			* @param string $ticketSubject
72			* @param string $ticketMessage
73			* @param string $spamAlertsRecipientEmail
74			* @param EntityManager $entityManager
75			* @param int $sendNotificationsInterval
76			*/
77			public function __construct(
78			\Swift_Mailer $mailer,
79			\Twig_Environment $twig,
80			TranslatorInterface $translator,
81			$fromEmail,
82			$ticketId,
83			$ticketSubject,
84			$ticketMessage,
85			$spamAlertsRecipientEmail,
86			EntityManager $entityManager,
			0 ignored issues – show Bug introduced 2017-11-06 10:42 UTC by Report Bug Copy Issue Report You have injected the EntityManager via parameter `$entityManager`. This is generally not recommended as it might get closed and become unusable. Instead, it is recommended to inject the ManagerRegistry and retrieve the EntityManager via `getManager()` each time you need it. The `EntityManager` might become unusable for example if a transaction is rolled back and it gets closed. Let’s assume that somewhere in your application, or in a third-party library, there is code such as the following: function someFunction(ManagerRegistry $registry) { $em = $registry->getManager(); $em->getConnection()->beginTransaction(); try { // Do something. $em->getConnection()->commit(); } catch (\Exception $ex) { $em->getConnection()->rollback(); $em->close(); throw $ex; } } If that code throws an exception and the `EntityManager` is closed. Any other code which depends on the same instance of the `EntityManager` during this request will fail. On the other hand, if you instead inject the `ManagerRegistry`, the `getManager()` method guarantees that you will always get a usable manager instance. Loading history...
87			$sendNotificationsInterval
88			) {
89			$this->mailer = $mailer;
90			$this->twig = $twig;
91			$this->translator = $translator;
92			$this->fromEmail = $fromEmail;
93			$this->ticketId = $ticketId;
94			$this->ticketSubject = $ticketSubject;
95			$this->ticketMessage = $ticketMessage;
96			$this->spamAlertsRecipientEmail = $spamAlertsRecipientEmail;
97			$this->entityManager = $entityManager;
98			$this->sendNotificationsInterval = $sendNotificationsInterval;
99			}
100
101			/**
102			* @param string $eventId
103			* @throws \Exception
104			* @return int $messagesSent
105			*/
106			public function sendSpamComplaintNotification($eventId)
107			{
108			$messagesSent = 0;
109			$failedRecipients = [];
110
111			/** @var \Swift_Message $message */
112			$message = $this->mailer->createMessage();
113			$message->setTo($this->spamAlertsRecipientEmail)
114			->setFrom($this->fromEmail)
115			->setSubject($this->translator->trans('notification.spam_complaint_received'))
116			->setBody(
117			$this->twig->render('@AzineMailgunWebhooks/Email/notification.html.twig', array('eventId' => $eventId, 'ticketId' => $this->ticketId)),
118			'text/html'
119			);
120
121			$lastSpamReport = $this->entityManager->getRepository(EmailTrafficStatistics::class)
122			->getLastByAction(EmailTrafficStatistics::SPAM_ALERT_SENT);
123
124			if($lastSpamReport instanceof EmailTrafficStatistics) {
125
126			$time = new \DateTime();
127			$timeDiff = $time->diff($lastSpamReport->getCreated());
128
129			if($timeDiff->i > $this->sendNotificationsInterval) {
130
131			$messagesSent = $this->mailer->send($message, $failedRecipients);
132			}
133
134			}else{
135
136			$messagesSent = $this->mailer->send($message, $failedRecipients);
137			}
138
139			if($messagesSent > 0) {
140
141			$spamAlert = new EmailTrafficStatistics();
142			$spamAlert->setAction(EmailTrafficStatistics::SPAM_ALERT_SENT);
143			$this->entityManager->persist($spamAlert);
144			$this->entityManager->flush($spamAlert);
145			$this->entityManager->clear();
146			}
147
148			if($messagesSent == 0 && !empty($failedRecipients)){
149
150			throw new \Exception('Tried to send notification about spam complaint but no messages were sent');
151			}
152			return $messagesSent;
153			}
154			}

azine / AzineMailgunWebhooksBundle

Push — issue/AZ_53_respond_to_spam_ev... ( b7bb66 )

sendSpamComplaintNotification() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like