AttachmentAction::setUrl() - Code Metrics - Inspection of "Slack Support URL in action buttons" - nexylan/slack - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#40)

unknown

created 2018-05-30 10:16 UTC

AttachmentAction::setUrl() A

↳ Parent: AttachmentAction

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

declare(strict_types=1);

/*
 * This file is part of the Nexylan packages.
 *
 * (c) Nexylan SAS <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Nexy\Slack;

/**
 * @author Sullivan Senechal <[email protected]>
 */
final class AttachmentAction
{
    const TYPE_BUTTON = 'button';

    const STYLE_DEFAULT = 'default';
    const STYLE_PRIMARY = 'primary';
    const STYLE_DANGER = 'danger';

    /**
     * The required name field of the action. The name will be returned to your Action URL.
     *
     * @var string
     */
    private $name;

    /**
     * The required label for the action.
     *
     * @var string
     */
    private $text;

    /**
     * Button style.
     *
     * @var string
     */
    private $style = self::STYLE_DEFAULT;

    /**
     * The required type of the action.
     *
     * @var string
     */
    private $type = self::TYPE_BUTTON;

    /**
     * Optional value. It will be sent to your Action URL.
     *
     * @var string|null
     */
    private $value;
 
    /**
     * Optional url. It will be sent to any external URL.
     * Not compatible with confirm action on button
     *
     * @var string|null
     */
    private $url;

    /**
     * Confirmation field.
     *
     * @var ActionConfirmation|null
     */
    private $confirm;

    /**
     * @param string $name
     * @param string $text
     */
    public function __construct(string $name, string $text)
    {
        $this->name = $name;
        $this->text = $text;
    }

    /**
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

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

    /**
     * @return string
     */
    public function getStyle(): string
    {
        return $this->style;
    }

    /**
     * @param string $style
     *
     * @return AttachmentAction
     */
    public function setStyle(string $style): self
    {
        $this->style = $style;

        return $this;
    }

    /**
     * @return string
     */
    public function getType(): string
    {
        return $this->type;
    }

    /**
     * @param string $type
     *
     * @return AttachmentAction
     */
    public function setType(string $type): self
    {
        $this->type = $type;

        return $this;
    }

    /**
     * @return string|null
     */
    public function getValue(): ?string
    {
        return $this->value;
    }

    /**
     * @param string $value
     *
     * @return AttachmentAction
     */
    public function setValue(?string $value): self
    {
        $this->value = $value;

        return $this;
    }
    
    /**
     * @param string $url
     *
     * @return AttachmentAction
     */    
    public function setUrl(string $url): self
    {
        $this->url = $url;

        return $this;
    }

    public function getUrl(): string
    {
        return $this->url;

    }

    /**
     * @return ActionConfirmation|null
     */
    public function getConfirm(): ?ActionConfirmation
    {
        return $this->confirm;
    }

    /**
     * @param ActionConfirmation $confirm
     *
     * @return AttachmentAction
     */
    public function setConfirm(?ActionConfirmation $confirm): self
    {
        $this->confirm = $confirm;

        return $this;
    }

    /**
     * Get the array representation of this attachment action.
     *
     * @return array
     */
    public function toArray(): array
    {
        return [
            'name' => $this->name,
            'text' => $this->text,
            'style' => $this->style,
            'type' => $this->type,
            'value' => $this->value,
            'url' => $this->url,
            'confirm' => $this->confirm ? $this->confirm->toArray() : null,
        ];
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Nexylan packages.
7			*
8			* (c) Nexylan SAS <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Nexy\Slack;
15
16			/**
17			* @author Sullivan Senechal <[email protected]>
18			*/
19			final class AttachmentAction
20			{
21			const TYPE_BUTTON = 'button';
22
23			const STYLE_DEFAULT = 'default';
24			const STYLE_PRIMARY = 'primary';
25			const STYLE_DANGER = 'danger';
26
27			/**
28			* The required name field of the action. The name will be returned to your Action URL.
29			*
30			* @var string
31			*/
32			private $name;
33
34			/**
35			* The required label for the action.
36			*
37			* @var string
38			*/
39			private $text;
40
41			/**
42			* Button style.
43			*
44			* @var string
45			*/
46			private $style = self::STYLE_DEFAULT;
47
48			/**
49			* The required type of the action.
50			*
51			* @var string
52			*/
53			private $type = self::TYPE_BUTTON;
54
55			/**
56			* Optional value. It will be sent to your Action URL.
57			*
58			* @var string\|null
59			*/
60			private $value;
61
62			/**
63			* Optional url. It will be sent to any external URL.
64			* Not compatible with confirm action on button
65			*
66			* @var string\|null
67			*/
68			private $url;
69
70			/**
71			* Confirmation field.
72			*
73			* @var ActionConfirmation\|null
74			*/
75			private $confirm;
76
77			/**
78			* @param string $name
79			* @param string $text
80			*/
81			public function __construct(string $name, string $text)
82			{
83			$this->name = $name;
84			$this->text = $text;
85			}
86
87			/**
88			* @return string
89			*/
90			public function getName(): string
91			{
92			return $this->name;
93			}
94
95			/**
96			* @return string
97			*/
98			public function getText(): string
99			{
100			return $this->text;
101			}
102
103			/**
104			* @return string
105			*/
106			public function getStyle(): string
107			{
108			return $this->style;
109			}
110
111			/**
112			* @param string $style
113			*
114			* @return AttachmentAction
115			*/
116			public function setStyle(string $style): self
117			{
118			$this->style = $style;
119
120			return $this;
121			}
122
123			/**
124			* @return string
125			*/
126			public function getType(): string
127			{
128			return $this->type;
129			}
130
131			/**
132			* @param string $type
133			*
134			* @return AttachmentAction
135			*/
136			public function setType(string $type): self
137			{
138			$this->type = $type;
139
140			return $this;
141			}
142
143			/**
144			* @return string\|null
145			*/
146			public function getValue(): ?string
147			{
148			return $this->value;
149			}
150
151			/**
152			* @param string $value
153			*
154			* @return AttachmentAction
155			*/
156			public function setValue(?string $value): self
157			{
158			$this->value = $value;
159
160			return $this;
161			}
162
163			/**
164			* @param string $url
165			*
166			* @return AttachmentAction
167			*/
168			public function setUrl(string $url): self
169			{
170			$this->url = $url;
171
172			return $this;
173			}
174
175			public function getUrl(): string
176			{
177			return $this->url;
			0 ignored issues – show Bug Best Practice introduced 2018-05-30 10:18 UTC by Report Bug Copy Issue Report The expression `return $this->url` could return the type `null` which is incompatible with the type-hinted return `string`. Consider adding an additional type-check to rule them out. Loading history...
178			}
179
180			/**
181			* @return ActionConfirmation\|null
182			*/
183			public function getConfirm(): ?ActionConfirmation
184			{
185			return $this->confirm;
186			}
187
188			/**
189			* @param ActionConfirmation $confirm
190			*
191			* @return AttachmentAction
192			*/
193			public function setConfirm(?ActionConfirmation $confirm): self
194			{
195			$this->confirm = $confirm;
196
197			return $this;
198			}
199
200			/**
201			* Get the array representation of this attachment action.
202			*
203			* @return array
204			*/
205			public function toArray(): array
206			{
207			return [
208			'name' => $this->name,
209			'text' => $this->text,
210			'style' => $this->style,
211			'type' => $this->type,
212			'value' => $this->value,
213			'url' => $this->url,
214			'confirm' => $this->confirm ? $this->confirm->toArray() : null,
215			];
216			}
217			}
218

nexylan / slack

Pull Request — master (#40)

AttachmentAction::setUrl() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like