Message::setAttributes() - Code Metrics - Inspection of "Updating dependencies." - unyx/notify - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 693596...23a82f )

by Michał

created 2016-11-17 22:00 UTC

Message::setAttributes() D

↳ Parent: Message

Complexity

Conditions	8
Paths	128

Size

Total Lines	32
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	32
rs	4.6666
c	0
b	0
f	0
cc	8
eloc	16
nc	128
nop	1

<?php namespace nyx\notify\transports\slack;

// External dependencies
use nyx\core;
use nyx\diagnostics;

/**
 * Slack Message
 *
 * @package     Nyx\Notify
 * @version     0.1.0
 * @author      Michal Chojnacki <[email protected]>
 * @copyright   2012-2017 Nyx Dev Team
 * @link        https://github.com/unyx/nyx
 * @todo        PHP7.1 pass for nullable return types (missing ?string on most methods).
 */
class Message implements core\interfaces\Serializable
{
    /**
     * The parse modes that can be requested for a Message.
     */
    const PARSE_DEFAULT = null;
    const PARSE_FULL    = 'full';
    const PARSE_NONE    = 'none';

    /**
     * The traits of a Slack Message.
     */
    use core\traits\Serializable;

    /**
     * @var string  The endpoint for this Message. Note: Only has effect when using the Slack Webhook Transport, not
     *              the Web API.
     */
    protected $endpoint;

    /**
     * @var string  The text content of the Message.
     */
    protected $text;

    /**
     * @var string  The channel this Message shall be sent to.
     */
    protected $channel;

    /**
     * @var string  The name this Message shall be sent as.
     */
    protected $username;

    /**
     * @var string  The icon of the Message.
     */
    protected $icon;

    /**
     * @var message\Attachment[]    The Attachments of the Message.
     */
    protected $attachments = [];

    /**
     * @var string  The parse mode of this Message. One of the PARSE_* class constants.
     */
    protected $parse;

    /**
     * Creates a new Slack Message instance.
     *
     * @param   array   $attributes
     */
    public function __construct(array $attributes = null)
    {
        if (!empty($attributes)) {
            $this->setAttributes($attributes);
        }
    }

    /**
     * Sets the attributes of this Message.
     *
     * @param   array   $attributes
     * @return  $this
     */
    public function setAttributes(array $attributes) : Message
    {
        if (isset($attributes['endpoint'])) {
            $this->setEndpoint($attributes['endpoint']);
        }

        if (isset($attributes['text'])) {
            $this->setText($attributes['text']);
        }

        if (isset($attributes['channel'])) {
            $this->setChannel($attributes['channel']);
        }

        if (isset($attributes['username'])) {
            $this->setUsername($attributes['username']);
        }

        if (isset($attributes['icon'])) {
            $this->setIcon($attributes['icon']);
        }

        foreach($attributes['attachments'] as $attachment) {
            $this->attach($attachment);
        }

        if (isset($attributes['parse'])) {
            $this->setParseMode($attributes['parse']);
        }

        return $this;
    }

    /**
     * Returns the endpoint for this Message.
     *
     * Note: Only has effect when using the Slack Webhook Transport, not the Web API.
     *
     * @return  string
     */
    public function getEndpoint()
    {
        return $this->endpoint;
    }

    /**
     * Sets the endpoint for this Message.
     *
     * Note: Only has effect when using the Slack Webhook Transport, not the Web API.
     *
     * @param   string  $url
     * @return  $this
     */
    public function setEndpoint(string $url) : Message
    {
        $this->endpoint = $url;

        return $this;
    }

    /**
     * Returns the text content of the Message.
     *
     * @return  string
     */
    public function getText()
    {
        return $this->text;
    }

    /**
     * Sets the text content of the Message.
     *
     * @param   string  $text
     * @return  $this
     */
    public function setText(string $text) : Message
    {
        $this->text = $text;

        return $this;
    }

    /**
     * Returns the channel this Message shall be sent to.
     *
     * @return  string
     */
    public function getChannel()
    {
        return $this->channel;
    }

    /**
     * Sets the channel this Message shall be sent to.
     *
     * @param   string  $channel
     * @return  $this
     */
    public function setChannel(string $channel = null) : Message
    {
        $this->channel = $channel;

        return $this;
    }

    /**
     * Returns the name this Message shall be sent as.
     *
     * @return  string
     */
    public function getUsername()
    {
        return $this->username;
    }

    /**
     * Sets the name this Message shall be sent as.
     *
     * @param   string  $name
     * @return  $this
     */
    public function setUsername(string $name = null) : Message
    {
        $this->username = $name;

        return $this;
    }

    /**
     * Returns the icon of the Message.
     *
     * @return  string
     */
    public function getIcon()
    {
        return $this->icon;
    }

    /**
     * Sets the icon of the Message.
     *
     * @param   string  $icon
     * @return  $this
     */
    public function setIcon(string $icon = null) : Message
    {
        $this->icon = $icon;

        return $this;
    }

    /**
     * Adds an Attachment to the Message.
     *
     * @param   callable|array|message\Attachment   $attachment When a callable is given, an Attachment will be created
     *                                                          and passed to the callable. With an array, an Attachment
     *                                                          will be constructed based on the array. Otherwise
     *                                                          an existing instance of an Attachment can be passed in.
     * @return  $this
     * @throws  \InvalidArgumentException                       When $attachment is neither of the supported types.
     */
    public function attach($attachment) : Message

    {
        // Let's try to resolve the input into something usable.
        if (!($attachment = $this->resolveAttachment($attachment)) instanceof message\Attachment) {
            throw new \InvalidArgumentException("Expected a callable, an array or an instance of ".message\Attachment::class.", got [".diagnostics\Debug::getTypeName($attachment)."] instead.");
        }

        $this->attachments[] = $attachment;

        return $this;
    }

    /**
     * Checks whether an Attachment with the specified $index is set.
     *
     * @return  bool
     */
    public function hasAttachment(int $index) : bool
    {
        return isset($this->attachments[$index]);
    }

    /**
     * Returns the Attachment at the given $index.
     *
     * @return  message\Attachment
     * @throws  \OutOfBoundsException
     */
    public function getAttachment(int $index) : message\Attachment
    {
        if (!isset($this->attachments[$index])) {
            throw new \OutOfBoundsException("No Attachment at the specified index [$index].");
        }

        return $this->attachments[$index];
    }

    /**
     * Sets the Attachment at the given $index. Overwrites, if applicable.
     *
     * @see     attach()
     *
     * @param   callable|array|message\Attachment   $attachment
     * @return  $this
     * @throws  \InvalidArgumentException
     */
    public function setAttachment(int $index, $attachment) : Message

    {
        // Let's try to resolve the input into something usable.
        if (!($attachment = $this->resolveAttachment($attachment)) instanceof message\Attachment) {
            throw new \InvalidArgumentException("Expected a callable, an array or an instance of ".message\Attachment::class.", got [".diagnostics\Debug::getTypeName($attachment)."] instead.");
        }

        $this->attachments[$index] = $attachment;

        return $this;
    }

    /**
     * Returns the Attachments of the Message.
     *
     * @return  message\Attachment[]
     */
    public function getAttachments() : array
    {
        return $this->attachments;
    }

    /**
     * Sets the Attachments of the Message.
     *
     * @param   message\Attachment[]    $attachments
     * @return  $this
     */
    public function setAttachments(array $attachments) : Message
    {
        $this->attachments = [];

        foreach ($attachments as $attachment) {
            $this->attach($attachment);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        return $this;
    }

    /**
     * Returns the number of Attachments in this Message.
     *
     * @return  int
     */
    public function countAttachments() : int
    {
        return count($this->attachments);
    }

    /**
     * Returns the parse mode of this Message.
     *
     * @return  string
     */
    public function getParseMode()
    {
        return $this->parse;
    }

    /**
     * Sets the parse mode of this Message.
     *
     * @param   string  $mode               One of the PARSE_* class constants.
     * @return  $this
     * @throws  \InvalidArgumentException   When passing a $mode which is not one of the PARSE_* class constants.
     */
    public function setParseMode(string $mode = self::PARSE_DEFAULT) : Message
    {
        if (!in_array($mode, [self::PARSE_DEFAULT, self::PARSE_FULL, self::PARSE_NONE])) {
            throw new \InvalidArgumentException("Unknown parse mode requested [$mode].");
        }

        $this->parse = $mode;

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function unserialize($data)
    {
        $this->setAttributes(unserialize($data));
    }

    /**
     * {@inheritDoc}
     */
    public function toArray() : array
    {
        $data = [
            'endpoint'    => $this->getEndpoint(),
            'text'        => $this->getText(),
            'channel'     => $this->getChannel(),
            'username'    => $this->getUsername(),
            'icon'        => $this->getIcon(),
            'parse'       => $this->getParseMode(),
            'attachments' => [],
            'link_names'  => 1
        ];

        foreach ($this->getAttachments() as $attachment) {
            $data['attachments'][] = $attachment->toArray();
        }

        return $data;
    }

    /**
     * Attempts to create a slack\Attachment instance based on the $attachment data given.
     *
     * @param   mixed   $attachment
     * @return  mixed                   Either an instantiated slack\Attachment, or a passthrough of the input data.
     */
    protected function resolveAttachment($attachment)
    {
        if (is_callable($attachment)) {
            $callable   = $attachment;
            $attachment = new message\Attachment;

            call_user_func($callable, $attachment);

            return $attachment;
        }

        if (is_array($attachment)) {
            return new message\Attachment($attachment);
        }

        return $attachment;
    }
}


1		<?php namespace nyx\notify\transports\slack;
2
3		// External dependencies
4		use nyx\core;
5		use nyx\diagnostics;
6
7		/**
8		* Slack Message
9		*
10		* @package Nyx\Notify
11		* @version 0.1.0
12		* @author Michal Chojnacki <[email protected]>
13		* @copyright 2012-2017 Nyx Dev Team
14		* @link https://github.com/unyx/nyx
15		* @todo PHP7.1 pass for nullable return types (missing ?string on most methods).
16		*/
17		class Message implements core\interfaces\Serializable
18		{
19		/**
20		* The parse modes that can be requested for a Message.
21		*/
22		const PARSE_DEFAULT = null;
23		const PARSE_FULL = 'full';
24		const PARSE_NONE = 'none';
25
26		/**
27		* The traits of a Slack Message.
28		*/
29		use core\traits\Serializable;
30
31		/**
32		* @var string The endpoint for this Message. Note: Only has effect when using the Slack Webhook Transport, not
33		* the Web API.
34		*/
35		protected $endpoint;
36
37		/**
38		* @var string The text content of the Message.
39		*/
40		protected $text;
41
42		/**
43		* @var string The channel this Message shall be sent to.
44		*/
45		protected $channel;
46
47		/**
48		* @var string The name this Message shall be sent as.
49		*/
50		protected $username;
51
52		/**
53		* @var string The icon of the Message.
54		*/
55		protected $icon;
56
57		/**
58		* @var message\Attachment[] The Attachments of the Message.
59		*/
60		protected $attachments = [];
61
62		/**
63		* @var string The parse mode of this Message. One of the PARSE_* class constants.
64		*/
65		protected $parse;
66
67		/**
68		* Creates a new Slack Message instance.
69		*
70		* @param array $attributes
71		*/
72		public function __construct(array $attributes = null)
73		{
74		if (!empty($attributes)) {
75		$this->setAttributes($attributes);
76		}
77		}
78
79		/**
80		* Sets the attributes of this Message.
81		*
82		* @param array $attributes
83		* @return $this
84		*/
85		public function setAttributes(array $attributes) : Message
86		{
87		if (isset($attributes['endpoint'])) {
88		$this->setEndpoint($attributes['endpoint']);
89		}
90
91		if (isset($attributes['text'])) {
92		$this->setText($attributes['text']);
93		}
94
95		if (isset($attributes['channel'])) {
96		$this->setChannel($attributes['channel']);
97		}
98
99		if (isset($attributes['username'])) {
100		$this->setUsername($attributes['username']);
101		}
102
103		if (isset($attributes['icon'])) {
104		$this->setIcon($attributes['icon']);
105		}
106
107		foreach($attributes['attachments'] as $attachment) {
108		$this->attach($attachment);
109		}
110
111		if (isset($attributes['parse'])) {
112		$this->setParseMode($attributes['parse']);
113		}
114
115		return $this;
116		}
117
118		/**
119		* Returns the endpoint for this Message.
120		*
121		* Note: Only has effect when using the Slack Webhook Transport, not the Web API.
122		*
123		* @return string
124		*/
125		public function getEndpoint()
126		{
127		return $this->endpoint;
128		}
129
130		/**
131		* Sets the endpoint for this Message.
132		*
133		* Note: Only has effect when using the Slack Webhook Transport, not the Web API.
134		*
135		* @param string $url
136		* @return $this
137		*/
138		public function setEndpoint(string $url) : Message
139		{
140		$this->endpoint = $url;
141
142		return $this;
143		}
144
145		/**
146		* Returns the text content of the Message.
147		*
148		* @return string
149		*/
150		public function getText()
151		{
152		return $this->text;
153		}
154
155		/**
156		* Sets the text content of the Message.
157		*
158		* @param string $text
159		* @return $this
160		*/
161		public function setText(string $text) : Message
162		{
163		$this->text = $text;
164
165		return $this;
166		}
167
168		/**
169		* Returns the channel this Message shall be sent to.
170		*
171		* @return string
172		*/
173		public function getChannel()
174		{
175		return $this->channel;
176		}
177
178		/**
179		* Sets the channel this Message shall be sent to.
180		*
181		* @param string $channel
182		* @return $this
183		*/
184		public function setChannel(string $channel = null) : Message
185		{
186		$this->channel = $channel;
187
188		return $this;
189		}
190
191		/**
192		* Returns the name this Message shall be sent as.
193		*
194		* @return string
195		*/
196		public function getUsername()
197		{
198		return $this->username;
199		}
200
201		/**
202		* Sets the name this Message shall be sent as.
203		*
204		* @param string $name
205		* @return $this
206		*/
207		public function setUsername(string $name = null) : Message
208		{
209		$this->username = $name;
210
211		return $this;
212		}
213
214		/**
215		* Returns the icon of the Message.
216		*
217		* @return string
218		*/
219		public function getIcon()
220		{
221		return $this->icon;
222		}
223
224		/**
225		* Sets the icon of the Message.
226		*
227		* @param string $icon
228		* @return $this
229		*/
230		public function setIcon(string $icon = null) : Message
231		{
232		$this->icon = $icon;
233
234		return $this;
235		}
236
237		/**
238		* Adds an Attachment to the Message.
239		*
240		* @param callable\|array\|message\Attachment $attachment When a callable is given, an Attachment will be created
241		* and passed to the callable. With an array, an Attachment
242		* will be constructed based on the array. Otherwise
243		* an existing instance of an Attachment can be passed in.
244		* @return $this
245		* @throws \InvalidArgumentException When $attachment is neither of the supported types.
246		*/
247	View Code Duplication	public function attach($attachment) : Message
		0 ignored issues – show Duplication introduced 2016-11-17 22:06 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
248		{
249		// Let's try to resolve the input into something usable.
250		if (!($attachment = $this->resolveAttachment($attachment)) instanceof message\Attachment) {
251		throw new \InvalidArgumentException("Expected a callable, an array or an instance of ".message\Attachment::class.", got [".diagnostics\Debug::getTypeName($attachment)."] instead.");
252		}
253
254		$this->attachments[] = $attachment;
255
256		return $this;
257		}
258
259		/**
260		* Checks whether an Attachment with the specified $index is set.
261		*
262		* @return bool
263		*/
264		public function hasAttachment(int $index) : bool
265		{
266		return isset($this->attachments[$index]);
267		}
268
269		/**
270		* Returns the Attachment at the given $index.
271		*
272		* @return message\Attachment
273		* @throws \OutOfBoundsException
274		*/
275		public function getAttachment(int $index) : message\Attachment
276		{
277		if (!isset($this->attachments[$index])) {
278		throw new \OutOfBoundsException("No Attachment at the specified index [$index].");
279		}
280
281		return $this->attachments[$index];
282		}
283
284		/**
285		* Sets the Attachment at the given $index. Overwrites, if applicable.
286		*
287		* @see attach()
288		*
289		* @param callable\|array\|message\Attachment $attachment
290		* @return $this
291		* @throws \InvalidArgumentException
292		*/
293	View Code Duplication	public function setAttachment(int $index, $attachment) : Message
		0 ignored issues – show Duplication introduced 2016-11-17 22:06 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
294		{
295		// Let's try to resolve the input into something usable.
296		if (!($attachment = $this->resolveAttachment($attachment)) instanceof message\Attachment) {
297		throw new \InvalidArgumentException("Expected a callable, an array or an instance of ".message\Attachment::class.", got [".diagnostics\Debug::getTypeName($attachment)."] instead.");
298		}
299
300		$this->attachments[$index] = $attachment;
301
302		return $this;
303		}
304
305		/**
306		* Returns the Attachments of the Message.
307		*
308		* @return message\Attachment[]
309		*/
310		public function getAttachments() : array
311		{
312		return $this->attachments;
313		}
314
315		/**
316		* Sets the Attachments of the Message.
317		*
318		* @param message\Attachment[] $attachments
319		* @return $this
320		*/
321		public function setAttachments(array $attachments) : Message
322		{
323		$this->attachments = [];
324
325		foreach ($attachments as $attachment) {
326		$this->attach($attachment);
		0 ignored issues – show Documentation introduced 2016-11-17 22:06 UTC by Report Bug Copy Issue Report `$attachment` is of type `object<nyx\notify\transp...ack\message\Attachment>`, but the function expects a `callable`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
327		}
328
329		return $this;
330		}
331
332		/**
333		* Returns the number of Attachments in this Message.
334		*
335		* @return int
336		*/
337		public function countAttachments() : int
338		{
339		return count($this->attachments);
340		}
341
342		/**
343		* Returns the parse mode of this Message.
344		*
345		* @return string
346		*/
347		public function getParseMode()
348		{
349		return $this->parse;
350		}
351
352		/**
353		* Sets the parse mode of this Message.
354		*
355		* @param string $mode One of the PARSE_* class constants.
356		* @return $this
357		* @throws \InvalidArgumentException When passing a $mode which is not one of the PARSE_* class constants.
358		*/
359		public function setParseMode(string $mode = self::PARSE_DEFAULT) : Message
360		{
361		if (!in_array($mode, [self::PARSE_DEFAULT, self::PARSE_FULL, self::PARSE_NONE])) {
362		throw new \InvalidArgumentException("Unknown parse mode requested [$mode].");
363		}
364
365		$this->parse = $mode;
366
367		return $this;
368		}
369
370		/**
371		* {@inheritDoc}
372		*/
373		public function unserialize($data)
374		{
375		$this->setAttributes(unserialize($data));
376		}
377
378		/**
379		* {@inheritDoc}
380		*/
381		public function toArray() : array
382		{
383		$data = [
384		'endpoint' => $this->getEndpoint(),
385		'text' => $this->getText(),
386		'channel' => $this->getChannel(),
387		'username' => $this->getUsername(),
388		'icon' => $this->getIcon(),
389		'parse' => $this->getParseMode(),
390		'attachments' => [],
391		'link_names' => 1
392		];
393
394		foreach ($this->getAttachments() as $attachment) {
395		$data['attachments'][] = $attachment->toArray();
396		}
397
398		return $data;
399		}
400
401		/**
402		* Attempts to create a slack\Attachment instance based on the $attachment data given.
403		*
404		* @param mixed $attachment
405		* @return mixed Either an instantiated slack\Attachment, or a passthrough of the input data.
406		*/
407		protected function resolveAttachment($attachment)
408		{
409		if (is_callable($attachment)) {
410		$callable = $attachment;
411		$attachment = new message\Attachment;
412
413		call_user_func($callable, $attachment);
414
415		return $attachment;
416		}
417
418		if (is_array($attachment)) {
419		return new message\Attachment($attachment);
420		}
421
422		return $attachment;
423		}
424		}
425

unyx / notify

Push — master ( 693596...23a82f )

Message::setAttributes() D

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like