nyx\notify\interfaces\Dispatcher

Size/Duplication

Total Lines	20
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
	send()	0	1	?
	sendNow()	0	1	?

<?php namespace nyx\notify\interfaces;

/**
 * Notification Dispatcher Interface
 *
 * @package     Nyx\Notify
 * @version     0.1.0
 * @author      Michal Chojnacki <m.chojnacki@muyo.io>
 * @copyright   2012-2017 Nyx Dev Team
 * @link        https://github.com/unyx/nyx
 */
interface Dispatcher
{
    /**
     * Sends the given Notification to the given entities.
     *
     * @param   array|Notifiable    $notifiables    The entities which shall receive the Notification (single Notifiable
     *                                              or an iterable collection thereof).
     * @param   Notification        $notification   The Notification that shall be sent.
     */
    public function send($notifiables, Notification $notification);

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.

    /**
     * Sends the given Notification synchronously to the given entities.
     *
     * @param   array|Notifiable    $notifiables    The entities which shall receive the Notification (single Notifiable
     *                                              or an iterable collection thereof).
     * @param   Notification        $notification   The Notification that shall be sent.
     */
    public function sendNow($notifiables, Notification $notification);

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.

}