Pageon\SlackWebhookMonolog\Slack\Attachment\Colour

Complexity

Total Complexity

8

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setColour()	0	19	3
A	getColour()	0	4	1
A	__toString()	0	4	1
A	jsonSerialize()	0	4	1
A	getDefaultColours()	0	8	1

<?php

namespace Pageon\SlackWebhookMonolog\Slack\Attachment;

use JsonSerializable;
use Pageon\SlackWebhookMonolog\Slack\Exceptions\InvalidAttachmentColourException;

/**
 * @author Jelmer Prins <jelmer@pageon.be>
 *
 * 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.
 *
 * @since 0.3.2
 */
final class Colour implements JsonSerializable
{
    const COLOUR_GOOD = 'good';
    const COLOUR_WARNING = 'warning';
    const COLOUR_DANGER = 'danger';

    /**
     * @var string
     */
    private $colour;

    /**
     * @param string $colour
     */
    public function __construct($colour)
    {
        $this->setColour($colour);
    }

    /**
     * Set the colour if it is a valid colour.
     *
     * @param $colour
     */
    private function setColour($colour)
    {
        if (!in_array($colour, $this->getDefaultColours()) &&
            !preg_match(
                '_^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$_',
                $colour
            )
        ) {
            throw new InvalidAttachmentColourException(
                sprintf(
                    'The colour "%s" is not a valid colour. Possible options are "%s" or a valid hex colour',
                    $colour,
                    implode('", "', $this->getDefaultColours())
                )
            );
        }

        $this->colour = $colour;
    }

    /**
     * @return string
     */
    public function getColour()
    {
        return $this->colour;
    }

    /**
     * @inheritDoc
     */
    public function __toString()
    {
        return $this->getColour();
    }

    /**
     * @inheritDoc
     */
    public function jsonSerialize()
    {
        return (string) $this;
    }

    /**
     * Get the possible default colours.
     *
     * @return array
     */
    private function getDefaultColours()
    {
        return [
            self::COLOUR_GOOD,
            self::COLOUR_WARNING,
            self::COLOUR_DANGER,
        ];
    }
}