massimo-filippi/sms-module

ZF3 module for SMS communication

1.0-beta.1 2017-10-27 15:03 UTC

Requires

• php: ^5.6 || ^7.0
• smsapi.com/php-client: ^1.7

MIT

• Matúš Petrofčík

README

ZF3 module for SMS communication

Introduction

There will be more info soon...

Installation

1. Install via Composer

Install the latest stable version via Composer:

composer require massimo-filippi/sms-module

Install the latest develop version via Composer:

composer require massimo-filippi/sms-module:dev-master

2. Enable module in your application

Composer should enable MassimoFilippi\SmsModule in your project automatically during installation.

In case it does not, you can enable module manually by adding value 'MassimoFilippi\SmsModule' to array in file config/modules.config.php. At the end, it should look like PHP array below.

<?php

return [
    'Zend\Router',
    'Zend\Validator',
    'MassimoFilippi\SmsModule', // Add this line, ideally before Application module.
    'Application',
];

3. Set up your configuration

You have to set settings for SmsService, otherwise you will not be able to use it.

Here is what I have in my config/autoload/local.php file.

Warning: DO NOT set passwords in files that are versioned!

<?php

return [
    'massimo_filippi' => [
        'sms_module' => [
            'adapter' => \MassimoFilippi\SmsModule\Adapter\SmsApiCom\SmsApiComAdapter::class,
            'adapter_params' => [
                'api_username' => 'john.doe',
                'api_password_hash' => '1234567890', // MD5 hash of password in case of SMSApi
            ],
        ],
    ],
];

Usage

Somewhere in business logic classes.

<?php 

use MassimoFilippi\SmsModule\Message\Message as SmsMessage;

$smsMessage = new SmsMessage();

$smsMessage->setTo('00420123456789');
$smsMessage->setText('Hello World!');

try {
    // Injected MassimoFilippi\SmsModule\Service\SmsService.
    $this->smsService->sendSMS($smsMessage);
} catch (\Exception $exception) {
    var_dump($exception->getMessage());
}