Set Up a PHP Dev Environment for PHLO

Using this guide, you can set up a development environment in five minutes to trigger a PHLO.

Install PHP, Composer, Laravel, and the Plivo PHP SDK

To get started, install PHP, the Composer dependency manager, the Laravel web framework, and Plivo’s PHP SDK.

Install PHP

Install Composer

All modern PHP frameworks use the Composer dependency manager; we highly recommend using it as the package manager for your web project. Follow the instructions to download and install Composer for macOS and Linux and for Windows, or follow the steps below.

Install Laravel and create a Laravel project

Install the Laravel web framework by running the command

composer require laravel/installer

Once you have Laravel installed, create a project directory using the command mkdir mylaravelapp, then change to that directory and create a new Laravel project.

  composer create-project laravel/laravel quickstart --prefer-dist

This command creates a directory named quickstart with the necessary folders and files for development.

Install the PHP Plivo SDK

To install the stable release of the Plivo SDK, run this command in the project directory:

composer require plivo/plivo-php

To install a specific release, run this command in the project directory:

composer require plivo/plivo-php:4.15.0

Alternatively, you can download source code from GitHub and run

composer install

The composer command generates the autoload files, which you can include in your PHP source code by using the line

<?php
require 'vendor/autoload.php'

Trigger the PHLO

Create and configure a PHLO, then integrate the PHLO into your application workflow by making an API request to trigger the PHLO with the required payload.

You can run a PHLO with static payload values by entering specific values in fields like from and to on the PHLO console.

To deliver a dynamic payload instead of a static one, define the payload keys as Liquid templates on the PHLO console and pass the values at runtime.

Create a Laravel Controller

Change the directory to the project directory and run this command to create a Laravel controller named PhloController in the app/http/controllers/ directory.

php artisan make:controller PhloController

Edit app/http/controllers/phloController.php and paste into it the code below for either a static or dynamic payload.

Static payload

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<?php
namespace App\Http\Controllers;
require '../../vendor/autoload.php';
use Plivo\Resources\PHLO\PhloRestClient;
use Plivo\Exceptions\PlivoRestException;

class PhloController extends Controller
{
    public function triggerPhlo()
    {
        $client = new PhloRestClient("<auth_id>", "<auth_token>");
        $phlo = $client->phlo->get("<phlo_id>");
        try {
            $response = $phlo->run(["from" => "<Caller_ID>", "to" => "<Destination_Number>"]); // These are the fields entered in the PHLO console
            echo json_encode($response);
        } catch (PlivoRestException $ex) {
            echo json_encode($ex);
        }
    }
}

Dynamic payload

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<?php
namespace App\Http\Controllers;
require '../../vendor/autoload.php';
use Plivo\Resources\PHLO\PhloRestClient;
use Plivo\Exceptions\PlivoRestException;

class PhloController extends Controller
{
    public function triggerPhlo()
    {
        $client = new PhloRestClient("<auth_id>", "<auth_token>");
        $phlo = $client->phlo->get("<phlo_id>");
        try {
            $response = $phlo->run();
            echo json_encode($response);
        } catch (PlivoRestException $ex) {
            echo json_encode($ex);
        }
    }
}

Add a route

To add a route for the outbound function in the PhloController class, edit routes/web.php and add this line at the end of the file:

Route::match(['get', 'post'], '/triggerphlo', 'PhloController@triggerPhlo');

Route::match(['get', 'post'], '/triggerphlo', 'App\Http\Controllers\PhloController@triggerPhlo');

Save the file and run it.

php artisan serve

Your local development server will be started and you can test the Laravel application via the URL http://localhost:8000/triggerphlo/.