Message

Complexity

Total Complexity

7

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

68.18%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	sendMessage()	0	9	1
A	getQueryBuilder()	0	4	1
A	assignResult()	0	11	2
A	getContent()	0	4	1
A	getAuthor()	0	4	1
A	isMessage()	0	4	1

<?php
/**
 * This file contains functionality relating to all of actual messages sent by players
 *
 * @package    BZiON\Models
 * @license    https://github.com/allejo/bzion/blob/master/LICENSE.md GNU General Public License Version 3
 */

/**
 * A message between players or teams
 * @package    BZiON\Models
 */
class Message extends AbstractMessage
{
    /**
     * The ID of the player who sent the message
     * @var int
     */
    protected $player_from;

    /**
     * The content of the message
     * @var string
     */
    protected $message;

    /**
     * {@inheritdoc}
     */
    protected function assignResult($message)
    {
        parent::assignResult($message);

        if ($this->type !== null) {
            throw new Exception("A conversation event cannot be represented by the Message class.");
        }

        $this->player_from = $message['player_from'];
        $this->message = $message['message'];
    }

    /**
     * Get the content of the message
     * @return string The message itself
     */
    public function getContent()
    {
        return $this->message;
    }

    /**
     * Gets the creator of the message
     * @return Player An object representing the message's author
     */
    public function getAuthor()
    {
        return Player::get($this->player_from);
    }

    /**
     * {@inheritdoc}
     */
    public function isMessage()
    {
        return true;
    }

    /**
     * Create a new message
     *
     * This method only stores a message in the database (doesn't update the
     * unread count or push live notifications), prefer to use Conversation::sendMessage()
     * instead.
     *
     * @param  int     $to      The id of the conversation the message is sent to
     * @param  int     $from    The ID of the sender
     * @param  string  $message The body of the message
     * @param  string  $status  The status of the message - can be 'visible', 'hidden', 'deleted' or 'reported'
     * @return Message An object that represents the sent message
     */
    public static function sendMessage($to, $from, $message, $status = 'visible')
    {
        return self::create(array(
            'conversation_to' => $to,
            'player_from'     => $from,
            'message'         => $message,
            'status'          => $status,
        ), 'timestamp');
    }

    /**
     * Get a query builder for messages
     * @return QueryBuilder
     */
    public static function getQueryBuilder()
    {
        return parent::getQueryBuilder()->messagesOnly();
    }
}