Messenger::formatGateways() - Code Metrics - Inspection of ":sparkles: Add strategy support." - overtrue/easy-sms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 295927...ec8326 )

by Carlos

created 2017-04-29 13:11 UTC

Messenger::formatGateways() B

↳ Parent: Messenger

Complexity

Conditions	7
Paths	5

Size

Total Lines	20
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	20
c	0
b	0
f	0
rs	8.2222
cc	7
eloc	11
nc	5
nop	1

<?php

/*
 * This file is part of the overtrue/easy-sms.
 * (c) overtrue <[email protected]>
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Overtrue\EasySms;

use Overtrue\EasySms\Contracts\MessageInterface;

/**
 * Class Messenger.
 */
class Messenger
{
    const STATUS_SUCCESS = 'success';
    const STATUS_ERRED = 'erred';

    /**
     * @var \Overtrue\EasySms\EasySms
     */
    protected $easySms;

    /**
     * Messenger constructor.
     *
     * @param \Overtrue\EasySms\EasySms $easySms
     */
    public function __construct(EasySms $easySms)
    {
        $this->easySms = $easySms;
    }

    /**
     * Send a message.
     *
     * @param string                                       $to
     * @param \Overtrue\EasySms\Contracts\MessageInterface $message
     * @param array                                        $gateways
     *
     * @return array
     */
    public function send($to, MessageInterface $message, array $gateways = [])
    {
        if (!($message instanceof MessageInterface)) {
            $message = new Message([
                'content' => $message,
                'template' => $message,
            ]);
        }

        $results = [];

        if (empty($gateways)) {
            $gateways = $message->getGateways();
        }

        $gateways = $this->formatGateways($gateways);
        $strategyAppliedGateways = $this->easySms->strategy()->apply($gateways);

        foreach ($strategyAppliedGateways as $gateway) {
            try {
                $result[$gateway] = [
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                        'status' => self::STATUS_SUCCESS,
                        'result' => $this->easySms->gateway($gateway)->send($to, $message, new Config($gateways[$gateway])),
                    ];
            } catch (GatewayErrorException $e) {

                $result[$gateway] = [
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                    'status' => self::STATUS_ERRED,
                    'exception' => $e,
                ];
                continue;
            }
        }

        return $results;
    }

    /**
     * @param array $gateways
     *
     * @return array
     */
    protected function formatGateways(array $gateways)
    {
        $formatted = [];
        $config = $this->easySms->getConfig();

        foreach ($gateways as $gateway => $setting) {
            if (is_integer($gateway) && is_string($setting)) {
                $gateway = $setting;
                $setting = [];
            }

            $globalSetting = $config->get("gateways.{$gateway}", []);

            if (is_string($gateway) && !empty($globalSetting) && is_array($setting)) {
                $formatted[$gateway] = array_merge($globalSetting, $setting);
            }
        }

        return $formatted;
    }
}


1			<?php
2
3			/*
4			* This file is part of the overtrue/easy-sms.
5			* (c) overtrue <[email protected]>
6			* This source file is subject to the MIT license that is bundled
7			* with this source code in the file LICENSE.
8			*/
9
10			namespace Overtrue\EasySms;
11
12			use Overtrue\EasySms\Contracts\MessageInterface;
13
14			/**
15			* Class Messenger.
16			*/
17			class Messenger
18			{
19			const STATUS_SUCCESS = 'success';
20			const STATUS_ERRED = 'erred';
21
22			/**
23			* @var \Overtrue\EasySms\EasySms
24			*/
25			protected $easySms;
26
27			/**
28			* Messenger constructor.
29			*
30			* @param \Overtrue\EasySms\EasySms $easySms
31			*/
32			public function __construct(EasySms $easySms)
33			{
34			$this->easySms = $easySms;
35			}
36
37			/**
38			* Send a message.
39			*
40			* @param string $to
41			* @param \Overtrue\EasySms\Contracts\MessageInterface $message
42			* @param array $gateways
43			*
44			* @return array
45			*/
46			public function send($to, MessageInterface $message, array $gateways = [])
47			{
48			if (!($message instanceof MessageInterface)) {
49			$message = new Message([
50			'content' => $message,
51			'template' => $message,
52			]);
53			}
54
55			$results = [];
56
57			if (empty($gateways)) {
58			$gateways = $message->getGateways();
59			}
60
61			$gateways = $this->formatGateways($gateways);
62			$strategyAppliedGateways = $this->easySms->strategy()->apply($gateways);
63
64			foreach ($strategyAppliedGateways as $gateway) {
65			try {
66			$result[$gateway] = [
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-04-29 13:13 UTC by Report Bug Copy Issue Report `$result` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$result = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
67			'status' => self::STATUS_SUCCESS,
68			'result' => $this->easySms->gateway($gateway)->send($to, $message, new Config($gateways[$gateway])),
69			];
70			} catch (GatewayErrorException $e) {
			0 ignored issues – show Bug introduced 2017-04-28 13:15 UTC by Report Bug Copy Issue Report The class `Overtrue\EasySms\GatewayErrorException` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
71			$result[$gateway] = [
			0 ignored issues – show Bug introduced 2017-04-29 13:13 UTC by Report Bug Copy Issue Report The variable `$result` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
72			'status' => self::STATUS_ERRED,
73			'exception' => $e,
74			];
75			continue;
76			}
77			}
78
79			return $results;
80			}
81
82			/**
83			* @param array $gateways
84			*
85			* @return array
86			*/
87			protected function formatGateways(array $gateways)
88			{
89			$formatted = [];
90			$config = $this->easySms->getConfig();
91
92			foreach ($gateways as $gateway => $setting) {
93			if (is_integer($gateway) && is_string($setting)) {
94			$gateway = $setting;
95			$setting = [];
96			}
97
98			$globalSetting = $config->get("gateways.{$gateway}", []);
99
100			if (is_string($gateway) && !empty($globalSetting) && is_array($setting)) {
101			$formatted[$gateway] = array_merge($globalSetting, $setting);
102			}
103			}
104
105			return $formatted;
106			}
107			}
108

overtrue / easy-sms

GitHub Access Token became invalid

Push — master ( 295927...ec8326 )

Messenger::formatGateways() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like