fenos/notifynder

Management system of internal notifications for Laravel 5.*

Installs: 1 939

Dependents: 0

Stars: 109

Watchers: 19

Forks: 24

Open Issues: 1

Language: PHP

3.0.7 2015-07-02 19:59 UTC

README

Build Status ProjectStatus Scrutinizer Code Quality Total Downloads License Latest Stable Version

Notifynder is designed to manage notifications in a powerful and easy way. With the flexibility that Notifynder offer, It provide a complete API to work with your notifications, such as storing, retriving, and organise your codebase to handle hundreds of notifications. You get started in a couple of minutes to "enable" notifications in your Laravel Project.

Compatible DBs: MySql - PostgresSql - Sqlite

Documentation: Notifynder Wiki

Installation

Step 1

Add it on your composer.json

"fenos/notifynder": "3.*"

and run composer update

Step 2

Add the following string to config/app.php

Providers array:

'Fenos\Notifynder\NotifynderServiceProvider'

Aliases array:

'Notifynder'    => 'Fenos\Notifynder\Facades\Notifynder'

Step 3

Migration

Publish the migration as well as the configuration of notifynder with the following command:

php artisan vendor:publish --provider="Fenos\Notifynder\NotifynderServiceProvider"

Don't forget to migrate.

Quick Usage

Set up category of notification, think about it as the body of the notification:

php artisan notifynder:create:category "user.following" "{from.username} started to follow you"

To send a notification with notifynder, that's all you have to do.

Notifynder::category('user.following')
            ->from($from_user_id)
            ->to($to_user_id)
            ->url('http://www.yourwebsite.com/page')
            ->send();

Retrieving Notifications

// @return Collection
Notifynder::getAll($user_id,$limit,$paginateBool);

Reading Notifications:

// @return number of notifications read
Notifynder::ReadAll($user_id);

To know more, such as the advance usage of Notifynder Visit the Notifynder Wiki.