nnrudakov/yii2-sms

Send SMS via different services in Yii2.

Yii2 SMS

Yii2 extension to send SMS via different services., _(*1)

For license information check the LICENSE-file., _(*2)

, _(*3)

Requirements

• PHP >= 8.1 (use v1.3.1 if you need PHP earlier 8.0)
• Yii2 >= 2.0.41

Installation

The preferred way to install this extension is through composer., _(*4)

Either run, _(*5)

composer require --prefer-dist nnrudakov/yii2-sms

or add, _(*6)

"nnrudakov/yii2-sms": "^2.0"

to the require section of your composer.json file., _(*7)

Configuration

Add the following in your config:, _(*8)

...
    'components' => [
        'sms' => [
            'class' => nnrudakov\sms\Sms::class,
                'services' => [
                    'beeline' => [
                        'class'    => nnrudakov\sms\services\beeline\Beeline::class,
                        'user'     => '',
                        'password' => ''
                    ]
                ]
        ],
        ...
    ],
...

You can override message translations:, _(*9)

...
    'components' => [
        'i18n' => [
            'translations' => [
                'sms' => [ // must be the same name
                    'class'            => yii\i18n\PhpMessageSource::class,
                    'basePath'         => '@app/messages',
                    'sourceLanguage'   => 'ru',
                    'forceTranslation' => true
                ],
            ],
        ],
        ...
    ],
...

As an example full list messages you can find in russian message file., _(*10)

Usage

Once the extension is installed, simply use it in your code by:, _(*11)

 $service = Yii::$app->sms->getService('beeline');
 $service->send(['+7905XXXXXXX'], 'message');
 ```

Extension may throw exceptions in critical situations or fill up internal erorrs list. 
You can checkout errors by:

```php
 $service->hasErrors();
 ```

To get full errors list just call:

```php
 $service->getErrors();
 ```

To get error for certain phone number add number as parameter:

```php
 $service->getErrors('+7905XXXXXXX');
 ```

Services
--------

Extension implements these services:
* _Beeline_. Signed contract and credentials to [account](https://beeline.amega-inform.ru/) are required. You should
paste credentials in service config:

```php
...
    'beeline' => [
        'class'    => nnrudakov\sms\services\beeline\Beeline::class,
        'user'     => 'beeline_user',
        'password' => 'beeline_password'
    ]
...

Tests

For tests uses Codeception., _(*12)

vendor/bin/codecept run unit