whatson-web/messagebird-bundle

Symfony bundle to easily integrate MessageBird SDK into a Symfony project.

dev-master 2018-09-28 09:48 UTC

This package is not auto-updated.

Last update: 2022-06-25 17:11:41 UTC


README

A symfony integration for the MessageBird PHP SDK

This bundle allow you to manipulate the MessageBird SDK as a Symfony service.

Installation

To install this bundle, run the command below and you will get the latest version from Packagist.

composer require whatson-web/messagebird-bundle

Load required bundles in AppKernel.php:

// app/AppKernel.php
public function registerBundles()
{
    $bundles = array(
        // [...]
        new WH\Bundle\MessageBirdBundle\WHMessageBirdBundle()
    );
}

And set-up the required configuration

# config/packages/wh_message_bird.yml
wh_message_bird:
    api_key: "xxxxxxxxxxxxxxxxx" # The MessageBird API key can be added as a symfony parameter

Usage

Then, it is possible to use this service from inside a controller

$messageBirdClient = $this->get('wh.message_bird.client');

The MessageBirdClient php class extends the default MessageBird PHP SDK class, allowing you to do anything that this SDK can do. Plus, it will automatically be authenticated with your MessageBird API Key, which you do not have to worry about at all.