Maknz\Slack\Message

Complexity

Total Complexity

37

Size/Duplication

Total Lines	456
Duplicated Lines	0 %

Coupling/Cohesion

Components	7
Dependencies	2

Importance

Changes	3
Bugs	1	Features	2

27 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getText()	0	4	1
A	setText()	0	6	1
A	getEndpoint()	0	4	1
A	setEndpoint()	0	10	3
A	getChannel()	0	4	1
A	setChannel()	0	6	1
A	getUsername()	0	4	1
A	setUsername()	0	6	1
A	getIcon()	0	4	1
B	setIcon()	0	23	4
A	getIconType()	0	4	1
A	getAllowMarkdown()	0	4	1
A	setAllowMarkdown()	0	6	1
A	enableMarkdown()	0	6	1
A	disableMarkdown()	0	6	1
A	getMarkdownInAttachments()	0	4	1
A	setMarkdownInAttachments()	0	6	1
A	from()	0	6	1
A	endpoint()	0	4	1
A	to()	0	6	1
A	withIcon()	0	6	1
B	attach()	0	25	4
A	getAttachments()	0	4	1
A	setAttachments()	0	11	2
A	clearAttachments()	0	6	1
A	send()	0	6	2

<?php namespace Maknz\Slack;

use InvalidArgumentException;

class Message {

  /**
   * Reference to the Slack client responsible for sending
   * the message
   *
   * @var \Maknz\Slack\Client
   */
  protected $client;

  /**
   * The text to send with the message
   *
   * @var string
   */
  protected $text;

  /**
   * The target endpoint the message should be sent to
   *
   * @var string
   */
  protected $endpoint;
  
  /**
   * The channel the message should be sent to
   *
   * @var string
   */
  protected $channel;

  /**
   * The username the message should be sent as
   *
   * @var string
   */
  protected $username;

  /**
   * The URL to the icon to use
   *
   * @var string
   */
  protected $icon;

  /**
   * The type of icon we are using
   *
   * @var enum
   */
  protected $iconType;

  /**
   * Whether the message text should be interpreted in Slack's
   * Markdown-like language
   *
   * @var boolean
   */
  protected $allow_markdown = true;

  /**
   * The attachment fields which should be formatted with
   * Slack's Markdown-like language
   *
   * @var array
   */
  protected $markdown_in_attachments = [];

  /**
   * An array of attachments to send
   *
   * @var array
   */
  protected $attachments = [];

  /**
   *
   * @var string
   */
  const ICON_TYPE_URL = 'icon_url';

  /**
   *
   * @var string
   */
  const ICON_TYPE_EMOJI = 'icon_emoji';

  /**
   * Instantiate a new Message
   *
   * @param \Maknz\Slack\Client $client
   * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

   */
  public function __construct(Client $client)
  {
    $this->client = $client;
  }

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

  /**
   * Set the message text
   *
   * @param string $text
   * @return $this
   */
  public function setText($text)
  {
    $this->text = $text;

    return $this;
  }

   /**
   * Get the message endpoint
   *
   * @return string
   */
  public function getEndpoint()
  {
    return $this->endpoint;
  }

  /**
   * Set the message endpoint
   *
   * @param string $endpoint
   * @return $this
   * @throws \InvalidArgumentException
   */
  public function setEndpoint($endpoint)
  {
    if(empty($endpoint) || !is_string($endpoint)) {
          throw new InvalidArgumentException('The message endpoint must be a non-empty string');
    }
    
    $this->endpoint = $endpoint;

    return $this;
  }
  
  /**
   * Get the channel we will post to
   *
   * @return string
   */
  public function getChannel()
  {
    return $this->channel;
  }

  /**
   * Set the channel we will post to
   *
   * @param string $channel
   * @return $this
   */
  public function setChannel($channel)
  {
    $this->channel = $channel;

    return $this;
  }

  /**
   * Get the username we will post as
   *
   * @return string
   */
  public function getUsername()
  {
    return $this->username;
  }

  /**
   * Set the username we will post as
   *
   * @param string $username
   * @return $this
   */
  public function setUsername($username)
  {
    $this->username = $username;

    return $this;
  }

  /**
   * Get the icon (either URL or emoji) we will post as
   *
   * @return string
   */
  public function getIcon()
  {
    return $this->icon;
  }

  /**
   * Set the icon (either URL or emoji) we will post as.
   *
   * @param string $icon
   * @return this
   */
  public function setIcon($icon)
  {
    if ($icon == null)
    {
      $this->icon = $this->iconType = null;

      return;
    }

    if (mb_substr($icon, 0, 1) == ":" && mb_substr($icon, mb_strlen($icon) - 1, 1) == ":")
    {
      $this->iconType = self::ICON_TYPE_EMOJI;

It seems like self::ICON_TYPE_EMOJI of type string is incompatible with the declared type object<Maknz\Slack\enum> of property $iconType.

    }

    else
    {
      $this->iconType = self::ICON_TYPE_URL;

It seems like self::ICON_TYPE_URL of type string is incompatible with the declared type object<Maknz\Slack\enum> of property $iconType.

    }

    $this->icon = $icon;

    return $this;
  }

  /**
   * Get the icon type being used, if an icon is set
   *
   * @return string
   */
  public function getIconType()
  {
    return $this->iconType;
  }

  /**
   * Get whether message text should be formatted with
   * Slack's Markdown-like language
   *
   * @return boolean
   */
  public function getAllowMarkdown()
  {
    return $this->allow_markdown;
  }

  /**
   * Set whether message text should be formatted with
   * Slack's Markdown-like language
   *
   * @param boolean $value
   * @return void
   */
  public function setAllowMarkdown($value)
  {
    $this->allow_markdown = (boolean) $value;

    return $this;
  }

  /**
   * Enable Markdown formatting for the message
   *
   * @return void
   */
  public function enableMarkdown()
  {
    $this->setAllowMarkdown(true);

    return $this;
  }

  /**
   * Disable Markdown formatting for the message
   *
   * @return void
   */
  public function disableMarkdown()
  {
    $this->setAllowMarkdown(false);

    return $this;
  }

  /**
   * Get the attachment fields which should be formatted
   * in Slack's Markdown-like language
   *
   * @return array
   */
  public function getMarkdownInAttachments()
  {
    return $this->markdown_in_attachments;
  }

  /**
   * Set the attachment fields which should be formatted
   * in Slack's Markdown-like language
   *
   * @param array $fields
   * @return void
   */
  public function setMarkdownInAttachments(array $fields)
  {
    $this->markdown_in_attachments = $fields;

    return $this;
  }

  /**
   * Change the name of the user the post will be made as
   *
   * @param string $username
   * @return $this
   */
  public function from($username)
  {
    $this->setUsername($username);

    return $this;
  }

  /**
   * Change the endpoint the post will be made to
   *
   * @param string $endpoint
   * @return $this
   */
  public function endpoint($endpoint)
  {
      return $this->setEndpoint($endpoint);
  }
  
  /**
   * Change the channel the post will be made to
   *
   * @param string $channel
   * @return $this
   */
  public function to($channel)
  {
    $this->setChannel($channel);

    return $this;
  }

  /**
   * Chainable method for setting the icon
   *
   * @param string $icon
   * @return $this
   */
  public function withIcon($icon)
  {
    $this->setIcon($icon);

    return $this;
  }

  /**
   * Add an attachment to the message
   *
   * @param mixed $attachment
   * @return $this
   * @throws \InvalidArgumentException
   */
  public function attach($attachment)
  {
    if ($attachment instanceof Attachment)
    {
      $this->attachments[] = $attachment;

      return $this;
    }

    elseif (is_array($attachment))
    {
      $attachmentObject = new Attachment($attachment);

      if ( ! isset($attachment['mrkdwn_in']))
      {
        $attachmentObject->setMarkdownFields($this->getMarkdownInAttachments());
      }

      $this->attachments[] = $attachmentObject;

      return $this;
    }

    throw new InvalidArgumentException('Attachment must be an instance of Maknz\\Slack\\Attachment or a keyed array');
  }

  /**
   * Get the attachments for the message
   *
   * @return array
   */
  public function getAttachments()
  {
    return $this->attachments;
  }

  /**
   * Set the attachments for the message
   *
   * @param string $attachments
   * @return $this
   */
  public function setAttachments(array $attachments)
  {
    $this->clearAttachments();

    foreach ($attachments as $attachment)
    {
      $this->attach($attachment);
    }

    return $this;
  }

  /**
   * Remove all attachments for the message
   *
   * @return $this
   */
  public function clearAttachments()
  {
    $this->attachments = [];

    return $this;
  }

  /**
   * Send the message
   *
   * @param string $text The text to send
   * @return void
   */
  public function send($text = null)
  {
    if ($text) $this->setText($text);

The expression $text of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

    
    $this->client->sendMessage($this);
  }

}