README

Yii2 SMS Sender

Setup

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist matperez/yii2-sms-sender

or add

"matperez/yii2-sms-sender": "*"

to the require section of your composer.json file.

Dev environment

'components' = [
  'sms' => [
    'viewPath' => '@app/sms',
    'class' => \matperez\yii2smssender\components\Sender::class,
    'transportConfig' => [
      'class' => \matperez\yii2smssender\transports\FileTransport::class, 
    ],
  ],
],

Production environment

Using https://integrationapi.net

'components' = [
  'sms' => [
    'viewPath' => '@app/sms',
    'class' => \matperez\yii2smssender\components\Sender::class,
    'transportConfig' => [
      'class' => \matperez\yii2smssender\transports\IntegrationApiTransport::class,
      'login' => 'login',
      'password' => 'password',
    ],
  ],
],

Place this somewhere in a bootstrap file

\Yii::$container->set(\GuzzleHttp\ClientInterface::class, function() {
  return new \GuzzleHttp\Client();
});

Usage

Composing a message

The message can be composed from a template. The template name could be relative to viewPath or it could be a full path to a the view. Yii aliases are acceptable.

$message = Yii::$app->sms->compose('template_name', $params);
$message = Yii::$app->sms->compose('@app/sms/template_name', $params);

It is also possible to compose an empty message when no view name provided

$message = Yii::$app->sms->compose();

Middleware

The message can be preprocessed prior to sending. For example log or modify its content. Middleware should be set as an array of callable.

'components' = [
  'sms' => [
      'class' => \matperez\yii2smssender\components\Sender::class,
      'middleware' => [
          function(\matperez\yii2smssender\interfaces\IMessage $message) {
              $message->setMessage('new message content');
          }
      ]
  ],
],

Sending a message

$message = Yii::$app->sms->compose('some-view', $params);
$message->setTo('1234345456');
$message->setFrom('sender');
$message->send();

Balance checking

if (Yii::$app->sms->canFetchBalance()) {
  $balance = Yii::$app->sms->getBalance();
}