Sms::removeRecipientVariable() - Code Metrics - fazland/skebby-rest-client - Measure and Improve Code Quality continuously with Scrutinizer

Sms::removeRecipientVariable() A
last analyzed 2021-03-15 10:51 UTC

↳ Parent: Sms

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2
crap	1

<?php declare(strict_types=1);

namespace Fazland\SkebbyRestClient\DataStructure;

use Fazland\SkebbyRestClient\Constant\ValidityPeriods;
use Fazland\SkebbyRestClient\Exception\InvalidDeliveryStartException;
use Fazland\SkebbyRestClient\Exception\InvalidValidityPeriodException;

/**
 * Represents an SMS.
 *
 * @author Massimiliano Braglia <[email protected]>
 */
class Sms
{
    /**
     * @var string
     */
    private $sender;

    /**
     * @var string[]
     */
    private $recipients;

    /**
     * @var string[][]
     */
    private $recipientVariables;

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

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

    /**
     * @var \DateTime
     */
    private $deliveryStart;

    /**
     * @var \DateInterval
     */
    private $validityPeriod;

    /**
     * Sms constructor.
     */
    public function __construct()
    {
        $this->recipients = [];
        $this->recipientVariables = [];
    }

    /**
     * Creates a new instance of SMS.
     *
     * @return static
     */
    public static function create(): self
    {
        return new static();
    }

    /**
     * Gets the sender.
     *
     * @return string|null
     */
    public function getSender()
    {
        return $this->sender;
    }

    /**
     * Sets the sender.
     *
     * @param string $sender
     *
     * @return $this
     */
    public function setSender(string $sender): self
    {
        $this->sender = $sender;

        return $this;
    }

    /**
     * Gets the recipients.
     *
     * @return string[]
     */
    public function getRecipients(): array
    {
        return $this->recipients;
    }

    /**
     * Sets the recipients.
     *
     * @param string[] $recipients
     *
     * @return $this
     */
    public function setRecipients(array $recipients): self
    {
        $this->recipients = $recipients;

        return $this;
    }

    /**
     * Adds a single recipient.
     *
     * @param string $recipient
     *
     * @return $this
     */
    public function addRecipient(string $recipient): self
    {
        $this->recipients[] = $recipient;

        return $this;
    }

    /**
     * Removes a single recipient.
     *
     * @param string $recipient
     *
     * @return $this
     */
    public function removeRecipient(string $recipient): self
    {
        $itemPosition = array_search($recipient, $this->recipients);

        if (false !== $itemPosition) {
            unset($this->recipients[$itemPosition]);
        }

        unset($this->recipientVariables[$recipient]);

        return $this;
    }

    /**
     * Whether the current sms has or not recipients.
     *
     * @return bool
     */
    public function hasRecipients(): bool
    {
        return ! empty($this->recipients);
    }

    /**
     * Gets the recipient variables.
     *
     * @return string[][]
     */
    public function getRecipientVariables(): array
    {
        return $this->recipientVariables;
    }

    /**
     * Sets the recipient variables for the recipient specified.
     *
     * @param string   $recipient
     * @param string[] $recipientVariables
     *
     * @return $this
     */
    public function setRecipientVariables(string $recipient, array $recipientVariables): self
    {
        $this->recipientVariables[$recipient] = $recipientVariables;

        return $this;
    }

    /**
     * Adds a single recipient variable for the specified recipient.
     *
     * @param string $recipient
     * @param string $recipientVariable
     * @param string $recipientVariableValue
     *
     * @return $this
     */
    public function addRecipientVariable(
        string $recipient,
        string $recipientVariable,
        string $recipientVariableValue
    ): self {
        if (! isset($this->recipientVariables[$recipient])) {
            $this->recipientVariables[$recipient] = [];
        }

        $this->recipientVariables[$recipient][$recipientVariable] = $recipientVariableValue;

        return $this;
    }

    /**
     * Removes the recipient variable for the recipient specified.
     *
     * @param string $recipient
     * @param string $recipientVariable
     *
     * @return $this
     */
    public function removeRecipientVariable(string $recipient, string $recipientVariable): self
    {
        unset($this->recipientVariables[$recipient][$recipientVariable]);

        return $this;
    }

    /**
     * Whether the current sms has or not recipient variables.
     *
     * @return bool
     */
    public function hasRecipientVariables(): bool
    {
        return ! empty($this->recipientVariables);
    }

    /**
     * Clears the recipient variables.
     *
     * @return $this
     */
    public function clearRecipientVariables(): self
    {
        $this->recipientVariables = [];

        return $this;
    }

    /**
     * Gets the text.
     *
     * @return string
     */
    public function getText()
    {
        return $this->text;
    }

    /**
     * Sets the text.
     *
     * @param string $text
     *
     * @return $this
     */
    public function setText(string $text): self
    {
        $this->text = $text;

        return $this;
    }

    /**
     * Gets the user reference.
     *
     * @return string
     */
    public function getUserReference()
    {
        return $this->userReference;
    }

    /**
     * Sets the user reference.
     *
     * @param string $userReference
     *
     * @return $this
     */
    public function setUserReference(string $userReference): self
    {
        $this->userReference = $userReference;

        return $this;
    }

    /**
     * Gets the delivery start.
     *
     * @return \DateTimeInterface
     */
    public function getDeliveryStart()
    {
        return $this->deliveryStart;
    }

    /**
     * @param \DateTimeInterface|null $deliveryStart
     *
     * @return $this
     *
     * @throws InvalidDeliveryStartException
     */
    public function setDeliveryStart(\DateTimeInterface $deliveryStart = null)
    {
        if (null !== $deliveryStart && $deliveryStart < date_create_from_format('U', (string) time())) {
            throw new InvalidDeliveryStartException();
        }

        $this->deliveryStart = $deliveryStart;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        return $this;
    }

    /**
     * Gets the validity period.
     *
     * @return \DateInterval
     */
    public function getValidityPeriod()
    {
        return $this->validityPeriod;
    }

    /**
     * Sets the validity period.
     *
     * @param \DateInterval|null $validityPeriod
     *
     * @return $this
     *
     * @throws InvalidValidityPeriodException
     */
    public function setValidityPeriod(\DateInterval $validityPeriod = null): self
    {
        if (null !== $validityPeriod &&
            ($validityPeriod->i < ValidityPeriods::MIN || $validityPeriod->i > ValidityPeriods::MAX)
        ) {
            throw new InvalidValidityPeriodException();
        }

        $this->validityPeriod = $validityPeriod;

        return $this;
    }
}


1		<?php declare(strict_types=1);
2
3		namespace Fazland\SkebbyRestClient\DataStructure;
4
5		use Fazland\SkebbyRestClient\Constant\ValidityPeriods;
6		use Fazland\SkebbyRestClient\Exception\InvalidDeliveryStartException;
7		use Fazland\SkebbyRestClient\Exception\InvalidValidityPeriodException;
8
9		/**
10		* Represents an SMS.
11		*
12		* @author Massimiliano Braglia <[email protected]>
13		*/
14		class Sms
15		{
16		/**
17		* @var string
18		*/
19		private $sender;
20
21		/**
22		* @var string[]
23		*/
24		private $recipients;
25
26		/**
27		* @var string[][]
28		*/
29		private $recipientVariables;
30
31		/**
32		* @var string
33		*/
34		private $text;
35
36		/**
37		* @var string
38		*/
39		private $userReference;
40
41		/**
42		* @var \DateTime
43		*/
44		private $deliveryStart;
45
46		/**
47		* @var \DateInterval
48		*/
49		private $validityPeriod;
50
51		/**
52		* Sms constructor.
53		*/
54	14	public function __construct()
55		{
56	14	$this->recipients = [];
57	14	$this->recipientVariables = [];
58	14	}
59
60		/**
61		* Creates a new instance of SMS.
62		*
63		* @return static
64		*/
65	9	public static function create(): self
66		{
67	9	return new static();
68		}
69
70		/**
71		* Gets the sender.
72		*
73		* @return string\|null
74		*/
75	8	public function getSender()
76		{
77	8	return $this->sender;
78		}
79
80		/**
81		* Sets the sender.
82		*
83		* @param string $sender
84		*
85		* @return $this
86		*/
87	1	public function setSender(string $sender): self
88		{
89	1	$this->sender = $sender;
90
91	1	return $this;
92		}
93
94		/**
95		* Gets the recipients.
96		*
97		* @return string[]
98		*/
99	9	public function getRecipients(): array
100		{
101	9	return $this->recipients;
102		}
103
104		/**
105		* Sets the recipients.
106		*
107		* @param string[] $recipients
108		*
109		* @return $this
110		*/
111	8	public function setRecipients(array $recipients): self
112		{
113	8	$this->recipients = $recipients;
114
115	8	return $this;
116		}
117
118		/**
119		* Adds a single recipient.
120		*
121		* @param string $recipient
122		*
123		* @return $this
124		*/
125	6	public function addRecipient(string $recipient): self
126		{
127	6	$this->recipients[] = $recipient;
128
129	6	return $this;
130		}
131
132		/**
133		* Removes a single recipient.
134		*
135		* @param string $recipient
136		*
137		* @return $this
138		*/
139	1	public function removeRecipient(string $recipient): self
140		{
141	1	$itemPosition = array_search($recipient, $this->recipients);
142
143	1	if (false !== $itemPosition) {
144	1	unset($this->recipients[$itemPosition]);
145		}
146
147	1	unset($this->recipientVariables[$recipient]);
148
149	1	return $this;
150		}
151
152		/**
153		* Whether the current sms has or not recipients.
154		*
155		* @return bool
156		*/
157	9	public function hasRecipients(): bool
158		{
159	9	return ! empty($this->recipients);
160		}
161
162		/**
163		* Gets the recipient variables.
164		*
165		* @return string[][]
166		*/
167	10	public function getRecipientVariables(): array
168		{
169	10	return $this->recipientVariables;
170		}
171
172		/**
173		* Sets the recipient variables for the recipient specified.
174		*
175		* @param string $recipient
176		* @param string[] $recipientVariables
177		*
178		* @return $this
179		*/
180	1	public function setRecipientVariables(string $recipient, array $recipientVariables): self
181		{
182	1	$this->recipientVariables[$recipient] = $recipientVariables;
183
184	1	return $this;
185		}
186
187		/**
188		* Adds a single recipient variable for the specified recipient.
189		*
190		* @param string $recipient
191		* @param string $recipientVariable
192		* @param string $recipientVariableValue
193		*
194		* @return $this
195		*/
196	5	public function addRecipientVariable(
197		string $recipient,
198		string $recipientVariable,
199		string $recipientVariableValue
200		): self {
201	5	if (! isset($this->recipientVariables[$recipient])) {
202	5	$this->recipientVariables[$recipient] = [];
203		}
204
205	5	$this->recipientVariables[$recipient][$recipientVariable] = $recipientVariableValue;
206
207	5	return $this;
208		}
209
210		/**
211		* Removes the recipient variable for the recipient specified.
212		*
213		* @param string $recipient
214		* @param string $recipientVariable
215		*
216		* @return $this
217		*/
218	1	public function removeRecipientVariable(string $recipient, string $recipientVariable): self
219		{
220	1	unset($this->recipientVariables[$recipient][$recipientVariable]);
221
222	1	return $this;
223		}
224
225		/**
226		* Whether the current sms has or not recipient variables.
227		*
228		* @return bool
229		*/
230	8	public function hasRecipientVariables(): bool
231		{
232	8	return ! empty($this->recipientVariables);
233		}
234
235		/**
236		* Clears the recipient variables.
237		*
238		* @return $this
239		*/
240	8	public function clearRecipientVariables(): self
241		{
242	8	$this->recipientVariables = [];
243
244	8	return $this;
245		}
246
247		/**
248		* Gets the text.
249		*
250		* @return string
251		*/
252	8	public function getText()
253		{
254	8	return $this->text;
255		}
256
257		/**
258		* Sets the text.
259		*
260		* @param string $text
261		*
262		* @return $this
263		*/
264	9	public function setText(string $text): self
265		{
266	9	$this->text = $text;
267
268	9	return $this;
269		}
270
271		/**
272		* Gets the user reference.
273		*
274		* @return string
275		*/
276	8	public function getUserReference()
277		{
278	8	return $this->userReference;
279		}
280
281		/**
282		* Sets the user reference.
283		*
284		* @param string $userReference
285		*
286		* @return $this
287		*/
288	1	public function setUserReference(string $userReference): self
289		{
290	1	$this->userReference = $userReference;
291
292	1	return $this;
293		}
294
295		/**
296		* Gets the delivery start.
297		*
298		* @return \DateTimeInterface
299		*/
300	8	public function getDeliveryStart()
301		{
302	8	return $this->deliveryStart;
303		}
304
305		/**
306		* @param \DateTimeInterface\|null $deliveryStart
307		*
308		* @return $this
309		*
310		* @throws InvalidDeliveryStartException
311		*/
312	3	public function setDeliveryStart(\DateTimeInterface $deliveryStart = null)
313		{
314	3	if (null !== $deliveryStart && $deliveryStart < date_create_from_format('U', (string) time())) {
315	1	throw new InvalidDeliveryStartException();
316		}
317
318	2	$this->deliveryStart = $deliveryStart;
		0 ignored issues – show Documentation Bug introduced 2018-04-06 12:14 UTC by Report Bug Copy Issue Report It seems like `$deliveryStart` can also be of type `object<DateTimeInterface>`. However, the property `$deliveryStart` is declared as type `object<DateTime>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
319
320	2	return $this;
321		}
322
323		/**
324		* Gets the validity period.
325		*
326		* @return \DateInterval
327		*/
328	8	public function getValidityPeriod()
329		{
330	8	return $this->validityPeriod;
331		}
332
333		/**
334		* Sets the validity period.
335		*
336		* @param \DateInterval\|null $validityPeriod
337		*
338		* @return $this
339		*
340		* @throws InvalidValidityPeriodException
341		*/
342	3	public function setValidityPeriod(\DateInterval $validityPeriod = null): self
343		{
344	3	if (null !== $validityPeriod &&
345	3	($validityPeriod->i < ValidityPeriods::MIN \|\| $validityPeriod->i > ValidityPeriods::MAX)
346		) {
347	1	throw new InvalidValidityPeriodException();
348		}
349
350	2	$this->validityPeriod = $validityPeriod;
351
352	2	return $this;
353		}
354		}
355

fazland / skebby-rest-client

Sms::removeRecipientVariable() A last analyzed 2021-03-15 10:51 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Sms::removeRecipientVariable() A
last analyzed 2021-03-15 10:51 UTC