SwiftMailer::getSwiftMailer() - Code Metrics - Inspection of "NEW Move to SwiftMailer powered Emails (#6466)" - silverstripe/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e6ae53...3ea501 )

by Sam

created 2017-01-13 01:48 UTC

SwiftMailer::getSwiftMailer() A

↳ Parent: SwiftMailer

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace SilverStripe\Control\Email;

use SilverStripe\Core\Config\Configurable;
use SilverStripe\Core\Injector\Injectable;
use SilverStripe\Core\Injector\Injector;
use Swift_Mailer;
use Swift_Message;

/**
 * Mailer objects are responsible for actually sending emails.
 * The default Mailer class will use PHP's mail() function.
 */
class SwiftMailer implements Mailer
{

    use Configurable;
    use Injectable;

    /**
     * @var array
     * @config
     */
    private static $swift_plugins = array(
        SwiftPlugin::class,
    );

    /**
     * @var Swift_Mailer
     */
    private $swift;

    /**
     * @param Email $message
     * @return bool Whether the sending was "successful" or not
     */
    public function send($message)
    {
        $swiftMessage = $message->getSwiftMessage();
        $failedRecipients = array();
        $result = $this->sendSwift($swiftMessage, $failedRecipients);
        $message->setFailedRecipients($failedRecipients);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        return $result != 0;
    }

    /**
     * @param Swift_Message $message
     * @param array $failedRecipients
     * @return int
     */
    protected function sendSwift($message, &$failedRecipients = null)
    {
        return $this->getSwiftMailer()->send($message, $failedRecipients);
    }

    /**
     * @return Swift_Mailer
     */
    public function getSwiftMailer()
    {
        return $this->swift;
    }

    /**
     * @param Swift_Mailer $swift
     * @return $this
     */
    public function setSwiftMailer($swift)
    {
        // register any required plugins
        foreach ($this->config()->get('swift_plugins') as $plugin) {
            $swift->registerPlugin(Injector::inst()->create($plugin));
        }
        $this->swift = $swift;

        return $this;
    }
}


1			<?php
2
3			namespace SilverStripe\Control\Email;
4
5			use SilverStripe\Core\Config\Configurable;
6			use SilverStripe\Core\Injector\Injectable;
7			use SilverStripe\Core\Injector\Injector;
8			use Swift_Mailer;
9			use Swift_Message;
10
11			/**
12			* Mailer objects are responsible for actually sending emails.
13			* The default Mailer class will use PHP's mail() function.
14			*/
15			class SwiftMailer implements Mailer
16			{
17
18			use Configurable;
19			use Injectable;
20
21			/**
22			* @var array
23			* @config
24			*/
25			private static $swift_plugins = array(
26			SwiftPlugin::class,
27			);
28
29			/**
30			* @var Swift_Mailer
31			*/
32			private $swift;
33
34			/**
35			* @param Email $message
36			* @return bool Whether the sending was "successful" or not
37			*/
38			public function send($message)
39			{
40			$swiftMessage = $message->getSwiftMessage();
41			$failedRecipients = array();
42			$result = $this->sendSwift($swiftMessage, $failedRecipients);
43			$message->setFailedRecipients($failedRecipients);
			0 ignored issues – show Bug introduced 2017-01-12 13:53 UTC by Report Bug Copy Issue Report It seems like `$failedRecipients` can also be of type `null`; however, `SilverStripe\Control\Ema...::setFailedRecipients()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
44
45			return $result != 0;
46			}
47
48			/**
49			* @param Swift_Message $message
50			* @param array $failedRecipients
51			* @return int
52			*/
53			protected function sendSwift($message, &$failedRecipients = null)
54			{
55			return $this->getSwiftMailer()->send($message, $failedRecipients);
56			}
57
58			/**
59			* @return Swift_Mailer
60			*/
61			public function getSwiftMailer()
62			{
63			return $this->swift;
64			}
65
66			/**
67			* @param Swift_Mailer $swift
68			* @return $this
69			*/
70			public function setSwiftMailer($swift)
71			{
72			// register any required plugins
73			foreach ($this->config()->get('swift_plugins') as $plugin) {
74			$swift->registerPlugin(Injector::inst()->create($plugin));
75			}
76			$this->swift = $swift;
77
78			return $this;
79			}
80			}
81

silverstripe / silverstripe-framework

Push — master ( e6ae53...3ea501 )

SwiftMailer::getSwiftMailer() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like