nyx\notify\transports\slack\Response

Complexity

Total Complexity

8

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	1

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getType()	0	4	1
A	setType()	0	10	3
A	shouldReplaceOriginal()	0	4	1
A	setReplaceOriginal()	0	6	1
A	shouldDeleteOriginal()	0	4	1
A	setDeleteOriginal()	0	6	1

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

/**
 * Slack Response Message
 *
 * A Response is a special kind of Message that is sent after an Action of an Attachment has been invoked
 * inside Slack and Slack has called the designated callback URL.
 *
 * @package     Nyx\Notify
 * @version     0.1.0
 * @author      Michal Chojnacki <m.chojnacki@muyo.io>
 * @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 Response extends Message
{
    /**
     * The types a Response can be of.
     */
    const TYPE_CHANNEL   = 'in_channel';
    const TYPE_EPHEMERAL = 'ephemeral';

    /**
     * @var string  The type of the Response. One of the TYPE_* class constants.
     */
    protected $type;

    /**
     * @var bool Whether the original Message should be replaced by this Response. When false, this Response
     *           will be considered a brand new Message.
     */
    protected $replaceOriginal;

    /**
     * @var bool Whether the original Message should be deleted. If a new one is sent along this Response,
     *           it will be published as a brand new Message.
     */
    protected $deleteOriginal;

    /**
     * Returns the type of the Response.
     *
     * @return  string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Sets the type of the Response.
     *
     * @param   string  $type
     * @return  $this
     * @throws  \InvalidArgumentException
     */
    public function setType(string $type) : Response
    {
        if ($type !== self::TYPE_CHANNEL && $type !== self::TYPE_EPHEMERAL) {
            throw new \InvalidArgumentException('Expected type to be one of ['.self::TYPE_CHANNEL.', '.self::TYPE_CHANNEL.'], got ['.$type.'] instead.');
        }

        $this->type = $type;

        return $this;
    }

    /**
     * Checks whether the original Message should be replaced by this Response.
     *
     * @return  bool
     */
    public function shouldReplaceOriginal() : bool
    {
        return $this->replaceOriginal === true;
    }

    /**
     * Sets whether the original Message should be replaced by this Response.
     *
     * @param   bool    $replace
     * @return  $this
     */
    public function setReplaceOriginal(bool $replace) : Response
    {
        $this->replaceOriginal = $replace;

        return $this;
    }

    /**
     * Checks whether the original Message should be deleted.
     *
     * @return  bool
     */
    public function shouldDeleteOriginal() : bool
    {
        return $this->deleteOriginal === true;
    }

    /**
     * Sets whether the original Message should be deleted.
     *
     * @param   bool    $delete
     * @return  $this
     */
    public function setDeleteOriginal(bool $delete) : Response
    {
        $this->deleteOriginal = $delete;

        return $this;
    }
}