GlobeLabsSmsMessage::setRequestParams() - Code Metrics - Inspection of "Merge pull request #2 from CoreProc/develop" - CoreProc/laravel-notification-channel-globe-labs-sms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8b00a7...0bad3e )

by Chris

created 2018-05-16 02:23 UTC

GlobeLabsSmsMessage::setRequestParams() A

↳ Parent: GlobeLabsSmsMessage

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	6
rs	9.4285
cc	1
eloc	3
nc	1
nop	1

<?php

namespace Coreproc\GlobeLabsSms;

use Exception;
use Coreproc\MsisdnPh\Msisdn;
use Coreproc\GlobeLabsSms\Exceptions\CouldNotSendNotification;

class GlobeLabsSmsMessage
{
    protected $message;

    protected $clientCorrelator;

    protected $accessToken;

    protected $address;

    protected $globeLabsSmsApiSendUrl = 'https://devapi.globelabs.com.ph/smsmessaging/v1/outbound/{senderAddress}/requests';

    protected $requestParams;

    public static function create($notifiable)
    {
        $instance = new static();

        $info = $notifiable->routeNotificationFor('globeLabsSms');

        $instance->setAddress($info['address']);
        $instance->setAccessToken($info['access_token']);

        return $instance;
    }

    public function getApiSendUrl()
    {
        // The URL should have the {senderAddress} and {accessToken} values embedded in the string so we can replace
        // this with the correct values.
        $url = config('broadcasting.connections.globe_labs_sms.api_send_url', $this->globeLabsSmsApiSendUrl);

        $url = str_replace('{senderAddress}', $this->getSenderAddress(), $url);

        $urlParams = [];

        if (! empty($this->getAccessToken())) {
            $urlParams['access_token'] = $this->getAccessToken();
        }

        $httpQuery = http_build_query($urlParams);

        if (! empty($httpQuery)) {
            $httpQuery = '?'.$httpQuery;
        }

        $url = $url.$httpQuery;

        return $url;
    }

    public function getSenderAddress()
    {
        return substr(config('broadcasting.connections.globe_labs_sms.short_code'), -4);
    }

    public function getAccessToken()
    {
        return $this->accessToken;
    }

    public function setAccessToken($accessToken)
    {
        $this->accessToken = $accessToken;

        return $this;
    }

    public function getAddress()
    {
        try {
            $msisdn = new Msisdn($this->address);
        } catch (Exception $e) {
            throw CouldNotSendNotification::serviceRespondedWithAnError($e->getMessage());
        }

        return 'tel:'.$msisdn->get(true);
    }

    public function setAddress($address)
    {
        $this->address = $address;

        return $this;
    }

    public function getClientCorrelator()
    {
        return $this->clientCorrelator;
    }

    public function setClientCorrelator($clientCorrelator)
    {
        $this->clientCorrelator = $clientCorrelator;

        return $this;
    }

    public function getMessage()
    {
        return $this->message;
    }

    public function setMessage($message)
    {
        $this->message = $message;

        return $this;
    }

    /**
     * An additional method to accommodate any additional parameters needed by the API.
     *
     * @param $requestParams
     * @return GlobeLabsSmsMessage
     */
    public function setRequestParams($requestParams)
    {
        $this->requestParams = $requestParams;

        return $this;
    }

    public function getRequestParams()
    {
        return $this->requestParams;
    }

    public function toJson()
    {
        $request['outboundSMSMessageRequest']['address'] = $this->getAddress();
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
        $request['outboundSMSMessageRequest']['senderAddress'] = $this->getSenderAddress();

        if (! empty($this->getClientCorrelator())) {
            $request['outboundSMSMessageRequest']['clientCorrelator'] = $this->getClientCorrelator();
        }

        $request['outboundSMSMessageRequest']['outboundSMSTextMessage']['message'] = $this->getMessage();

        if (! empty($this->getRequestParams())) {
            $request = array_merge($request, $this->getRequestParams());
        }

        return json_encode($request);
    }
}


1			<?php
2
3			namespace Coreproc\GlobeLabsSms;
4
5			use Exception;
6			use Coreproc\MsisdnPh\Msisdn;
7			use Coreproc\GlobeLabsSms\Exceptions\CouldNotSendNotification;
8
9			class GlobeLabsSmsMessage
10			{
11			protected $message;
12
13			protected $clientCorrelator;
14
15			protected $accessToken;
16
17			protected $address;
18
19			protected $globeLabsSmsApiSendUrl = 'https://devapi.globelabs.com.ph/smsmessaging/v1/outbound/{senderAddress}/requests';
20
21			protected $requestParams;
22
23			public static function create($notifiable)
24			{
25			$instance = new static();
26
27			$info = $notifiable->routeNotificationFor('globeLabsSms');
28
29			$instance->setAddress($info['address']);
30			$instance->setAccessToken($info['access_token']);
31
32			return $instance;
33			}
34
35			public function getApiSendUrl()
36			{
37			// The URL should have the {senderAddress} and {accessToken} values embedded in the string so we can replace
38			// this with the correct values.
39			$url = config('broadcasting.connections.globe_labs_sms.api_send_url', $this->globeLabsSmsApiSendUrl);
40
41			$url = str_replace('{senderAddress}', $this->getSenderAddress(), $url);
42
43			$urlParams = [];
44
45			if (! empty($this->getAccessToken())) {
46			$urlParams['access_token'] = $this->getAccessToken();
47			}
48
49			$httpQuery = http_build_query($urlParams);
50
51			if (! empty($httpQuery)) {
52			$httpQuery = '?'.$httpQuery;
53			}
54
55			$url = $url.$httpQuery;
56
57			return $url;
58			}
59
60			public function getSenderAddress()
61			{
62			return substr(config('broadcasting.connections.globe_labs_sms.short_code'), -4);
63			}
64
65			public function getAccessToken()
66			{
67			return $this->accessToken;
68			}
69
70			public function setAccessToken($accessToken)
71			{
72			$this->accessToken = $accessToken;
73
74			return $this;
75			}
76
77			public function getAddress()
78			{
79			try {
80			$msisdn = new Msisdn($this->address);
81			} catch (Exception $e) {
82			throw CouldNotSendNotification::serviceRespondedWithAnError($e->getMessage());
83			}
84
85			return 'tel:'.$msisdn->get(true);
86			}
87
88			public function setAddress($address)
89			{
90			$this->address = $address;
91
92			return $this;
93			}
94
95			public function getClientCorrelator()
96			{
97			return $this->clientCorrelator;
98			}
99
100			public function setClientCorrelator($clientCorrelator)
101			{
102			$this->clientCorrelator = $clientCorrelator;
103
104			return $this;
105			}
106
107			public function getMessage()
108			{
109			return $this->message;
110			}
111
112			public function setMessage($message)
113			{
114			$this->message = $message;
115
116			return $this;
117			}
118
119			/**
120			* An additional method to accommodate any additional parameters needed by the API.
121			*
122			* @param $requestParams
123			* @return GlobeLabsSmsMessage
124			*/
125			public function setRequestParams($requestParams)
126			{
127			$this->requestParams = $requestParams;
128
129			return $this;
130			}
131
132			public function getRequestParams()
133			{
134			return $this->requestParams;
135			}
136
137			public function toJson()
138			{
139			$request['outboundSMSMessageRequest']['address'] = $this->getAddress();
			0 ignored issues – show Coding Style Comprehensibility introduced 2018-05-05 17:38 UTC by Report Bug Copy Issue Report `$request` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$request = 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...
140			$request['outboundSMSMessageRequest']['senderAddress'] = $this->getSenderAddress();
141
142			if (! empty($this->getClientCorrelator())) {
143			$request['outboundSMSMessageRequest']['clientCorrelator'] = $this->getClientCorrelator();
144			}
145
146			$request['outboundSMSMessageRequest']['outboundSMSTextMessage']['message'] = $this->getMessage();
147
148			if (! empty($this->getRequestParams())) {
149			$request = array_merge($request, $this->getRequestParams());
150			}
151
152			return json_encode($request);
153			}
154			}
155

CoreProc / laravel-notification-channel-globe-labs-sms

Push — master ( 8b00a7...0bad3e )

GlobeLabsSmsMessage::setRequestParams() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like