Button::postback() - Code Metrics - Inspection of "Refactor Card." - laravel-notification-channels/facebook - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8d304f...3ed6f1 )

by Irfaq

created 2016-08-24 18:29 UTC

Button::postback() A

↳ Parent: Button

Complexity

Conditions	3
Paths	3

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	13
ccs	0
cts	11
cp	0
rs	9.4285
cc	3
eloc	8
nc	3
nop	1
crap	12

<?php

namespace NotificationChannels\Facebook\Components;

use NotificationChannels\Facebook\Enums\ButtonType;
use NotificationChannels\Facebook\Exceptions\CouldNotCreateButton;

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($title = '', $data = null, $type = ButtonType::WEB_URL)
    {
        return new static($title, $data, $type);
    }

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

    /**
     * Set Button Title.
     *
     * @param $title
     *
     * @return $this
     * @throws CouldNotCreateButton
     */
    public function title($title)
    {
        if ($this->isNotSetOrEmpty($title)) {
            throw CouldNotCreateButton::titleNotProvided();
        } elseif (mb_strlen($title) > 20) {
            throw CouldNotCreateButton::titleLimitExceeded($title);
        }

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

        return $this;
    }

    /**
     * Set a URL for the button.
     *
     * @param $url
     *
     * @return $this
     * @throws CouldNotCreateButton
     */
    public function url($url)
    {
        if ($this->isNotSetOrEmpty($url)) {
            throw CouldNotCreateButton::urlNotProvided();
        } elseif (!filter_var($url, FILTER_VALIDATE_URL)) {
            throw CouldNotCreateButton::invalidUrlProvided($url);
        }

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

        return $this;
    }

    /**
     * @param $phone
     *
     * @return $this
     * @throws CouldNotCreateButton
     */
    public function phone($phone)
    {
        if ($this->isNotSetOrEmpty($phone)) {
            throw CouldNotCreateButton::phoneNumberNotProvided();
        } elseif (is_string($phone) && !starts_with($phone, '+')) {
            throw CouldNotCreateButton::invalidPhoneNumberProvided($phone);
        }

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

        return $this;
    }

    /**
     * @param $postback
     *
     * @return $this
     * @throws CouldNotCreateButton
     */
    public function postback($postback)
    {
        if ($this->isNotSetOrEmpty($postback)) {
            throw CouldNotCreateButton::postbackNotProvided();
        } elseif (!is_array($postback)) {
            throw CouldNotCreateButton::invalidPostbackProvided($postback);
        }

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

        return $this;
    }

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

        return $this;
    }

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

        return $this;
    }

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

        return $this;
    }

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

        return $this;
    }

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

    /**
     * Make payload by data and type.
     *
     * @param mixed $data
     *
     * @return $this
     * @throws CouldNotCreateButton
     */
    protected function makePayload($data)
    {
        if ($this->isNotSetOrEmpty($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.
     *
     * @return array
     * @throws CouldNotCreateButton
     */
    public function toArray()
    {
        $this->title($this->title);
        $this->makePayload($this->data);

        return $this->payload;
    }

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

    /**
     * Determine if it's not set or is empty.
     *
     * @param $var
     *
     * @return bool
     */
    protected function isNotSetOrEmpty($var)
    {
        return !isset($var) || empty($var);
    }
}


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

laravel-notification-channels / facebook

GitHub Access Token became invalid

Push — master ( 8d304f...3ed6f1 )

Button::postback() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like