Miliooo\Messaging\Manager\ReadStatusManagerInterface

Size/Duplication

Total Lines	20
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
	updateReadStatusForMessageCollection()	0	5	?

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

use Miliooo\Messaging\Model\MessageInterface;
use Miliooo\Messaging\User\ParticipantInterface;
use Miliooo\Messaging\ValueObjects\ReadStatus;

/**
 * The read status manager is responsible for changing the read statuses of messages.
 *
 * @author Michiel Boeckaert <boeckaert@gmail.com>
 */
interface ReadStatusManagerInterface
{
    /**
     * Updates the read status for a message collection for a given participant.
     *
     * If the old read status equals the new read status no updates happen
     * If the participant is not part of the messageMeta no updates happen
     *
     * @param ReadStatus           $updatedReadStatus The new read status
     * @param ParticipantInterface $participant       The participant for who we update the read status
     * @param MessageInterface[]   $messages          array of messageInterfaces for whom we update the reads status
     *
     * @return MessageInterface[]|[] Array with the updated messages, an empty array if no messages were updated

The doc-type MessageInterface[]|[] could not be parsed: Unknown type name "" at position 19. [(view supported doc-types)

     */
    public function updateReadStatusForMessageCollection(
        ReadStatus $updatedReadStatus,
        ParticipantInterface $participant,
        $messages = []
    );
}