Tvi\MonitorBundle\Reporter\Mailer

Complexity

Total Complexity

9

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	sendEmail()	0	22	3
A	onFinish()	0	20	5
A	__construct()	0	7	1

<?php

/**
 * This file is part of the `tvi/monitor-bundle` project.
 *
 * (c) https://github.com/turnaev/monitor-bundle/graphs/contributors
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Tvi\MonitorBundle\Reporter;

use Swift_Mailer;
use Swift_Message;
use ZendDiagnostics\Check\CheckInterface;
use ZendDiagnostics\Result\Collection as ResultsCollection;
use ZendDiagnostics\Result\ResultInterface;

/**

Missing short description in doc comment

 * @author louis <louis@systemli.org>, Vladimir Turnaev <turnaev@gmail.com>

Content of the @author tag must be in the form "Display Name <username@example.com>"

 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Mailer extends ReporterAbstract
{
    protected $mailer;
    protected $recipient;
    protected $subject;
    protected $sender;
    protected $sendOnWarning;

    /**

Missing short description in doc comment

Parameter $mailer should have a doc-comment as per coding-style.

     * @param string $recipient

Missing parameter comment

Doc comment for parameter $recipient does not match actual variable name $mailer

     * @param string $sender

Missing parameter comment

Doc comment for parameter $sender does not match actual variable name $recipient

     * @param string $subject

Missing parameter comment

Doc comment for parameter $subject does not match actual variable name $sender

     * @param bool   $sendOnWarning

Missing parameter comment

Doc comment for parameter $sendOnWarning does not match actual variable name $subject

     */
    public function __construct(Swift_Mailer $mailer, $recipient, $sender, $subject, $sendOnWarning = true)
    {
        $this->mailer = $mailer;
        $this->recipient = $recipient;
        $this->sender = $sender;
        $this->subject = $subject;
        $this->sendOnWarning = $sendOnWarning;
    }

    /**

Parameter $results should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @return tag in function comment

    public function onFinish(ResultsCollection $results)
    {
        parent::onFinish($results);

        if ($results->getUnknownCount() > 0) {
            $this->sendEmail($results);

            return;
        }

        if ($results->getWarningCount() > 0 && $this->sendOnWarning) {
            $this->sendEmail($results);

            return;
        }

        if ($results->getFailureCount() > 0) {
            $this->sendEmail($results);

            return;
        }
    }

    private function sendEmail(ResultsCollection $results)

Private method name "Mailer::sendEmail" must be prefixed with an underscore

Missing doc comment for function sendEmail()

    {
        $body = '';

        foreach ($results as $check) {
            /* @var $check  CheckInterface */
            /* @var $result ResultInterface */
            $result = $results[$check] ?? null;

            if ($result instanceof ResultInterface) {
                $body .= sprintf("Check: %s\n", $check->getLabel());
                $body .= sprintf("Message: %s\n\n", $result->getMessage());
            }
        }

        $message = (new Swift_Message())
            ->setSubject($this->subject)
            ->setFrom($this->sender)
            ->setTo($this->recipient)
            ->setBody($body);

        $this->mailer->send($message);
    }
}