Download the PHP package xelax90/zf-user-notification without Composer

On this page you can find all versions of the php package xelax90/zf-user-notification. 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 zf-user-notification

User notification module

This module provides an event-driven and simple user notification system.

Installation

Installation of XelaxUserNotification uses composer. For composer documentation, please refer to getcomposer.org.

Then add XelaxUserNotification to your config/application.config.php and run the doctrine schema update to create the database table:

Now copy the provided configuration files vendor/xelax90/zf-user-notification/config/xelax-user-notification.global.php and vendor/xelax90/zf-user-notification/config/xelax-user-notification.local.php.dist into your config/autoload directory. Also make another copy of the xelax-user-notification.local.php.dist file without the .dist extension.

Configuration

To send notifications via E-Mail please enter your mailserver configuration in the config/autoload/xelax-user-module.local.php file.

You can use the global configuration in config/autoload/xelax-user-module.global.php to modify E-Mail templates and other global settings. Every setting is documented inside the configuration file.

Sending notifications

To send a notification, get an instance of the XelaxUserNotification\Service\Notification Service from the Service Manager and call one of the functions sendSystemNotification (For system-to-user notifications), sendUserNotification (For user-to-user notifications). These functions create an instance of NotificationInterface and trigger the corresponding event such that any notification handler can handle the created notification. To send custom events and notifications, use the sendNotification Method.

Handling notifications

To handle a notification, simply create an event listener that listens to events from the XelaxUserNotification\Service\Notification class. There are two default events, namely Notification::EVENT_SYSTEM_NOTIFICATION and Notification::EVENT_USER_NOTIFICATION for the two different notification types. There are some default notification handlers that you should maybe look at before implementing additional logic.

Render And Mail Handler

The RenderAndMailHandler uses a templte engine to render a notification and then sends it to the receiver using a mail transport. By default it uses the Zend\View\Renderer\PhpRenderer template engine and the Zend\Mail\Transport\TransportInterface service as transport. The transport service can be registered using the xelax90/zf-mail-config module.

You can configure the templates within your application or module config. There is some documentation provided in the global configuration file. The configured e-mail templates will be passed through the MvcTranslator to obtain localized template names which are then passed to the template engine (see language/en_US.php and language/de_DE.php).

All versions of zf-user-notification with dependencies

PHP Build Version
Package Version
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 xelax90/zf-user-notification contains the following files

Loading the files please wait ....