Driver::to() - Code Metrics - hooman-mirghasemi/Laravel-iran-sms - Measure and Improve Code Quality continuously with Scrutinizer

Driver::to() A
last analyzed 2025-04-08 11:04 UTC

↳ Parent: Driver

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace HoomanMirghasemi\Sms\Abstracts;

use HoomanMirghasemi\Sms\Contracts\Driver as DriverContract;
use HoomanMirghasemi\Sms\Contracts\Message;
use HoomanMirghasemi\Sms\Events\ProviderConnectionFailedEvent;
use HoomanMirghasemi\Sms\Events\SmsSentEvent;
use Illuminate\Support\Facades\Event;

abstract class Driver implements DriverContract
{
    /**
     * If it can not connect to provider this get false value.
     *
     * @var bool
     */
    protected bool $serviceActive = true;

    /**
     * Recipient (mobile number in E164 format).
     *
     * @param string
     */
    protected string $recipient;

    /**
     * Sender number.
     *
     * @param string
     */
    protected string $from;

    /**
     * Message.
     *
     * @var Message|string
     */
    protected Message|string $message;

    /**
     * The response of driver webservice of sending message.
     *
     * @var string
     */
    protected string $webserviceResponse;

    /**
     * Result of sending message.
     *
     * @var bool
     */
    protected ?bool $success = null;

    /**
     * Add recipient (phone or mobile numbers).
     *
     * @param string $recipient
     *
     * @return self
     */
    public function to(string $recipient): self
    {
        $this->recipient = $recipient;

        return $this;
    }

    /**
     * Get recipient mobile number.
     *
     * @return string
     */
    public function getRecipient(): string
    {
        return $this->recipient;
    }

    /**
     * Get sender number (from attribute).
     *
     * @return string
     */
    public function getSenderNumber(): string
    {
        return $this->from;
    }

    /**
     * Set related message.
     *
     * @param Message $message
     *
     * @return self
     */
    public function message(Message|string $message): self
    {
        $this->message = $message instanceof Message ? $message : new \HoomanMirghasemi\Sms\Message($message);

        return $this;
    }

    /**
     * Get message in string.
     *
     * @return string
     */
    public function getMessage(): string
    {
        if ($this->message instanceof Message) {
            return $this->message->toString();
        }

        return $this->message;
    }

    /**
     * Get result of sending message is successful or not.
     *
     * @return bool
     */
    public function getResult(): bool
    {
        return $this->success;

    }

    /**
     * Get webservice response.
     *
     * @return string
     */
    public function getWebServiceResponce(): string
    {
        return $this->webserviceResponse;
    }

    /**
     * Each driver should call this parent method at end of own send.
     * This fire SmsSentEvent.
     *
     * @see SmsSentEvent
     *
     * @return bool
     */
    public function send(): bool
    {
        if ($this->success === null) {
            throw new \BadMethodCallException('Abstract driver send method should only call in end of drivers with result of send');
        }

        $smsSentEvent = new SmsSentEvent($this);
        Event::dispatch($smsSentEvent);

        return $this->success;
    }

    /**
     * When a driver can not connect to provider this method called.
     * Also ProviderConnectionFailedEvent fired.
     *
     * @see ProviderConnectionFailedEvent
     */
    public function failedConnectToProvider()
    {
        $reflect = new \ReflectionClass($this);
        $providerName = strtolower($reflect->getShortName());

        $this->webserviceResponse = "System can not connect to {$providerName} webservice.";
        $this->success = false;

        $providerConnectionFailedEvent = new ProviderConnectionFailedEvent($this);
        Event::dispatch($providerConnectionFailedEvent);
    }
}


1			<?php
2
3			namespace HoomanMirghasemi\Sms\Abstracts;
4
5			use HoomanMirghasemi\Sms\Contracts\Driver as DriverContract;
6			use HoomanMirghasemi\Sms\Contracts\Message;
7			use HoomanMirghasemi\Sms\Events\ProviderConnectionFailedEvent;
8			use HoomanMirghasemi\Sms\Events\SmsSentEvent;
9			use Illuminate\Support\Facades\Event;
10
11			abstract class Driver implements DriverContract
12			{
13			/**
14			* If it can not connect to provider this get false value.
15			*
16			* @var bool
17			*/
18			protected bool $serviceActive = true;
19
20			/**
21			* Recipient (mobile number in E164 format).
22			*
23			* @param string
24			*/
25			protected string $recipient;
26
27			/**
28			* Sender number.
29			*
30			* @param string
31			*/
32			protected string $from;
33
34			/**
35			* Message.
36			*
37			* @var Message\|string
38			*/
39			protected Message\|string $message;
40
41			/**
42			* The response of driver webservice of sending message.
43			*
44			* @var string
45			*/
46			protected string $webserviceResponse;
47
48			/**
49			* Result of sending message.
50			*
51			* @var bool
52			*/
53			protected ?bool $success = null;
54
55			/**
56			* Add recipient (phone or mobile numbers).
57			*
58			* @param string $recipient
59			*
60			* @return self
61			*/
62			public function to(string $recipient): self
63			{
64			$this->recipient = $recipient;
65
66			return $this;
67			}
68
69			/**
70			* Get recipient mobile number.
71			*
72			* @return string
73			*/
74			public function getRecipient(): string
75			{
76			return $this->recipient;
77			}
78
79			/**
80			* Get sender number (from attribute).
81			*
82			* @return string
83			*/
84			public function getSenderNumber(): string
85			{
86			return $this->from;
87			}
88
89			/**
90			* Set related message.
91			*
92			* @param Message $message
93			*
94			* @return self
95			*/
96			public function message(Message\|string $message): self
97			{
98			$this->message = $message instanceof Message ? $message : new \HoomanMirghasemi\Sms\Message($message);
99
100			return $this;
101			}
102
103			/**
104			* Get message in string.
105			*
106			* @return string
107			*/
108			public function getMessage(): string
109			{
110			if ($this->message instanceof Message) {
111			return $this->message->toString();
112			}
113
114			return $this->message;
115			}
116
117			/**
118			* Get result of sending message is successful or not.
119			*
120			* @return bool
121			*/
122			public function getResult(): bool
123			{
124			return $this->success;
			0 ignored issues – show Bug Best Practice introduced 2023-09-01 17:03 UTC by Report Bug Copy Issue Report The expression `return $this->success` could return the type `null` which is incompatible with the type-hinted return `boolean`. Consider adding an additional type-check to rule them out. Loading history...
125			}
126
127			/**
128			* Get webservice response.
129			*
130			* @return string
131			*/
132			public function getWebServiceResponce(): string
133			{
134			return $this->webserviceResponse;
135			}
136
137			/**
138			* Each driver should call this parent method at end of own send.
139			* This fire SmsSentEvent.
140			*
141			* @see SmsSentEvent
142			*
143			* @return bool
144			*/
145			public function send(): bool
146			{
147			if ($this->success === null) {
148			throw new \BadMethodCallException('Abstract driver send method should only call in end of drivers with result of send');
149			}
150
151			$smsSentEvent = new SmsSentEvent($this);
152			Event::dispatch($smsSentEvent);
153
154			return $this->success;
155			}
156
157			/**
158			* When a driver can not connect to provider this method called.
159			* Also ProviderConnectionFailedEvent fired.
160			*
161			* @see ProviderConnectionFailedEvent
162			*/
163			public function failedConnectToProvider()
164			{
165			$reflect = new \ReflectionClass($this);
166			$providerName = strtolower($reflect->getShortName());
167
168			$this->webserviceResponse = "System can not connect to {$providerName} webservice.";
169			$this->success = false;
170
171			$providerConnectionFailedEvent = new ProviderConnectionFailedEvent($this);
172			Event::dispatch($providerConnectionFailedEvent);
173			}
174			}
175

hooman-mirghasemi / Laravel-iran-sms

Driver::to() A last analyzed 2025-04-08 11:04 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Driver::to() A
last analyzed 2025-04-08 11:04 UTC