Download the PHP package nexmo/laravel without Composer

THIS PACKAGE IS DEPRECATED We have moved to: https://github.com/Vonage/vonage-laravel, so please raise any new issues or Pull Requests in this repository.

Nexmo Package for Laravel

Introduction

This is a simple Laravel Service Provider providing access to the Nexmo PHP Client Library.

Installation

To install the PHP client library using Composer:

Alternatively, add these two lines to your composer require section:

Laravel 5.5+

If you're using Laravel 5.5 or above, the package will automatically register the Nexmo provider and facade.

Laravel 5.4 and below

Add Nexmo\Laravel\NexmoServiceProvider to the providers array in your config/app.php:

If you want to use the facade interface, you can use the facade class when needed:

Or add an alias in your config/app.php:

Using Nexmo-Laravel with Lumen

Nexmo-Laravel works with Lumen too! You'll need to do a little work by hand to get it up and running. First, install the package using composer:

Next, we have to tell Lumen that our library exists. Update bootstrap/app.php and register the NexmoServiceProvider:

Finally, we need to configure the library. Unfortunately Lumen doesn't support auto-publishing files so you'll have to create the config file yourself by creating a config directory and copying the config file out of the package in to your project:

At this point, set NEXMO_KEY and NEXMO_SECRET in your .env file and it should be working for you. You can test this with the following route:

Dealing with Guzzle Client issues

By default, this package uses nexmo/client, which includes a Guzzle adapter for accessing the API. Some other libraries supply their own Guzzle adapter, leading to composer not being able to resolve a list of dependencies. You may get an error when adding nexmo/laravel to your application because of this.

The Nexmo client allows you to override the HTTP adapter that is being used. This takes a bit more configuration, but this package allows you to use nexmo/client-core to supply your own HTTP adapter.

To do this:

1. composer require nexmo/client-core to install the Core SDK
2. Install your own httplug-compatible adapter. For example, to use Symfony's HTTP Client:
   1. composer require symfony/http-client php-http/message-factory php-http/httplug nyholm/psr7
3. composer require nexmo/laravel to install this package

4. In your .env file, add the following configuration:

   NEXMO_HTTP_CLIENT="Symfony\\Component\\HttpClient\\HttplugClient"

You can now pull the Nexmo\Client object from the Laravel Service Container, or use the Facade provided by this package.

Configuration

You can use artisan vendor:publish to copy the distribution configuration file to your app's config directory:

Then update config/nexmo.php with your credentials. Alternatively, you can update your .env file with the following:

Optionally, you could also set an application_id and private_key if required:

Private keys can either be a path to a file, like above, or the string of the key itself:

Usage

To use the Nexmo Client Library you can use the facade, or request the instance from the service container:

Or

If you're using private key authentication, try making a voice call:

For more information on using the Nexmo client library, see the official client library repository.