Button::isType() - Code Metrics - laravel-notification-channels/facebook - Measure and Improve Code Quality continuously with Scrutinizer

Button::isType() A
last analyzed 2020-02-26 07:09 UTC

↳ Parent: Button

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

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

<?php

namespace NotificationChannels\Facebook\Components;

use Illuminate\Support\Str;
use JsonSerializable;
use NotificationChannels\Facebook\Enums\ButtonType;
use NotificationChannels\Facebook\Exceptions\CouldNotCreateButton;

/**
 * Class Button.
 */
class Button implements JsonSerializable
{
    /** @var string Button Title */
    protected $title;

    /** @var string Button Type */
    protected $type;

    /** @var string|array Button URL, Postback Data or Phone Number */
    protected $data;

    /** @var array Payload */
    protected $payload = [];

    /**
     * Create a button.
     *
     * @param  string        $title
     * @param  string|array  $data
     * @param  string        $type
     *
     * @return static
     */
    public static function create(string $title = '', $data = null, string $type = ButtonType::WEB_URL): self
    {
        return new static($title, $data, $type);
    }

    /**
     * Button Constructor.
     *
     * @param  string        $title
     * @param  string|array  $data
     * @param  string        $type
     */
    public function __construct(string $title = '', $data = null, string $type = ButtonType::WEB_URL)
    {
        $this->title = $title;
        $this->data = $data;
        $this->payload['type'] = $type;
    }

    /**
     * Set Button Title.
     *
     * @param  string  $title
     *
     * @throws CouldNotCreateButton
     * @return $this
     */
    public function title(string $title): self
    {
        if (blank($title)) {
            throw CouldNotCreateButton::titleNotProvided();
        }

        if (mb_strlen($title) > 20) {
            throw CouldNotCreateButton::titleLimitExceeded($title);
        }

        $this->payload['title'] = $title;

        return $this;
    }

    /**
     * Set a URL for the button.
     *
     * @param  string  $url
     *
     * @throws CouldNotCreateButton
     * @return $this
     */
    public function url(string $url): self
    {
        if (blank($url)) {
            throw CouldNotCreateButton::urlNotProvided();
        }

        if (! filter_var($url, FILTER_VALIDATE_URL)) {
            throw CouldNotCreateButton::invalidUrlProvided($url);
        }

        $this->payload['url'] = $url;
        $this->isTypeWebUrl();

        return $this;
    }

    /**
     * @param  string  $phone
     *
     * @throws CouldNotCreateButton
     * @return $this
     */
    public function phone(string $phone): self
    {
        if (blank($phone)) {
            throw CouldNotCreateButton::phoneNumberNotProvided();
        }

        if (is_string($phone) && ! Str::startsWith($phone, '+')) {
            throw CouldNotCreateButton::invalidPhoneNumberProvided($phone);
        }

        $this->payload['payload'] = $phone;
        $this->isTypePhoneNumber();

        return $this;
    }

    /**
     * @param  array  $postback
     *
     * @throws CouldNotCreateButton
     * @return $this
     */
    public function postback(array $postback): self
    {
        if (blank($postback)) {
            throw CouldNotCreateButton::postbackNotProvided();
        }

        $this->payload['payload'] = json_encode($postback);
        $this->isTypePostback();

        return $this;
    }

    /**
     * Set Button Type.
     *
     * @param  string  $type  Possible Values: "web_url", "postback" or "phone_number". Default: "web_url"
     *
     * @return $this
     */
    public function type(string $type): self
    {
        $this->payload['type'] = $type;

        return $this;
    }

    /**
     * Set button type as web_url.
     *
     * @return $this
     */
    public function isTypeWebUrl(): self
    {
        $this->payload['type'] = ButtonType::WEB_URL;

        return $this;
    }

    /**
     * Set button type as postback.
     *
     * @return $this
     */
    public function isTypePostback(): self
    {
        $this->payload['type'] = ButtonType::POSTBACK;

        return $this;
    }

    /**
     * Set button type as phone_number.
     *
     * @return $this
     */
    public function isTypePhoneNumber(): self
    {
        $this->payload['type'] = ButtonType::PHONE_NUMBER;

        return $this;
    }

    /**
     * Determine Button Type.
     *
     * @param  string  $type
     *
     * @return bool
     */
    protected function isType(string $type): bool
    {
        return isset($this->payload['type']) && $type === $this->payload['type'];
    }

    /**
     * Make payload by data and type.
     *
     * @param  mixed  $data
     *
     * @throws CouldNotCreateButton
     * @return $this
     */
    protected function makePayload($data): self
    {
        if (blank($data)) {
            return $this;
        }

        switch ($this->payload['type']) {
            case ButtonType::WEB_URL:
                $this->url($data);
                break;
            case ButtonType::PHONE_NUMBER:
                $this->phone($data);
                break;
            case ButtonType::POSTBACK:
                $this->postback($data);
                break;
        }

        if (isset($this->payload['payload']) && mb_strlen($this->payload['payload']) > 1000) {
            throw CouldNotCreateButton::payloadLimitExceeded($this->payload['payload']);
        }

        return $this;
    }

    /**
     * Builds payload and returns an array.
     *
     * @throws CouldNotCreateButton
     * @return array
     */
    public function toArray(): array
    {
        $this->title($this->title);
        $this->makePayload($this->data);

        return $this->payload;
    }

    /**
     * Convert the object into something JSON serializable.
     *
     * @throws CouldNotCreateButton
     * @return mixed
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }
}


1			<?php
2
3			namespace NotificationChannels\Facebook\Components;
4
5			use Illuminate\Support\Str;
6			use JsonSerializable;
7			use NotificationChannels\Facebook\Enums\ButtonType;
8			use NotificationChannels\Facebook\Exceptions\CouldNotCreateButton;
9
10			/**
11			* Class Button.
12			*/
13			class Button implements JsonSerializable
14			{
15			/** @var string Button Title */
16			protected $title;
17
18			/** @var string Button Type */
19			protected $type;
20
21			/** @var string\|array Button URL, Postback Data or Phone Number */
22			protected $data;
23
24			/** @var array Payload */
25			protected $payload = [];
26
27			/**
28			* Create a button.
29			*
30			* @param string $title
31			* @param string\|array $data
32			* @param string $type
33			*
34			* @return static
35			*/
36			public static function create(string $title = '', $data = null, string $type = ButtonType::WEB_URL): self
37			{
38			return new static($title, $data, $type);
39			}
40
41			/**
42			* Button Constructor.
43			*
44			* @param string $title
45			* @param string\|array $data
46			* @param string $type
47			*/
48			public function __construct(string $title = '', $data = null, string $type = ButtonType::WEB_URL)
49			{
50			$this->title = $title;
51			$this->data = $data;
52			$this->payload['type'] = $type;
53			}
54
55			/**
56			* Set Button Title.
57			*
58			* @param string $title
59			*
60			* @throws CouldNotCreateButton
61			* @return $this
62			*/
63			public function title(string $title): self
64			{
65			if (blank($title)) {
66			throw CouldNotCreateButton::titleNotProvided();
67			}
68
69			if (mb_strlen($title) > 20) {
70			throw CouldNotCreateButton::titleLimitExceeded($title);
71			}
72
73			$this->payload['title'] = $title;
74
75			return $this;
76			}
77
78			/**
79			* Set a URL for the button.
80			*
81			* @param string $url
82			*
83			* @throws CouldNotCreateButton
84			* @return $this
85			*/
86			public function url(string $url): self
87			{
88			if (blank($url)) {
89			throw CouldNotCreateButton::urlNotProvided();
90			}
91
92			if (! filter_var($url, FILTER_VALIDATE_URL)) {
93			throw CouldNotCreateButton::invalidUrlProvided($url);
94			}
95
96			$this->payload['url'] = $url;
97			$this->isTypeWebUrl();
98
99			return $this;
100			}
101
102			/**
103			* @param string $phone
104			*
105			* @throws CouldNotCreateButton
106			* @return $this
107			*/
108			public function phone(string $phone): self
109			{
110			if (blank($phone)) {
111			throw CouldNotCreateButton::phoneNumberNotProvided();
112			}
113
114			if (is_string($phone) && ! Str::startsWith($phone, '+')) {
115			throw CouldNotCreateButton::invalidPhoneNumberProvided($phone);
116			}
117
118			$this->payload['payload'] = $phone;
119			$this->isTypePhoneNumber();
120
121			return $this;
122			}
123
124			/**
125			* @param array $postback
126			*
127			* @throws CouldNotCreateButton
128			* @return $this
129			*/
130			public function postback(array $postback): self
131			{
132			if (blank($postback)) {
133			throw CouldNotCreateButton::postbackNotProvided();
134			}
135
136			$this->payload['payload'] = json_encode($postback);
137			$this->isTypePostback();
138
139			return $this;
140			}
141
142			/**
143			* Set Button Type.
144			*
145			* @param string $type Possible Values: "web_url", "postback" or "phone_number". Default: "web_url"
146			*
147			* @return $this
148			*/
149			public function type(string $type): self
150			{
151			$this->payload['type'] = $type;
152
153			return $this;
154			}
155
156			/**
157			* Set button type as web_url.
158			*
159			* @return $this
160			*/
161			public function isTypeWebUrl(): self
162			{
163			$this->payload['type'] = ButtonType::WEB_URL;
164
165			return $this;
166			}
167
168			/**
169			* Set button type as postback.
170			*
171			* @return $this
172			*/
173			public function isTypePostback(): self
174			{
175			$this->payload['type'] = ButtonType::POSTBACK;
176
177			return $this;
178			}
179
180			/**
181			* Set button type as phone_number.
182			*
183			* @return $this
184			*/
185			public function isTypePhoneNumber(): self
186			{
187			$this->payload['type'] = ButtonType::PHONE_NUMBER;
188
189			return $this;
190			}
191
192			/**
193			* Determine Button Type.
194			*
195			* @param string $type
196			*
197			* @return bool
198			*/
199			protected function isType(string $type): bool
200			{
201			return isset($this->payload['type']) && $type === $this->payload['type'];
202			}
203
204			/**
205			* Make payload by data and type.
206			*
207			* @param mixed $data
208			*
209			* @throws CouldNotCreateButton
210			* @return $this
211			*/
212			protected function makePayload($data): self
213			{
214			if (blank($data)) {
215			return $this;
216			}
217
218			switch ($this->payload['type']) {
219			case ButtonType::WEB_URL:
220			$this->url($data);
221			break;
222			case ButtonType::PHONE_NUMBER:
223			$this->phone($data);
224			break;
225			case ButtonType::POSTBACK:
226			$this->postback($data);
227			break;
228			}
229
230			if (isset($this->payload['payload']) && mb_strlen($this->payload['payload']) > 1000) {
231			throw CouldNotCreateButton::payloadLimitExceeded($this->payload['payload']);
232			}
233
234			return $this;
235			}
236
237			/**
238			* Builds payload and returns an array.
239			*
240			* @throws CouldNotCreateButton
241			* @return array
242			*/
243			public function toArray(): array
244			{
245			$this->title($this->title);
246			$this->makePayload($this->data);
247
248			return $this->payload;
249			}
250
251			/**
252			* Convert the object into something JSON serializable.
253			*
254			* @throws CouldNotCreateButton
255			* @return mixed
256			*/
257			public function jsonSerialize()
258			{
259			return $this->toArray();
260			}
261			}
262

laravel-notification-channels / facebook

GitHub Access Token became invalid

Button::isType() A last analyzed 2020-02-26 07:09 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Button::isType() A
last analyzed 2020-02-26 07:09 UTC