Miliooo / MilioooMessageBundle

Messaging/Model/ThreadMetaInterface.php

<?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\Model;

use Miliooo\Messaging\User\ParticipantInterface;

/**
 * The interface for the threadmeta class
 *
 * @author Michiel Boeckaert <boeckaert@gmail.com>
 */
interface ThreadMetaInterface extends BuilderInterface
{
    const STATUS_ACTIVE = 1;
    const STATUS_ARCHIVED = 2;

    /**
     * Gets the unique id of the thread meta
     *
     * @return integer
     */
    public function getId();

    /**
     * Gets the participant of the thread meta
     *
     * @return ParticipantInterface
     */
    public function getParticipant();

    /**
     * Sets the participant of the thread meta
     *
     * @param ParticipantInterface $participant The participant
     */
    public function setParticipant(ParticipantInterface $participant);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * Sets the thread for this thread meta
     *
     * @param ThreadInterface $thread The thread this meta belongs to
     */
    public function setThread(ThreadInterface $thread);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * Gets the thread for this thread meta
     *
     * @return ThreadInterface the thread this meta belongs to
     */
    public function getThread();

    /**
     * Gets the status of the given thread for the participant of the threadMeta.
     *
     * @return integer one of the status constants
     */
    public function getStatus();

    /**
     * Sets the status of the thread for the given participant.
     *
     * @param integer $status
     */
    public function setStatus($status);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * Gets the datetime when the participant has written his last message for
     * the given thread
     *
     * @return \DateTime
     */
    public function getLastParticipantMessageDate();

    /**
     * Sets the datetime when the participant has written his last message for the given thread
     *
     * @param \DateTime $dateTime DateTime of participant's last message
     */
    public function setLastParticipantMessageDate(\DateTime $dateTime);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * Gets the date time of the last message written by another participant
     *
     * @return \DateTime datetime of the last message written by another participant
     */
    public function getLastMessageDate();

    /**
     * Sets the date of the last message written by another participant
     *
     * @param \DateTime $lastMessageDate datetime of the last message by another participant
     */
    public function setLastMessageDate(\DateTime $lastMessageDate);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * Gets the number of unread messages for the participant from the given thread.
     *
     * @return integer The number of unread messages from the thread for the given participant
     */
    public function getUnreadMessageCount();

    /**
     * Sets the number of unread messages for the participant from the given thread.
     *
     * @param integer $unreadCount The number of unread messages from the thread for the given participant
     */
    public function setUnreadMessageCount($unreadCount);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

}