Download the PHP package ocuru/notifyme without Composer

Ocuru\Notify

Note: This package is under heavy development and is not recommended for production.

Installing New

Install using Composer.

Installing

Install using Composer.

Available Services

Below are the services we currently support, more will be added over time.

Email Service

Data

Data Format

Twilio Service

Data

Basic Setup

Data Format

Basic Setup

Below is the basic setup you need to run the example code in this document.

Environmental Variables

You need to first set the .env file location using the below code. This is required.

If you haven't already set up your .env file , ocuru/notify installs vlucas/phpdotenv onto the system.

Below is the basic setup of Dotenv where $_ENV['ENV_LOCATION'] is the location of your .env file.

Place the below code before the $Notify variable if setup is needed.

Each service will need a different set some .env variables, these are show below.

Email

======= To set up each service you will need to set some .env variables, these are show below.

Email

Twilio

After Setting .env Variables

In the below example we show you how to setup the services you want to use. You should only run these methods once you have set up all the environmental variables you need shown here. If you don't then an exception will be thrown.

The array can consist of any of the service names shown in the Service ID part of each service List of Services area.

After Setting .env Variables

In the below example we show you how to setup the services you want to use. You should only run these methods once you have set up all the environmental variables you need shown here. If you don't then an exception will be thrown.

The array can consist of any of the service names shown in square brackets in the List of Services area.

The $Notify->start(); method is required for Ocuru\Notify to initialize. However the $Notify->use(); method isn't required but if you run $Notify->start(); without it we will attempt to setup the Email service which is Ocuru\Notify's default service. If no Environmental Variables are found for the Email Service then a exception will be thrown.

Notifying Users

To notify a user you can use the methods shown below. If an error occurs, we will throw an exception.

Below is the first example of how to send a notification, this sends a notification through all services you have set up.

In order to send a notification you will need to make sure all variables needed for each service are set. You can find out how to do this and what variables are required here.

However you can also send via specific services using the same method, all you need to do is pass an array of services as the first parameter. For Example.

The $Notify->start(); method is required for Ocuru\Notify to initialize. However the $Notify->use(); method isn't required but if you run $Notify->start(); without it we will attempt to setup the Email service which is set and Global Default. If no Environmental Variables are found for the Email Service then a exception will be thrown.

Notifying Users

To notify a user you can use the methods shown below.

Below is the first example of how to send a notification, this sends a notification through all services you have set up.

The next example shows you how to send a notification using a specific service. Through the $Notify->notify($data); method.

The final example shows you how to send a notification using the services base Notify Method. For example $Notify->email->notify($data);