Attachment::getCallbackId() - Code Metrics - Inspection of "return ResponseInterface" - maknz/slack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#90)

unknown

created 2017-12-09 11:30 UTC

Attachment::getCallbackId() A

↳ Parent: Attachment

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

namespace Maknz\Slack;

use InvalidArgumentException;

class Attachment
{
    /**
     * The fallback text to use for clients that don't support attachments.
     *
     * @var string
     */
    protected $fallback;

    /**
     * The callback_id
     *
     * @var string
     */
    protected $callback_id;

    /**
     * Optional text that should appear within the attachment.
     *
     * @var string
     */
    protected $text;

    /**
     * Optional image that should appear within the attachment.
     *
     * @var string
     */
    protected $image_url;

    /**
     * Optional thumbnail that should appear within the attachment.
     *
     * @var string
     */
    protected $thumb_url;

    /**
     * Optional text that should appear above the formatted data.
     *
     * @var string
     */
    protected $pretext;

    /**
     * Optional title for the attachment.
     *
     * @var string
     */
    protected $title;

    /**
     * Optional title link for the attachment.
     *
     * @var string
     */
    protected $title_link;

    /**
     * Optional author name for the attachment.
     *
     * @var string
     */
    protected $author_name;

    /**
     * Optional author link for the attachment.
     *
     * @var string
     */
    protected $author_link;

    /**
     * Optional author icon for the attachment.
     *
     * @var string
     */
    protected $author_icon;

    /**
     * The color to use for the attachment.
     *
     * @var string
     */
    protected $color = 'good';

    /**
     * The text to use for the attachment footer.
     *
     * @var string
     */
    protected $footer;

    /**
     * The icon to use for the attachment footer.
     *
     * @var string
     */
    protected $footer_icon;

    /**
     * The timestamp to use for the attachment.
     *
     * @var \DateTime
     */
    protected $timestamp;

    /**
     * The fields of the attachment.
     *
     * @var array
     */
    protected $fields = [];

    /**
     * The fields of the attachment that Slack should interpret
     * with its Markdown-like language.
     *
     * @var array
     */
    protected $markdown_fields = [];

    /**
     * A collection of actions (buttons) to include in the attachment.
     * A maximum of 5 actions may be provided.
     *
     * @var array
     */
    protected $actions = [];

    /**
     * Instantiate a new Attachment.
     *
     * @param array $attributes
     * @return void

     */
    public function __construct(array $attributes)
    {
        if (isset($attributes['fallback'])) {
            $this->setFallback($attributes['fallback']);
        }

        if (isset($attributes['callback_id'])) {
            $this->setCallbackId($attributes['callback_id']);
        }

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

        if (isset($attributes['image_url'])) {
            $this->setImageUrl($attributes['image_url']);
        }

        if (isset($attributes['thumb_url'])) {
            $this->setThumbUrl($attributes['thumb_url']);
        }

        if (isset($attributes['pretext'])) {
            $this->setPretext($attributes['pretext']);
        }

        if (isset($attributes['color'])) {
            $this->setColor($attributes['color']);
        }

        if (isset($attributes['footer'])) {
            $this->setFooter($attributes['footer']);
        }

        if (isset($attributes['footer_icon'])) {
            $this->setFooterIcon($attributes['footer_icon']);
        }

        if (isset($attributes['timestamp'])) {
            $this->setTimestamp($attributes['timestamp']);
        }

        if (isset($attributes['fields'])) {
            $this->setFields($attributes['fields']);
        }

        if (isset($attributes['mrkdwn_in'])) {
            $this->setMarkdownFields($attributes['mrkdwn_in']);
        }

        if (isset($attributes['title'])) {
            $this->setTitle($attributes['title']);
        }

        if (isset($attributes['title_link'])) {
            $this->setTitleLink($attributes['title_link']);
        }

        if (isset($attributes['author_name'])) {
            $this->setAuthorName($attributes['author_name']);
        }

        if (isset($attributes['author_link'])) {
            $this->setAuthorLink($attributes['author_link']);
        }

        if (isset($attributes['author_icon'])) {
            $this->setAuthorIcon($attributes['author_icon']);
        }

        if (isset($attributes['actions'])) {
            $this->setActions($attributes['actions']);
        }
    }

    /**
     * Get the fallback text.
     *
     * @return string
     */
    public function getFallback()
    {
        return $this->fallback;
    }

    /**
     * Set the fallback text.
     *
     * @param string $fallback
     * @return $this
     */
    public function setFallback($fallback)
    {
        $this->fallback = $fallback;

        return $this;
    }


    /**
     * Get the callback_id.
     *
     * @return string
     */
    public function getCallbackId() {
        return $this->callback_id;
    }


    /**
     * Set the callback_id.
     *
     * @param string $fallback
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return $this
     */
    public function setCallbackId($callback_id) {
        $this->callback_id = $callback_id;

        return $this;
    }

    /**
     * Get the optional text to appear within the attachment.
     *
     * @return string
     */
    public function getText()
    {
        return $this->text;
    }

    /**
     * Set the optional text to appear within the attachment.
     *
     * @param string $text
     * @return $this
     */
    public function setText($text)
    {
        $this->text = $text;

        return $this;
    }

    /**
     * Get the optional image to appear within the attachment.
     *
     * @return string
     */
    public function getImageUrl()
    {
        return $this->image_url;
    }

    /**
     * Set the optional image to appear within the attachment.
     *
     * @param string $image_url
     * @return $this
     */
    public function setImageUrl($image_url)
    {
        $this->image_url = $image_url;

        return $this;
    }

    /**
     * Get the optional thumbnail to appear within the attachment.
     *
     * @return string
     */
    public function getThumbUrl()
    {
        return $this->thumb_url;
    }

    /**
     * Set the optional thumbnail to appear within the attachment.
     *
     * @param string $thumb_url
     * @return $this
     */
    public function setThumbUrl($thumb_url)
    {
        $this->thumb_url = $thumb_url;

        return $this;
    }

    /**
     * Get the text that should appear above the formatted data.
     *
     * @return string
     */
    public function getPretext()
    {
        return $this->pretext;
    }

    /**
     * Set the text that should appear above the formatted data.
     *
     * @param string $pretext
     * @return $this
     */
    public function setPretext($pretext)
    {
        $this->pretext = $pretext;

        return $this;
    }

    /**
     * Get the color to use for the attachment.
     *
     * @return string
     */
    public function getColor()
    {
        return $this->color;
    }

    /**
     * Set the color to use for the attachment.
     *
     * @param string $color
     * @return $this
     */
    public function setColor($color)
    {
        $this->color = $color;

        return $this;
    }

    /**
     * Get the footer to use for the attachment.
     *
     * @return string
     */
    public function getFooter()
    {
        return $this->footer;
    }

    /**
     * Set the footer text to use for the attachment.
     *
     * @param string $footer
     * @return $this
     */
    public function setFooter($footer)
    {
        $this->footer = $footer;

        return $this;
    }

    /**
     * Get the footer icon to use for the attachment.
     *
     * @return string
     */
    public function getFooterIcon()
    {
        return $this->footer_icon;
    }

    /**
     * Set the footer icon to use for the attachment.
     *
     * @param string $footerIcon
     * @return $this
     */
    public function setFooterIcon($footerIcon)
    {
        $this->footer_icon = $footerIcon;

        return $this;
    }

    /**
     * Get the timestamp to use for the attachment.
     *
     * @return \DateTime
     */
    public function getTimestamp()
    {
        return $this->timestamp;
    }

    /**
     * Set the timestamp to use for the attachment.
     *
     * @param \DateTime $timestamp
     * @return $this
     */
    public function setTimestamp($timestamp)
    {
        $this->timestamp = $timestamp;

        return $this;
    }

    /**
     * Get the title to use for the attachment.
     *
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * Set the title to use for the attachment.
     *
     * @param string $title
     * @return $this
     */
    public function setTitle($title)
    {
        $this->title = $title;

        return $this;
    }

    /**
     * Get the title link to use for the attachment.
     *
     * @return string
     */
    public function getTitleLink()
    {
        return $this->title_link;
    }

    /**
     * Set the title link to use for the attachment.
     *
     * @param string $title_link
     * @return $this
     */
    public function setTitleLink($title_link)
    {
        $this->title_link = $title_link;

        return $this;
    }

    /**
     * Get the author name to use for the attachment.
     *
     * @return string
     */
    public function getAuthorName()
    {
        return $this->author_name;
    }

    /**
     * Set the author name to use for the attachment.
     *
     * @param string $author_name
     * @return $this
     */
    public function setAuthorName($author_name)
    {
        $this->author_name = $author_name;

        return $this;
    }

    /**
     * Get the author link to use for the attachment.
     *
     * @return string
     */
    public function getAuthorLink()
    {
        return $this->author_link;
    }

    /**
     * Set the auhtor link to use for the attachment.
     *
     * @param string $author_link
     * @return $this
     */
    public function setAuthorLink($author_link)
    {
        $this->author_link = $author_link;

        return $this;
    }

    /**
     * Get the author icon to use for the attachment.
     *
     * @return string
     */
    public function getAuthorIcon()
    {
        return $this->author_icon;
    }

    /**
     * Set the author icon to use for the attachment.
     *
     * @param string $author_icon
     * @return $this
     */
    public function setAuthorIcon($author_icon)
    {
        $this->author_icon = $author_icon;

        return $this;
    }

    /**
     * Get the fields for the attachment.
     *
     * @return array
     */
    public function getFields()
    {
        return $this->fields;
    }

    /**
     * Set the fields for the attachment.
     *
     * @param array $fields
     * @return $this
     */
    public function setFields(array $fields)
    {
        $this->clearFields();

        foreach ($fields as $field) {
            $this->addField($field);
        }

        return $this;
    }

    /**
     * Add a field to the attachment.
     *
     * @param mixed $field
     * @return $this
     */
    public function addField($field)
    {
        if ($field instanceof AttachmentField) {
            $this->fields[] = $field;

            return $this;
        } elseif (is_array($field)) {
            $this->fields[] = new AttachmentField($field);

            return $this;
        }

        throw new InvalidArgumentException('The attachment field must be an instance of Maknz\Slack\AttachmentField or a keyed array');
    }

    /**
     * Clear the fields for the attachment.
     *
     * @return $this
     */
    public function clearFields()
    {
        $this->fields = [];

        return $this;
    }

    /**
     * Clear the actions for the attachment.
     *
     * @return $this
     */
    public function clearActions()
    {
        $this->actions = [];

        return $this;
    }

    /**
     * Get the fields Slack should interpret in its
     * Markdown-like language.
     *
     * @return array
     */
    public function getMarkdownFields()
    {
        return $this->markdown_fields;
    }

    /**
     * Set the fields Slack should interpret in its
     * Markdown-like language.
     *
     * @param array $fields
     * @return $this
     */
    public function setMarkdownFields(array $fields)
    {
        $this->markdown_fields = $fields;

        return $this;
    }

    /**
     * Get the collection of actions (buttons) to include in the attachment.
     *
     * @return AttachmentAction[]
     */
    public function getActions()
    {
        return $this->actions;
    }

    /**
     * Set the collection of actions (buttons) to include in the attachment.
     *
     * @param array $actions
     * @return Attachment
     */
    public function setActions($actions)
    {
        $this->clearActions();

        foreach ($actions as $action) {
            $this->addAction($action);
        }

        return $this;
    }

    /**
     * Add an action to the attachment.
     *
     * @param mixed $action
     * @return $this
     */
    public function addAction($action)
    {
        if ($action instanceof AttachmentAction) {
            $this->actions[] = $action;

            return $this;
        } elseif (is_array($action)) {
            $this->actions[] = new AttachmentAction($action);

            return $this;
        }

        throw new InvalidArgumentException('The attachment action must be an instance of Maknz\Slack\AttachmentAction or a keyed array');
    }

    /**
     * Convert this attachment to its array representation.
     *
     * @return array
     */
    public function toArray()
    {
        $data = [
            'fallback'    => $this->getFallback(),
            'callback_id' => $this->getCallbackId(),
            'text'        => $this->getText(),
            'pretext'     => $this->getPretext(),
            'color'       => $this->getColor(),
            'footer'      => $this->getFooter(),
            'footer_icon' => $this->getFooterIcon(),
            'ts'          => $this->getTimestamp() ? $this->getTimestamp()->getTimestamp() : null,
            'mrkdwn_in'   => $this->getMarkdownFields(),
            'image_url'   => $this->getImageUrl(),
            'thumb_url'   => $this->getThumbUrl(),
            'title'       => $this->getTitle(),
            'title_link'  => $this->getTitleLink(),
            'author_name' => $this->getAuthorName(),
            'author_link' => $this->getAuthorLink(),
            'author_icon' => $this->getAuthorIcon(),
        ];

        $data['fields'] = $this->getFieldsAsArrays();
        $data['actions'] = $this->getActionsAsArrays();

        $data = array_filter($data, function($item) {
            return !empty($item);
        });

        return $data;
    }

    /**
     * Iterates over all fields in this attachment and returns
     * them in their array form.
     *
     * @return array
     */
    protected function getFieldsAsArrays()
    {
        $fields = [];

        foreach ($this->getFields() as $field) {
            $fields[] = $field->toArray();
        }

        return $fields;
    }

    /**
     * Iterates over all actions in this attachment and returns
     * them in their array form.
     *
     * @return array
     */
    protected function getActionsAsArrays()
    {
        $actions = [];

        foreach ($this->getActions() as $action) {
            $actions[] = $action->toArray();
        }

        return $actions;
    }
}


1			<?php
2
3			namespace Maknz\Slack;
4
5			use InvalidArgumentException;
6
7			class Attachment
8			{
9			/**
10			* The fallback text to use for clients that don't support attachments.
11			*
12			* @var string
13			*/
14			protected $fallback;
15
16			/**
17			* The callback_id
18			*
19			* @var string
20			*/
21			protected $callback_id;
22
23			/**
24			* Optional text that should appear within the attachment.
25			*
26			* @var string
27			*/
28			protected $text;
29
30			/**
31			* Optional image that should appear within the attachment.
32			*
33			* @var string
34			*/
35			protected $image_url;
36
37			/**
38			* Optional thumbnail that should appear within the attachment.
39			*
40			* @var string
41			*/
42			protected $thumb_url;
43
44			/**
45			* Optional text that should appear above the formatted data.
46			*
47			* @var string
48			*/
49			protected $pretext;
50
51			/**
52			* Optional title for the attachment.
53			*
54			* @var string
55			*/
56			protected $title;
57
58			/**
59			* Optional title link for the attachment.
60			*
61			* @var string
62			*/
63			protected $title_link;
64
65			/**
66			* Optional author name for the attachment.
67			*
68			* @var string
69			*/
70			protected $author_name;
71
72			/**
73			* Optional author link for the attachment.
74			*
75			* @var string
76			*/
77			protected $author_link;
78
79			/**
80			* Optional author icon for the attachment.
81			*
82			* @var string
83			*/
84			protected $author_icon;
85
86			/**
87			* The color to use for the attachment.
88			*
89			* @var string
90			*/
91			protected $color = 'good';
92
93			/**
94			* The text to use for the attachment footer.
95			*
96			* @var string
97			*/
98			protected $footer;
99
100			/**
101			* The icon to use for the attachment footer.
102			*
103			* @var string
104			*/
105			protected $footer_icon;
106
107			/**
108			* The timestamp to use for the attachment.
109			*
110			* @var \DateTime
111			*/
112			protected $timestamp;
113
114			/**
115			* The fields of the attachment.
116			*
117			* @var array
118			*/
119			protected $fields = [];
120
121			/**
122			* The fields of the attachment that Slack should interpret
123			* with its Markdown-like language.
124			*
125			* @var array
126			*/
127			protected $markdown_fields = [];
128
129			/**
130			* A collection of actions (buttons) to include in the attachment.
131			* A maximum of 5 actions may be provided.
132			*
133			* @var array
134			*/
135			protected $actions = [];
136
137			/**
138			* Instantiate a new Attachment.
139			*
140			* @param array $attributes
141			* @return void
			0 ignored issues – show Comprehensibility Best Practice introduced 2015-12-21 05:07 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
142			*/
143			public function __construct(array $attributes)
144			{
145			if (isset($attributes['fallback'])) {
146			$this->setFallback($attributes['fallback']);
147			}
148
149			if (isset($attributes['callback_id'])) {
150			$this->setCallbackId($attributes['callback_id']);
151			}
152
153			if (isset($attributes['text'])) {
154			$this->setText($attributes['text']);
155			}
156
157			if (isset($attributes['image_url'])) {
158			$this->setImageUrl($attributes['image_url']);
159			}
160
161			if (isset($attributes['thumb_url'])) {
162			$this->setThumbUrl($attributes['thumb_url']);
163			}
164
165			if (isset($attributes['pretext'])) {
166			$this->setPretext($attributes['pretext']);
167			}
168
169			if (isset($attributes['color'])) {
170			$this->setColor($attributes['color']);
171			}
172
173			if (isset($attributes['footer'])) {
174			$this->setFooter($attributes['footer']);
175			}
176
177			if (isset($attributes['footer_icon'])) {
178			$this->setFooterIcon($attributes['footer_icon']);
179			}
180
181			if (isset($attributes['timestamp'])) {
182			$this->setTimestamp($attributes['timestamp']);
183			}
184
185			if (isset($attributes['fields'])) {
186			$this->setFields($attributes['fields']);
187			}
188
189			if (isset($attributes['mrkdwn_in'])) {
190			$this->setMarkdownFields($attributes['mrkdwn_in']);
191			}
192
193			if (isset($attributes['title'])) {
194			$this->setTitle($attributes['title']);
195			}
196
197			if (isset($attributes['title_link'])) {
198			$this->setTitleLink($attributes['title_link']);
199			}
200
201			if (isset($attributes['author_name'])) {
202			$this->setAuthorName($attributes['author_name']);
203			}
204
205			if (isset($attributes['author_link'])) {
206			$this->setAuthorLink($attributes['author_link']);
207			}
208
209			if (isset($attributes['author_icon'])) {
210			$this->setAuthorIcon($attributes['author_icon']);
211			}
212
213			if (isset($attributes['actions'])) {
214			$this->setActions($attributes['actions']);
215			}
216			}
217
218			/**
219			* Get the fallback text.
220			*
221			* @return string
222			*/
223			public function getFallback()
224			{
225			return $this->fallback;
226			}
227
228			/**
229			* Set the fallback text.
230			*
231			* @param string $fallback
232			* @return $this
233			*/
234			public function setFallback($fallback)
235			{
236			$this->fallback = $fallback;
237
238			return $this;
239			}
240
241
242			/**
243			* Get the callback_id.
244			*
245			* @return string
246			*/
247			public function getCallbackId() {
248			return $this->callback_id;
249			}
250
251
252			/**
253			* Set the callback_id.
254			*
255			* @param string $fallback
			0 ignored issues – show Bug introduced 2017-11-08 23:13 UTC by Report Bug Copy Issue Report There is no parameter named `$fallback`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
256			* @return $this
257			*/
258			public function setCallbackId($callback_id) {
259			$this->callback_id = $callback_id;
260
261			return $this;
262			}
263
264			/**
265			* Get the optional text to appear within the attachment.
266			*
267			* @return string
268			*/
269			public function getText()
270			{
271			return $this->text;
272			}
273
274			/**
275			* Set the optional text to appear within the attachment.
276			*
277			* @param string $text
278			* @return $this
279			*/
280			public function setText($text)
281			{
282			$this->text = $text;
283
284			return $this;
285			}
286
287			/**
288			* Get the optional image to appear within the attachment.
289			*
290			* @return string
291			*/
292			public function getImageUrl()
293			{
294			return $this->image_url;
295			}
296
297			/**
298			* Set the optional image to appear within the attachment.
299			*
300			* @param string $image_url
301			* @return $this
302			*/
303			public function setImageUrl($image_url)
304			{
305			$this->image_url = $image_url;
306
307			return $this;
308			}
309
310			/**
311			* Get the optional thumbnail to appear within the attachment.
312			*
313			* @return string
314			*/
315			public function getThumbUrl()
316			{
317			return $this->thumb_url;
318			}
319
320			/**
321			* Set the optional thumbnail to appear within the attachment.
322			*
323			* @param string $thumb_url
324			* @return $this
325			*/
326			public function setThumbUrl($thumb_url)
327			{
328			$this->thumb_url = $thumb_url;
329
330			return $this;
331			}
332
333			/**
334			* Get the text that should appear above the formatted data.
335			*
336			* @return string
337			*/
338			public function getPretext()
339			{
340			return $this->pretext;
341			}
342
343			/**
344			* Set the text that should appear above the formatted data.
345			*
346			* @param string $pretext
347			* @return $this
348			*/
349			public function setPretext($pretext)
350			{
351			$this->pretext = $pretext;
352
353			return $this;
354			}
355
356			/**
357			* Get the color to use for the attachment.
358			*
359			* @return string
360			*/
361			public function getColor()
362			{
363			return $this->color;
364			}
365
366			/**
367			* Set the color to use for the attachment.
368			*
369			* @param string $color
370			* @return $this
371			*/
372			public function setColor($color)
373			{
374			$this->color = $color;
375
376			return $this;
377			}
378
379			/**
380			* Get the footer to use for the attachment.
381			*
382			* @return string
383			*/
384			public function getFooter()
385			{
386			return $this->footer;
387			}
388
389			/**
390			* Set the footer text to use for the attachment.
391			*
392			* @param string $footer
393			* @return $this
394			*/
395			public function setFooter($footer)
396			{
397			$this->footer = $footer;
398
399			return $this;
400			}
401
402			/**
403			* Get the footer icon to use for the attachment.
404			*
405			* @return string
406			*/
407			public function getFooterIcon()
408			{
409			return $this->footer_icon;
410			}
411
412			/**
413			* Set the footer icon to use for the attachment.
414			*
415			* @param string $footerIcon
416			* @return $this
417			*/
418			public function setFooterIcon($footerIcon)
419			{
420			$this->footer_icon = $footerIcon;
421
422			return $this;
423			}
424
425			/**
426			* Get the timestamp to use for the attachment.
427			*
428			* @return \DateTime
429			*/
430			public function getTimestamp()
431			{
432			return $this->timestamp;
433			}
434
435			/**
436			* Set the timestamp to use for the attachment.
437			*
438			* @param \DateTime $timestamp
439			* @return $this
440			*/
441			public function setTimestamp($timestamp)
442			{
443			$this->timestamp = $timestamp;
444
445			return $this;
446			}
447
448			/**
449			* Get the title to use for the attachment.
450			*
451			* @return string
452			*/
453			public function getTitle()
454			{
455			return $this->title;
456			}
457
458			/**
459			* Set the title to use for the attachment.
460			*
461			* @param string $title
462			* @return $this
463			*/
464			public function setTitle($title)
465			{
466			$this->title = $title;
467
468			return $this;
469			}
470
471			/**
472			* Get the title link to use for the attachment.
473			*
474			* @return string
475			*/
476			public function getTitleLink()
477			{
478			return $this->title_link;
479			}
480
481			/**
482			* Set the title link to use for the attachment.
483			*
484			* @param string $title_link
485			* @return $this
486			*/
487			public function setTitleLink($title_link)
488			{
489			$this->title_link = $title_link;
490
491			return $this;
492			}
493
494			/**
495			* Get the author name to use for the attachment.
496			*
497			* @return string
498			*/
499			public function getAuthorName()
500			{
501			return $this->author_name;
502			}
503
504			/**
505			* Set the author name to use for the attachment.
506			*
507			* @param string $author_name
508			* @return $this
509			*/
510			public function setAuthorName($author_name)
511			{
512			$this->author_name = $author_name;
513
514			return $this;
515			}
516
517			/**
518			* Get the author link to use for the attachment.
519			*
520			* @return string
521			*/
522			public function getAuthorLink()
523			{
524			return $this->author_link;
525			}
526
527			/**
528			* Set the auhtor link to use for the attachment.
529			*
530			* @param string $author_link
531			* @return $this
532			*/
533			public function setAuthorLink($author_link)
534			{
535			$this->author_link = $author_link;
536
537			return $this;
538			}
539
540			/**
541			* Get the author icon to use for the attachment.
542			*
543			* @return string
544			*/
545			public function getAuthorIcon()
546			{
547			return $this->author_icon;
548			}
549
550			/**
551			* Set the author icon to use for the attachment.
552			*
553			* @param string $author_icon
554			* @return $this
555			*/
556			public function setAuthorIcon($author_icon)
557			{
558			$this->author_icon = $author_icon;
559
560			return $this;
561			}
562
563			/**
564			* Get the fields for the attachment.
565			*
566			* @return array
567			*/
568			public function getFields()
569			{
570			return $this->fields;
571			}
572
573			/**
574			* Set the fields for the attachment.
575			*
576			* @param array $fields
577			* @return $this
578			*/
579			public function setFields(array $fields)
580			{
581			$this->clearFields();
582
583			foreach ($fields as $field) {
584			$this->addField($field);
585			}
586
587			return $this;
588			}
589
590			/**
591			* Add a field to the attachment.
592			*
593			* @param mixed $field
594			* @return $this
595			*/
596			public function addField($field)
597			{
598			if ($field instanceof AttachmentField) {
599			$this->fields[] = $field;
600
601			return $this;
602			} elseif (is_array($field)) {
603			$this->fields[] = new AttachmentField($field);
604
605			return $this;
606			}
607
608			throw new InvalidArgumentException('The attachment field must be an instance of Maknz\Slack\AttachmentField or a keyed array');
609			}
610
611			/**
612			* Clear the fields for the attachment.
613			*
614			* @return $this
615			*/
616			public function clearFields()
617			{
618			$this->fields = [];
619
620			return $this;
621			}
622
623			/**
624			* Clear the actions for the attachment.
625			*
626			* @return $this
627			*/
628			public function clearActions()
629			{
630			$this->actions = [];
631
632			return $this;
633			}
634
635			/**
636			* Get the fields Slack should interpret in its
637			* Markdown-like language.
638			*
639			* @return array
640			*/
641			public function getMarkdownFields()
642			{
643			return $this->markdown_fields;
644			}
645
646			/**
647			* Set the fields Slack should interpret in its
648			* Markdown-like language.
649			*
650			* @param array $fields
651			* @return $this
652			*/
653			public function setMarkdownFields(array $fields)
654			{
655			$this->markdown_fields = $fields;
656
657			return $this;
658			}
659
660			/**
661			* Get the collection of actions (buttons) to include in the attachment.
662			*
663			* @return AttachmentAction[]
664			*/
665			public function getActions()
666			{
667			return $this->actions;
668			}
669
670			/**
671			* Set the collection of actions (buttons) to include in the attachment.
672			*
673			* @param array $actions
674			* @return Attachment
675			*/
676			public function setActions($actions)
677			{
678			$this->clearActions();
679
680			foreach ($actions as $action) {
681			$this->addAction($action);
682			}
683
684			return $this;
685			}
686
687			/**
688			* Add an action to the attachment.
689			*
690			* @param mixed $action
691			* @return $this
692			*/
693			public function addAction($action)
694			{
695			if ($action instanceof AttachmentAction) {
696			$this->actions[] = $action;
697
698			return $this;
699			} elseif (is_array($action)) {
700			$this->actions[] = new AttachmentAction($action);
701
702			return $this;
703			}
704
705			throw new InvalidArgumentException('The attachment action must be an instance of Maknz\Slack\AttachmentAction or a keyed array');
706			}
707
708			/**
709			* Convert this attachment to its array representation.
710			*
711			* @return array
712			*/
713			public function toArray()
714			{
715			$data = [
716			'fallback' => $this->getFallback(),
717			'callback_id' => $this->getCallbackId(),
718			'text' => $this->getText(),
719			'pretext' => $this->getPretext(),
720			'color' => $this->getColor(),
721			'footer' => $this->getFooter(),
722			'footer_icon' => $this->getFooterIcon(),
723			'ts' => $this->getTimestamp() ? $this->getTimestamp()->getTimestamp() : null,
724			'mrkdwn_in' => $this->getMarkdownFields(),
725			'image_url' => $this->getImageUrl(),
726			'thumb_url' => $this->getThumbUrl(),
727			'title' => $this->getTitle(),
728			'title_link' => $this->getTitleLink(),
729			'author_name' => $this->getAuthorName(),
730			'author_link' => $this->getAuthorLink(),
731			'author_icon' => $this->getAuthorIcon(),
732			];
733
734			$data['fields'] = $this->getFieldsAsArrays();
735			$data['actions'] = $this->getActionsAsArrays();
736
737			$data = array_filter($data, function($item) {
738			return !empty($item);
739			});
740
741			return $data;
742			}
743
744			/**
745			* Iterates over all fields in this attachment and returns
746			* them in their array form.
747			*
748			* @return array
749			*/
750			protected function getFieldsAsArrays()
751			{
752			$fields = [];
753
754			foreach ($this->getFields() as $field) {
755			$fields[] = $field->toArray();
756			}
757
758			return $fields;
759			}
760
761			/**
762			* Iterates over all actions in this attachment and returns
763			* them in their array form.
764			*
765			* @return array
766			*/
767			protected function getActionsAsArrays()
768			{
769			$actions = [];
770
771			foreach ($this->getActions() as $action) {
772			$actions[] = $action->toArray();
773			}
774
775			return $actions;
776			}
777			}
778

maknz / slack

GitHub Access Token became invalid

Pull Request — master (#90)

Attachment::getCallbackId() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like