nyx\notify\interfaces\Notifiable

Size/Duplication

Total Lines	19
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
	notify()	0	1	?
	routeNotification()	0	1	?

<?php namespace nyx\notify\interfaces;

/**
 * Notifiable 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 Notifiable
{
    /**
     * Notifies the underlying entity with the given Notification.
     *
     * @param   Notification $notification
     */
    public function notify(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.

    /**
     * Returns data necessary for the specified Transport to route a constructed notification message
     * to the underlying entity, granting the Notifiable the ability to modify the message before delivery.
     *
     * @param   string  $transport  The name of the Transport to return metadata for.
     * @param   object  $message    The notification message being routed.
     * @return  mixed
     */
    public function routeNotification(string $transport, $message);
}