NotificationChannels\HipChat\HipChatMessage

Complexity

Total Complexity

20

Size/Duplication

Total Lines	292
Duplicated Lines	5.82 %

Coupling/Cohesion

Components	2
Dependencies	1

Test Coverage

Coverage

96.97%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	4	1
A	__construct()	0	4	1
A	room()	0	6	1
A	info()	0	7	1
A	success()	0	7	1
A	error()	0	7	1
A	from()	0	6	1
A	html()	0	10	2
A	text()	0	10	2
A	notify()	0	6	1
A	content()	0	6	1
A	color()	0	6	1
A	card()	17	19	3
A	attachTo()	0	6	1
A	toArray()	0	17	2

<?php

namespace NotificationChannels\HipChat;

use Closure;
use InvalidArgumentException;

class HipChatMessage
{
    /**
     * The HipChat room identifier.
     *
     * @var string
     */
    public $room = '';

    /**
     * A label to be shown in addition to the sender's name.
     *
     * @var string
     */
    public $from = '';

    /**
     * The format of the notification (text, html).
     *
     * @var string
     */
    public $format = 'text';

    /**
     * Should a message trigger a user notification in a HipChat client.
     *
     * @var bool
     */
    public $notify = false;

    /**
     * The "level" of the notification (info, success, error).
     *
     * @var string
     */
    public $level = 'info';

    /**
     * The color of the notification (yellow, green, red, purple, gray, random).
     *
     * @var string
     */
    public $color = 'gray';

    /**
     * The text content of the message.
     *
     * @var string
     */
    public $content = '';

    /**
     * An instance of Card object.
     *
     * @var Card
     */
    public $card;

    /**
     * The message id to to attach this notification to, for example if this notification is
     * in response to a particular message. For supported clients, this will display the
     * notification in the context of the referenced message specified by attach_to parameter.
     * If this is not possible to attach the notification, it will be rendered as an unattached
     * notification. The message must be in the same room as that the notification is sent to.
     *
     * @var string
     */
    public $attachTo;

    /**
     * Create a new instance of HipChatMessage.
     *
     * @param string $content
     * @return static
     */
    public static function create($content = '')
    {
        return new static($content);
    }

    /**
     * Create a new instance of HipChatMessage.
     *
     * @param $content
     */
    public function __construct($content = '')
    {
        $this->content($content);
    }

    /**
     * Set the HipChat room to send message to.
     *
     * @param int|string $room
     * @return $this
     */
    public function room($room)
    {
        $this->room = $room;

It seems like $room can also be of type integer. However, the property $room is declared as type string. Maybe add an additional type check?

        return $this;
    }

    /**
     * Indicate that the notification gives general information.
     *
     * @return $this
     */
    public function info()
    {
        $this->level = 'info';
        $this->color = 'gray';

        return $this;
    }

    /**
     * Indicate that the notification gives information about a successful operation.
     *
     * @return $this
     */
    public function success()
    {
        $this->level = 'success';
        $this->color = 'green';

        return $this;
    }

    /**
     * Indicate that the notification gives information about an error.
     *
     * @return $this
     */
    public function error()
    {
        $this->level = 'error';
        $this->color = 'red';

        return $this;
    }

    /**
     * Set the from label of the HipChat message.
     *
     * @param  string  $from
     * @return $this
     */
    public function from($from)
    {
        $this->from = trim($from);

        return $this;
    }

    /**
     * Set HTML format and optionally the content.
     *
     * @param string $content
     * @return $this
     */
    public function html($content = '')
    {
        $this->format = 'html';

        if (! str_empty($content)) {
            $this->content($content);
        }

        return $this;
    }

    /**
     * Set text format and optionally the content.
     *
     * @param string $content
     * @return $this
     */
    public function text($content = '')
    {
        $this->format = 'text';

        if (! str_empty($content)) {
            $this->content($content);
        }

        return $this;
    }

    /**
     * Should a message trigger a user notification in a HipChat client.
     *
     * @param  bool  $notify
     * @return $this
     */
    public function notify($notify = true)
    {
        $this->notify = $notify;

        return $this;
    }

    /**
     * Set the content of the message.
     * Allowed HTML tags: a, b, i, strong, em, br, img, pre, code, lists, tables.
     *
     * @param  string  $content
     * @return $this
     */
    public function content($content)
    {
        $this->content = trim($content);

        return $this;
    }

    /**
     * Set the color for the message.
     * Allowed values: yellow, green, red, purple, gray, random.
     *
     * @param $color
     * @return string
     */
    public function color($color)
    {
        $this->color = $color;

        return $this;
    }

    /**
     * Sets the Card.
     *
     * @param Card|Closure|null $card
     * @return $this
     */
    public function card($card)

This method seems to be duplicated in your project.

    {
        if ($card instanceof Card) {
            $this->card = $card;

            return $this;
        }

        if ($card instanceof Closure) {
            $card($new = new Card());
            $this->card = $new;

            return $this;
        }

        throw new InvalidArgumentException(
            'Invalid Card type. Expected '.Card::class.' or '.Closure::class.'.'
        );
    }

    /**
     * Sets the id of the "parent" message to attach this notification to.
     *
     * @param $id
     * @return $this
     */
    public function attachTo($id)
    {
        $this->attachTo = trim($id);

        return $this;
    }

    /**
     * Get an array representation of the HipChatMessage.
     *
     * @return array
     */
    public function toArray()
    {
        $message = str_array_filter([
            'from' => $this->from,
            'message_format' => $this->format,
            'color' => $this->color,
            'notify' => $this->notify,
            'message' => $this->content,
            'attach_to' => $this->attachTo,
        ]);

        if (! is_null($this->card)) {
            $message['card'] = $this->card->toArray();
        }

        return $message;
    }
}