Attachment::addFields() - Code Metrics - Inspection of "remove the error from the context after taking it..." - Pageon/SlackWebhookMonolog - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 36743e...544afa )

by jelmer

created 2016-02-18 23:17 UTC

Attachment::addFields() A

↳ Parent: Attachment

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
c	2
b	0
f	1
dl	0
loc	8
ccs	5
cts	5
cp	1
rs	9.4285
cc	2
eloc	4
nc	2
nop	1
crap	2

<?php

namespace Pageon\SlackWebhookMonolog\Slack\Attachment;

use JsonSerializable;
use Pageon\SlackWebhookMonolog\General\Url;

/**
 * A more richly-formatted message.
 *
 * @author Jelmer Prins <[email protected]>
 *
 * @since 0.4.0
 */
class Attachment implements JsonSerializable
{
    /**
     * The attachment itself.
     * We enable markdown in everything, why wouldn't we?
     *
     * @var array
     */
    private $attachment = ['mrkdwn_in' => ['pretext', 'text', 'fields']];

    /**
     * Attachment constructor.
     * I opted for setters since there are so many optional parameters.
     * A new instance would look be messy if you only needed the last optional parameter.
     *
     * @param string $fallback A plain-text summary of the attachment.
     */
    public function __construct($fallback)
    {
        if (empty($fallback)) {
            throw new \InvalidArgumentException('The fallback is required');
        }

        $this->attachment['fallback'] = $fallback;
    }

    /**
     * This is the main text in a message attachment.
     *
     * @param string $text
     *
     * @return self
     */
    public function setText($text)
    {
        $this->attachment['text'] = $text;

        return $this;
    }

    /**
     * This value is used to color the border along the left side of the message attachment.
     *
     * @param Colour $colour
     *
     * @return self
     */
    public function setColour(Colour $colour)
    {
        $this->attachment['color'] = $colour;

        return $this;
    }

    /**
     * This is optional text that appears above the message attachment block.
     *
     * @param string $pretext
     *
     * @return self
     */
    public function setPretext($pretext)
    {
        $this->attachment['pretext'] = $pretext;

        return $this;
    }

    /**
     * The author parameters will display a small section at the top of a message attachment.
     *
     * @param Author $author
     *
     * @return self
     */
    public function setAuthor(Author $author)
    {
        $this->attachment['author_name'] = $author;

        if ($author->hasIcon()) {
            $this->attachment['author_icon'] = $author->getIcon();
        }

        if ($author->hasLink()) {
            $this->attachment['author_link'] = $author->getLink();
        }

        return $this;
    }

    /**
     * The title is displayed as larger, bold text near the top of a message attachment.
     *
     * @param Title $title
     *
     * @return self
     */
    public function setTitle(Title $title)
    {
        $this->attachment['title'] = $title;

        if ($title->hasLink()) {
            $this->attachment['title_link'] = $title->getLink();
        }

        return $this;
    }

    /**
     * Will be displayed in a table inside the message attachment.
     *
     * @param Field $field
     *
     * @return self
     */
    public function addField(Field $field)
    {
        if (!isset($this->attachment['fields'])) {
            $this->attachment['fields'] = [];
        }

        $this->attachment['fields'][] = $field;

        return $this;
    }

    /**
     * Add multiple fields in 1 call.
     *
     * @param Field[] $fields
     *
     * @return self
     */
    public function addFields(array $fields)
    {
        foreach ($fields as $field) {
            $this->addField($field);
        }

        return $this;
    }

    /**
     * A valid URL to an image file that will be displayed inside a message attachment.
     *
     * @param Url $image
     *
     * @return self
     */
    public function setImage(Url $image)
    {
        $this->attachment['image_url'] = $image;

        return $this;
    }

    /**
     * A valid URL to an image file that will be displayed as a thumbnail on the right side of a message attachment.
     *
     * @param Url $thumbnail
     *
     * @return self
     */
    public function setThumbnail(Url $thumbnail)
    {
        $this->attachment['thumb_url'] = $thumbnail;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize()
    {
        return $this->get();
    }

    /**
     * Get the attachment in the format that slack requires.
     *
     * @return array
     */
    public function get()
    {
        return $this->attachment;
    }
}


1		<?php
2
3		namespace Pageon\SlackWebhookMonolog\Slack\Attachment;
4
5		use JsonSerializable;
6		use Pageon\SlackWebhookMonolog\General\Url;
7
8		/**
9		* A more richly-formatted message.
10		*
11		* @author Jelmer Prins <[email protected]>
12		*
13		* @since 0.4.0
14		*/
15		class Attachment implements JsonSerializable
16		{
17		/**
18		* The attachment itself.
19		* We enable markdown in everything, why wouldn't we?
20		*
21		* @var array
22		*/
23		private $attachment = ['mrkdwn_in' => ['pretext', 'text', 'fields']];
24
25		/**
26		* Attachment constructor.
27		* I opted for setters since there are so many optional parameters.
28		* A new instance would look be messy if you only needed the last optional parameter.
29		*
30		* @param string $fallback A plain-text summary of the attachment.
31		*/
32	17	public function __construct($fallback)
33		{
34	17	if (empty($fallback)) {
35	1	throw new \InvalidArgumentException('The fallback is required');
36		}
37
38	17	$this->attachment['fallback'] = $fallback;
39	17	}
40
41		/**
42		* This is the main text in a message attachment.
43		*
44		* @param string $text
45		*
46		* @return self
47		*/
48	9	public function setText($text)
49		{
50	9	$this->attachment['text'] = $text;
51
52	9	return $this;
53		}
54
55		/**
56		* This value is used to color the border along the left side of the message attachment.
57		*
58		* @param Colour $colour
59		*
60		* @return self
61		*/
62	9	public function setColour(Colour $colour)
63		{
64	9	$this->attachment['color'] = $colour;
65
66	9	return $this;
67		}
68
69		/**
70		* This is optional text that appears above the message attachment block.
71		*
72		* @param string $pretext
73		*
74		* @return self
75		*/
76	1	public function setPretext($pretext)
77		{
78	1	$this->attachment['pretext'] = $pretext;
79
80	1	return $this;
81		}
82
83		/**
84		* The author parameters will display a small section at the top of a message attachment.
85		*
86		* @param Author $author
87		*
88		* @return self
89		*/
90	1	public function setAuthor(Author $author)
91		{
92	1	$this->attachment['author_name'] = $author;
93
94	1	if ($author->hasIcon()) {
95	1	$this->attachment['author_icon'] = $author->getIcon();
96	1	}
97
98	1	if ($author->hasLink()) {
99	1	$this->attachment['author_link'] = $author->getLink();
100	1	}
101
102	1	return $this;
103		}
104
105		/**
106		* The title is displayed as larger, bold text near the top of a message attachment.
107		*
108		* @param Title $title
109		*
110		* @return self
111		*/
112	7	public function setTitle(Title $title)
113		{
114	7	$this->attachment['title'] = $title;
115
116	7	if ($title->hasLink()) {
117	1	$this->attachment['title_link'] = $title->getLink();
118	1	}
119
120	7	return $this;
121		}
122
123		/**
124		* Will be displayed in a table inside the message attachment.
125		*
126		* @param Field $field
127		*
128		* @return self
129		*/
130	9	public function addField(Field $field)
131		{
132	9	if (!isset($this->attachment['fields'])) {
133	9	$this->attachment['fields'] = [];
134	9	}
135
136	9	$this->attachment['fields'][] = $field;
137
138	9	return $this;
139		}
140
141		/**
142		* Add multiple fields in 1 call.
143		*
144		* @param Field[] $fields
145		*
146		* @return self
147		*/
148	1	public function addFields(array $fields)
149		{
150	1	foreach ($fields as $field) {
151	1	$this->addField($field);
152	1	}
153
154	1	return $this;
155		}
156
157		/**
158		* A valid URL to an image file that will be displayed inside a message attachment.
159		*
160		* @param Url $image
161		*
162		* @return self
163		*/
164	1	public function setImage(Url $image)
165		{
166	1	$this->attachment['image_url'] = $image;
167
168	1	return $this;
169		}
170
171		/**
172		* A valid URL to an image file that will be displayed as a thumbnail on the right side of a message attachment.
173		*
174		* @param Url $thumbnail
175		*
176		* @return self
177		*/
178	1	public function setThumbnail(Url $thumbnail)
179		{
180	1	$this->attachment['thumb_url'] = $thumbnail;
181
182	1	return $this;
183		}
184
185		/**
186		* {@inheritdoc}
187		*/
188	17	public function jsonSerialize()
189		{
190	17	return $this->get();
191		}
192
193		/**
194		* Get the attachment in the format that slack requires.
195		*
196		* @return array
197		*/
198	17	public function get()
199		{
200	17	return $this->attachment;
201		}
202		}
203

Pageon / SlackWebhookMonolog

Push — master ( 36743e...544afa )

Attachment::addFields() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like