Miliooo\Messaging\Event\ReadStatusMessageEvent

Complexity

Total Complexity

9

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getMessage()	0	4	1
A	getThread()	0	4	1
A	getPreviousReadStatus()	0	4	1
A	getReadStatus()	0	4	1
A	isFirstTimeRead()	0	10	3
A	getParticipant()	0	4	1

<?php

/*
 * This file is part of the MilioooMessageBundle package.
 *
 * (c) Michiel boeckaert <boeckaert@gmail.com>
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Miliooo\Messaging\Event;

use Miliooo\Messaging\Model\MessageInterface;
use Miliooo\Messaging\Model\MessageMetaInterface;
use Miliooo\Messaging\User\ParticipantInterface;
use Miliooo\Messaging\Model\ThreadInterface;
use Symfony\Component\EventDispatcher\Event;

/**
 * Model for messages from whom the read status has changed.
 *
 * @author Michiel Boeckaert <boeckaert@gmail.com>
 */
class ReadStatusMessageEvent extends Event
{
    /**
     * The message from whom the read status has changed.
     *
     * @var MessageInterface
     */
    protected $message;

    /**
     * The participant from whom the read status has changed.
     *
     * @var ParticipantInterface
     */
    protected $participant;

    /**
     * Constructor.
     *
     * @param MessageInterface     $message
     * @param ParticipantInterface $participant
     */
    public function __construct(MessageInterface $message, ParticipantInterface $participant)
    {
        $this->message = $message;
        $this->participant = $participant;
    }

    /**
     * Gets the message where the read status has changed.
     *
     * @return MessageInterface
     */
    public function getMessage()
    {
        return $this->message;
    }

    /**
     * Gets the thread for the given message.
     *
     * @return ThreadInterface
     */
    public function getThread()
    {
        return $this->message->getThread();
    }

    /**
     * Gets the old read status.
     *
     * @return integer one of MessageInterface read status constants
     */
    public function getPreviousReadStatus()
    {
        return $this->message->getMessageMetaForParticipant($this->participant)->getPreviousReadStatus();
    }

    /**
     * Gets the new read status.
     *
     * @return integer one of MessageInterface read status constants
     */
    public function getReadStatus()
    {
        return $this->message->getMessageMetaForParticipant($this->participant)->getReadStatus();
    }

    /**
     * Returns whether the message has been read for the first time by the given participant.
     *
     * @return boolean true if read for the first time, false otherwise
     */
    public function isFirstTimeRead()
    {
        if ($this->getPreviousReadStatus() === MessageMetaInterface::READ_STATUS_NEVER_READ

This if statement, and the following return statement can be replaced with return $this->getPreviousReadStatus() === \Miliooo\Messaging\Model\MessageMetaInterface::READ_STATUS_NEVER_READ && $this->getReadStatus() === \Miliooo\Messaging\Model\MessageMetaInterface::READ_STATUS_READ;.

            && $this->getReadStatus() === MessageMetaInterface::READ_STATUS_READ) {

Blank line found at start of control structure

            return true;
        }

        return false;
    }

    /**
     * Gets the participant for whom the read status of the message has changed.
     *
     * @return ParticipantInterface The participant for whom the message read status has changed.
     */
    public function getParticipant()
    {
        return $this->participant;
    }
}