Spatie\SlashCommand\AttachmentAction

Complexity

Total Complexity

10

Size/Duplication

Total Lines	167
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	4	1
A	__construct()	0	6	1
A	setName()	0	6	1
A	setText()	0	6	1
A	setType()	0	6	1
A	setValue()	0	6	1
A	setStyle()	0	6	1
A	setConfirmation()	0	10	2
A	toArray()	0	11	1

<?php

namespace Spatie\SlashCommand;

use Spatie\SlashCommand\Exceptions\InvalidConfirmationHash;

class AttachmentAction
{
    const STYLE_DEFAULT = 'default';
    const STYLE_PRIMARY = 'primary';
    const STYLE_DANGER = 'danger';

    /**
     * The required name field of the action.
     *
     * @var string
     */
    protected $name;

    /**
     * The required text field of the action.
     *
     * @var string
     */
    protected $text;

    /**
     * The required type field of the action.
     *
     * @var string
     */
    protected $type;

    /**
     * The value of the action.
     *
     * @var string
     */
    protected $value = '';

    /**
     * The style of the action.
     *
     * @var string
     */
    protected $style = self::STYLE_DEFAULT;

    /**
     * An optional confirmation
     * dialog for the action
     *
     * @var null|array
     */
    protected $confirmation = null;

    public static function create($name, $text, $type)
    {
        return new static($name, $text, $type);
    }

    public function __construct(string $name, string $text, string $type)
    {
        $this->name = $name;
        $this->text = $text;
        $this->type = $type;
    }

    /**
     * Set the name of the action.
     *
     * @param string $name
     *
     * @return AttachmentAction
     */
    public function setName(string $name): AttachmentAction
    {
        $this->name = $name;

        return $this;
    }

    /**
     * Set the text of the action.
     *
     * @param string $text
     *
     * @return AttachmentAction
     */
    public function setText(string $text): AttachmentAction
    {
        $this->text = $text;

        return $this;
    }

    /**
     * Set the type of the action.
     *
     * @param string $type
     *
     * @return AttachmentAction
     */
    public function setType(string $type): AttachmentAction
    {
        $this->type = $type;

        return $this;
    }

    /**
     * Set the value of the action.
     *
     * @param string $value
     *
     * @return AttachmentAction
     */
    public function setValue(string $value): AttachmentAction
    {
        $this->value = $value;

        return $this;
    }

    /**
     * Set the style of the action.
     *
     * @param string $style
     *
     * @return AttachmentAction
     */
    public function setStyle(string $style): AttachmentAction
    {
        $this->style = $style;

        return $this;
    }

    /**
     * Sets the confirmation hash for the action.
     *
     * @param array $confirmation
     *
     * @return \Spatie\SlashCommand\AttachmentAction
     * @throws \Spatie\SlashCommand\Exceptions\InvalidConfirmationHash
     */
    public function setConfirmation(array $confirmation)
    {
        if (!array_key_exists('text', $confirmation)) {
            throw InvalidConfirmationHash::missingTextField();
        }

        $this->confirmation = $confirmation;

        return $this;
    }

    /**
     * Convert this action to its array representation.
     *
     * @return array
     */
    public function toArray(): array
    {
        return [
            'name' => $this->name,
            'text' => $this->text,
            'type' => $this->type,
            'value' => $this->value,
            'style' => $this->style,
            'confirm' => $this->confirmation,
        ];
    }
}