Miliooo\Messaging\Manager\CanMessageRecipientManagerInterface

Size/Duplication

Total Lines	14
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
	canMessageRecipient()	0	1	?
	getErrorMessage()	0	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\Manager;

use Miliooo\Messaging\User\ParticipantInterface;

/**
 * The can message recipient manager is responsible for deciding whether the current user can message the recipient.
 *
 * @author Michiel Boeckaert <boeckaert@gmail.com>
 */
interface CanMessageRecipientManagerInterface
{
    /**
     * Decides whether the logged in user can send a message to the recipient.
     *
     * @param ParticipantInterface $loggedInUser The logged in user
     * @param ParticipantInterface $recipient    The recipient we check
     *
     * @return boolean true if the loggedInUser can send a message to the recipient, false otherwise.
     */
    public function canMessageRecipient(ParticipantInterface $loggedInUser, ParticipantInterface $recipient);

function canMessageRecipient() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    public function getErrorMessage();

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.

}