T3Bot\Slack\Message\Attachment

Complexity

Total Complexity

25

Size/Duplication

Total Lines	302
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	3
A	getFallback()	0	4	1
A	setFallback()	0	4	1
A	getColor()	0	4	1
A	setColor()	0	4	1
A	getPretext()	0	4	1
A	getAuthorName()	0	4	1
A	setAuthorName()	0	4	1
A	getAuthorLink()	0	4	1
A	setAuthorLink()	0	4	1
A	getAuthorIcon()	0	4	1
A	setAuthorIcon()	0	4	1
A	getTitle()	0	4	1
A	setTitle()	0	4	1
A	getTitleLink()	0	4	1
A	setTitleLink()	0	4	1
A	getText()	0	4	1
A	setText()	0	4	1
A	getImageUrl()	0	4	1
A	setImageUrl()	0	4	1
A	getThumbUrl()	0	4	1
A	setThumbUrl()	0	4	1
A	setPretext()	0	4	1

<?php
/**
 * T3Bot.
 *
 * @author Frank Nägler <frank.naegler@typo3.org>
 *
 * @link http://www.t3bot.de
 * @link http://wiki.typo3.org/T3Bot
 */
namespace T3Bot\Slack\Message;

/**
 * Class Attachment.
 */
class Attachment
{
    const COLOR_NOTICE = '#cccccc';
    const COLOR_INFO = '#5bc0de';
    const COLOR_GOOD = '#5cb85c';
    const COLOR_WARNING = '#f0ad4e';
    const COLOR_DANGER = '#d9534f';

    /**
     * Required plain-text summary of the attachment.
     * A plain-text summary of the attachment. This text will be used in clients that
     * don't show formatted text (eg. IRC, mobile notifications) and should not contain
     * any markup.
     *
     * @var string
     */
    protected $fallback = '';

    /**
     * Color for the attachment
     * An optional value that can either be one of good, warning, danger, or
     * any hex color code (eg. #439FE0). This value is used to color the border
     * along the left side of the message attachment.
     *
     * @var string
     */
    protected $color = self::COLOR_INFO;

    /**
     * This is optional text that appears above the message attachment block.
     *
     * @var string
     */
    protected $pretext = '';

    /**
     * Small text used to display the author's name.
     *
     * @var string
     */
    protected $authorName = '';

    /**
     * A valid URL that will hyperlink the author_name text mentioned above.
     * Will only work if author_name is present.
     *
     * @var string
     */
    protected $authorLink = '';

    /**
     * A valid URL that displays a small 16x16px image to the left of the author_name text.
     * Will only work if author_name is present.
     *
     * @var string
     */
    protected $authorIcon = '';

    /**
     * The title is displayed as larger, bold text near the top of a message attachment.
     *
     * @var string
     */
    protected $title = '';

    /**
     * By passing a valid URL in the title_link parameter (optional), the title text
     * will be hyperlinked.
     *
     * @var string
     */
    protected $titleLink = '';

    /**
     * This is the main text in a message attachment, and can contain standard message
     * markup. The content will automatically collapse if it contains 700+ characters
     * or 5+ linebreaks, and will display a "Show more..." link to expand the content.
     *
     * @var string
     */
    protected $text = '';

    /**
     * Fields are defined as an array, and hashes contained within it will be displayed
     * in a table inside the message attachment.
     *
     * @var array<\T3Bot\Slack\Message\Attachment\Field>
     */
    protected $fields = [];

    /**
     * A valid URL to an image file that will be displayed inside a message attachment.
     * We currently support the following formats: GIF, JPEG, PNG, and BMP.
     * Large images will be resized to a maximum width of 400px or a maximum height of
     * 500px, while still maintaining the original aspect ratio.
     *
     * @var string
     */
    protected $imageUrl = '';

    /**
     * A valid URL to an image file that will be displayed as a thumbnail on the right
     * side of a message attachment. We currently support the following formats: GIF,
     * JPEG, PNG, and BMP.
     * The thumbnail's longest dimension will be scaled down to 75px while maintaining
     * the aspect ratio of the image. The filesize of the image must also be less than
     * 500 KB.
     *
     * @var string
     */
    protected $thumbUrl = '';

    /**
     * Constructor for an attachment.
     *
     * @param array $data
     */
    public function __construct(array $data = [])
    {
        foreach ($data as $property => $value) {
            if (property_exists($this, $property)) {
                $this->$property = $value;
            }
        }
    }

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

    /**
     * @param string $fallback
     */
    public function setFallback($fallback)
    {
        $this->fallback = $fallback;
    }

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

    /**
     * @param string $color
     */
    public function setColor($color)
    {
        $this->color = $color;
    }

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

    /**
     * @param string $pretext
     */
    public function setPretext($pretext)
    {
        $this->pretext = $pretext;
    }

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

    /**
     * @param string $authorName
     */
    public function setAuthorName($authorName)
    {
        $this->authorName = $authorName;
    }

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

    /**
     * @param string $authorLink
     */
    public function setAuthorLink($authorLink)
    {
        $this->authorLink = $authorLink;
    }

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

    /**
     * @param string $authorIcon
     */
    public function setAuthorIcon($authorIcon)
    {
        $this->authorIcon = $authorIcon;
    }

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

    /**
     * @param string $title
     */
    public function setTitle($title)
    {
        $this->title = $title;
    }

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

    /**
     * @param string $titleLink
     */
    public function setTitleLink($titleLink)
    {
        $this->titleLink = $titleLink;
    }

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

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

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

    /**
     * @param string $imageUrl
     */
    public function setImageUrl($imageUrl)
    {
        $this->imageUrl = $imageUrl;
    }

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

    /**
     * @param string $thumbUrl
     */
    public function setThumbUrl($thumbUrl)
    {
        $this->thumbUrl = $thumbUrl;
    }
}