JetSmsService::sendShortMessages() - Code Metrics - Inspection of "feat: Adds before and after callbacks for both sin..." - erdemkeren/jet-sms-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b898f3...cca52f )

by Hilmi Erdem

created 2018-02-16 23:45 UTC

JetSmsService::sendShortMessages() B

↳ Parent: JetSmsService

Complexity

Conditions	4
Paths	8

Size

Total Lines	23
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
dl	0
loc	23
ccs	0
cts	18
cp	0
rs	8.7972
c	0
b	0
f	0
cc	4
eloc	12
nc	8
nop	1
crap	20

<?php

namespace Erdemkeren\JetSms;

use Erdemkeren\JetSms\Http\Clients\JetSmsClientInterface;
use Erdemkeren\JetSms\Http\Responses\JetSmsResponseInterface;

/**
 * Class JetSmsService.
 */
final class JetSmsService
{
    /**
     * The jet sms client implementation.
     *
     * @var JetSmsClientInterface
     */
    private $client;

    /**
     * The short message factory implementation.
     *
     * @var ShortMessageFactoryInterface
     */
    private $factory;

    /**
     * The short message collection factory implementation.
     *
     * @var ShortMessageFactoryInterface
     */
    private $collectionFactory;

    /**
     * The before callback which will be called before sending single messages.
     *
     * @var callable|null
     */
    private $beforeSingleShortMessageCallback;

    /**
     * The after callback which will be called before sending single messages.
     *
     * @var callable|null
     */
    private $afterSingleShortMessageCallback;

    /**
     * The before callback which will be called before sending multiple messages.
     *
     * @var callable|null
     */
    private $beforeMultipleShortMessageCallback;

    /**
     * The after callback which will be called after sending multiple messages.
     *
     * @var callable|null
     */
    private $afterMultipleShortMessageCallback;

    /**
     * JetSmsService constructor.
     *
     * @param  JetSmsClientInterface                  $jetSmsClient
     * @param  ShortMessageFactoryInterface           $shortMessageFactory
     * @param  ShortMessageCollectionFactoryInterface $shortMessageCollectionFactory
     * @param  callable|null                          $beforeSingleShortMessageCallback
     * @param  callable|null                          $afterSingleShortMessageCallback
     * @param  callable|null                          $beforeMultipleShortMessageCallback
     * @param  callable|null                          $afterMultipleShortMessageCallback
     */
    public function __construct(
        JetSmsClientInterface $jetSmsClient,
        ShortMessageFactoryInterface $shortMessageFactory,
        ShortMessageCollectionFactoryInterface $shortMessageCollectionFactory,
        $beforeSingleShortMessageCallback = null,
        $afterSingleShortMessageCallback = null,
        $beforeMultipleShortMessageCallback = null,
        $afterMultipleShortMessageCallback = null
    ) {
        $this->client = $jetSmsClient;
        $this->factory = $shortMessageFactory;
        $this->collectionFactory = $shortMessageCollectionFactory;

        $this->beforeSingleShortMessageCallback = $beforeSingleShortMessageCallback;
        $this->afterSingleShortMessageCallback = $afterSingleShortMessageCallback;
        $this->beforeMultipleShortMessageCallback = $beforeMultipleShortMessageCallback;
        $this->afterMultipleShortMessageCallback = $afterMultipleShortMessageCallback;
    }

    /**
     * Send the given body to the given receivers.
     *
     * @param  string       $body      The body of the short message.
     * @param  array|string $receivers The receiver(s) of the message.
     *
     * @return JetSmsResponseInterface The parsed JetSms response object.
     */
    public function sendShortMessage($receivers, $body)
    {
        $shortMessage = $this->factory->create($receivers, $body);

        if(is_callable($this->beforeSingleShortMessageCallback)) {
            ($this->beforeSingleShortMessageCallback)($shortMessage);
        }

        $response = $this->client->sendShortMessage($shortMessage);

        if(is_callable($this->afterSingleShortMessageCallback)) {
            ($this->afterSingleShortMessageCallback)($response, $shortMessage);
        }

        return $response;
    }

    /**
     * Send the given short messages.
     *
     * @param  array $messages         An array containing short message arrays.
     *
     * @return JetSmsResponseInterface The parsed JetSms response object.
     */
    public function sendShortMessages(array $messages)
    {
        $collection = $this->collectionFactory->create();


        if(is_callable($this->beforeMultipleShortMessageCallback)) {
            ($this->beforeMultipleShortMessageCallback)($collection);
        }

        foreach ($messages as $message) {
            $collection->push($this->factory->create(

                $message['recipient'],
                $message['message']
            ));
        }

        $response = $this->client->sendShortMessages($collection);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        if(is_callable($this->afterMultipleShortMessageCallback)) {
            ($this->afterMultipleShortMessageCallback)($response, $collection);
        }

        return $response;
    }
}


1			<?php
2
3			namespace Erdemkeren\JetSms;
4
5			use Erdemkeren\JetSms\Http\Clients\JetSmsClientInterface;
6			use Erdemkeren\JetSms\Http\Responses\JetSmsResponseInterface;
7
8			/**
9			* Class JetSmsService.
10			*/
11			final class JetSmsService
12			{
13			/**
14			* The jet sms client implementation.
15			*
16			* @var JetSmsClientInterface
17			*/
18			private $client;
19
20			/**
21			* The short message factory implementation.
22			*
23			* @var ShortMessageFactoryInterface
24			*/
25			private $factory;
26
27			/**
28			* The short message collection factory implementation.
29			*
30			* @var ShortMessageFactoryInterface
31			*/
32			private $collectionFactory;
33
34			/**
35			* The before callback which will be called before sending single messages.
36			*
37			* @var callable\|null
38			*/
39			private $beforeSingleShortMessageCallback;
40
41			/**
42			* The after callback which will be called before sending single messages.
43			*
44			* @var callable\|null
45			*/
46			private $afterSingleShortMessageCallback;
47
48			/**
49			* The before callback which will be called before sending multiple messages.
50			*
51			* @var callable\|null
52			*/
53			private $beforeMultipleShortMessageCallback;
54
55			/**
56			* The after callback which will be called after sending multiple messages.
57			*
58			* @var callable\|null
59			*/
60			private $afterMultipleShortMessageCallback;
61
62			/**
63			* JetSmsService constructor.
64			*
65			* @param JetSmsClientInterface $jetSmsClient
66			* @param ShortMessageFactoryInterface $shortMessageFactory
67			* @param ShortMessageCollectionFactoryInterface $shortMessageCollectionFactory
68			* @param callable\|null $beforeSingleShortMessageCallback
69			* @param callable\|null $afterSingleShortMessageCallback
70			* @param callable\|null $beforeMultipleShortMessageCallback
71			* @param callable\|null $afterMultipleShortMessageCallback
72			*/
73			public function __construct(
74			JetSmsClientInterface $jetSmsClient,
75			ShortMessageFactoryInterface $shortMessageFactory,
76			ShortMessageCollectionFactoryInterface $shortMessageCollectionFactory,
77			$beforeSingleShortMessageCallback = null,
78			$afterSingleShortMessageCallback = null,
79			$beforeMultipleShortMessageCallback = null,
80			$afterMultipleShortMessageCallback = null
81			) {
82			$this->client = $jetSmsClient;
83			$this->factory = $shortMessageFactory;
84			$this->collectionFactory = $shortMessageCollectionFactory;
			0 ignored issues – show Documentation Bug introduced 2018-02-16 21:50 UTC by Report Bug Copy Issue Report It seems like `$shortMessageCollectionFactory` of type `object<Erdemkeren\JetSms...ectionFactoryInterface>` is incompatible with the declared type `object<Erdemkeren\JetSms...essageFactoryInterface>` of property `$collectionFactory`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
85			$this->beforeSingleShortMessageCallback = $beforeSingleShortMessageCallback;
86			$this->afterSingleShortMessageCallback = $afterSingleShortMessageCallback;
87			$this->beforeMultipleShortMessageCallback = $beforeMultipleShortMessageCallback;
88			$this->afterMultipleShortMessageCallback = $afterMultipleShortMessageCallback;
89			}
90
91			/**
92			* Send the given body to the given receivers.
93			*
94			* @param string $body The body of the short message.
95			* @param array\|string $receivers The receiver(s) of the message.
96			*
97			* @return JetSmsResponseInterface The parsed JetSms response object.
98			*/
99			public function sendShortMessage($receivers, $body)
100			{
101			$shortMessage = $this->factory->create($receivers, $body);
102
103			if(is_callable($this->beforeSingleShortMessageCallback)) {
104			($this->beforeSingleShortMessageCallback)($shortMessage);
105			}
106
107			$response = $this->client->sendShortMessage($shortMessage);
108
109			if(is_callable($this->afterSingleShortMessageCallback)) {
110			($this->afterSingleShortMessageCallback)($response, $shortMessage);
111			}
112
113			return $response;
114			}
115
116			/**
117			* Send the given short messages.
118			*
119			* @param array $messages An array containing short message arrays.
120			*
121			* @return JetSmsResponseInterface The parsed JetSms response object.
122			*/
123			public function sendShortMessages(array $messages)
124			{
125			$collection = $this->collectionFactory->create();
			0 ignored issues – show Bug introduced 2018-02-16 21:50 UTC by Report Bug Copy Issue Report The call to `create()` misses some required arguments starting with `$receivers`. Loading history...
126
127			if(is_callable($this->beforeMultipleShortMessageCallback)) {
128			($this->beforeMultipleShortMessageCallback)($collection);
129			}
130
131			foreach ($messages as $message) {
132			$collection->push($this->factory->create(
			0 ignored issues – show Bug introduced 2018-02-16 21:50 UTC by Report Bug Copy Issue Report The method `push()` does not seem to exist on `object<Erdemkeren\JetSms\ShortMessage>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
133			$message['recipient'],
134			$message['message']
135			));
136			}
137
138			$response = $this->client->sendShortMessages($collection);
			0 ignored issues – show Documentation introduced 2018-02-16 21:50 UTC by Report Bug Copy Issue Report `$collection` is of type `object<Erdemkeren\JetSms\ShortMessage>`, but the function expects a `object<Erdemkeren\JetSms\ShortMessageCollection>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
139
140			if(is_callable($this->afterMultipleShortMessageCallback)) {
141			($this->afterMultipleShortMessageCallback)($response, $collection);
142			}
143
144			return $response;
145			}
146			}
147

erdemkeren / jet-sms-php

Push — master ( b898f3...cca52f )

JetSmsService::sendShortMessages() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like