Download the PHP package cakemanager/cakephp-notifier without Composer

On this page you can find all versions of the php package cakemanager/cakephp-notifier. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package cakephp-notifier

Notifier plugin for CakePHP

Travis Packagist Packagist Gitter

This plugin allows you to integrate a simple notification system into your application.

Installation

You can install this plugin into your CakePHP application using composer.

The recommended way to install this plugin as composer package is:

Now load the plugin via the following command:

After loading the plugin you need to migrate the tables for the plugin using:

Sending notifications

Templates

Before sending any notification, we need to register a template. An example about how to add templates:

When adding a new template, you have to add a title and a body. Both are able to contain variables like :username and :name. Later on we will tell more about these variables.

Notify

Now we will be able to send a new notification using our newBlog template.

Note: You are also able to send notifications via the component: $this->Notifier->notify().

With the notify method we sent a new notification. A list of all attributes:

Recipient Lists

To send notifications to large groups you are able to use RecipientLists. You can register them with:

Now we have created a list of recipients called administrators.

This can be used later on when we send a new notification:

Now, the users 1, 2, 3 and 4 will receive a notification.

Retrieving notifications

Lists

You can easily retrieve notifications via the getNotifications method. Some examples:

Counts

Getting counts of read/unread notifications can be done via the countNotifications method. Some examples:

Mark as read

To mark notifications as read, you can use the markAsRead method. Some examples:

Notification Entity

The following getters can be used at your notifications entity:

Example:

Passing to view

You can do something like this to use the notification list in your view:

Notification Manager

The NotificationManager is the Manager of the plugin. You can get an instance with:

The NotificationManager has the following namespace: Bakkerij\Notifier\Utility\NotificationManager.

The manager has the following methods available:

Notifier Component

The Bakkerij/Notifier.Notifier component can be used in Controllers:

The component has the following methods available:

Keep in touch

If you need some help or got ideas for this plugin, feel free to chat at Gitter.

Pull Requests are always more than welcome!


All versions of cakephp-notifier with dependencies

PHP Build Version
Package Version
Requires php Version >=5.4.16
cakephp/cakephp Version 3.3.*
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package cakemanager/cakephp-notifier contains the following files

Loading the files please wait ....