irishdan /
NotificationBundle
| Total Lines | 51 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
| 1 | <?php |
||
| 5 | interface NotifiableInterface |
||
| 6 | { |
||
| 7 | /** |
||
| 8 | * Returns an array of channels the user has subscribed to |
||
| 9 | * |
||
| 10 | * @return array |
||
| 11 | */ |
||
| 12 | public function getSubscribedChannels(); |
||
| 13 | |||
| 14 | /** |
||
| 15 | * returns a boolean based on whether or not the notifiable is subscribed to the given channel |
||
| 16 | * |
||
| 17 | * @param $channel |
||
| 18 | * @return boolean |
||
| 19 | */ |
||
| 20 | public function isSubscribedToChannel($channel); |
||
| 21 | |||
| 22 | /** |
||
| 23 | * Get the entity's notifications. |
||
| 24 | */ |
||
| 25 | // public function notifications(); |
||
|
|
|||
| 26 | |||
| 27 | /** |
||
| 28 | * Get the entity's read notifications. |
||
| 29 | */ |
||
| 30 | // public function readNotifications(); |
||
| 31 | |||
| 32 | /** |
||
| 33 | * Get the entity's unread notifications. |
||
| 34 | */ |
||
| 35 | // public function unreadNotifications(); |
||
| 36 | // @TODO: Not sure if these methods should be here of is they are better as part of a service |
||
| 37 | |||
| 38 | /** |
||
| 39 | * Send the given notification. |
||
| 40 | * |
||
| 41 | * @param mixed $instance |
||
| 42 | * @return void |
||
| 43 | */ |
||
| 44 | // public function notify($instance); |
||
| 45 | |||
| 46 | /** |
||
| 47 | * Returns the credentials needed for a particular user for a particular channel. |
||
| 48 | * Eg if its a personal slack channel etc etc. |
||
| 49 | * For example for the mail channel, the users email should be returned. |
||
| 50 | * |
||
| 51 | * @param string $driver |
||
| 52 | * @return mixed |
||
| 53 | */ |
||
| 54 | // public function getNotifiableDetailsForChannel($driver); |
||
| 55 | } |
Loading history...
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.