akanunov/easy-sms-bundle

Integrates easy-sms library to your Symfony project.

v0.0.3 2024-03-24 19:35 UTC

Requires

• php: ^7.0|^8.1
• overtrue/easy-sms: ^1.1
• symfony/framework-bundle: ^3.4|^4.4|^5.4|^6.4

Requires (Dev)

• phpunit/phpunit: ^4.4|^9

MIT

• Oleksandr Kanunov

• bundle
• easy-sms

README

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require akanunov/easy-sms-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project:

// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            // ...
            new Akanunov\EasySmsBundle\AkanunovEasySmsBundle(),
        ];

        // ...
    }

    // ...
}

Step 3: Configure your SMS gateways

# app/config/config.yml
akanunov_easy_sms:
    gateways:
      aliyun:
        access_key_id:        "%aliyun_access_key%"
        access_key_secret:    "%aliyun_key_secret%"
        sign_name:            "%aliyun_sign_name%"
    default:
        gateways: ['aliyun']

For more details on the other parameters, take a look at the Easy SMS documentation.

Step 4: Configure custom SMS gateway

Update configuration file:

# app/config/config.yml
akanunov_easy_sms:
    gateways:
        mygateway:
            api_key: "%mygateway_api_key%"
    default:
        gateways: ['mygateway']
    custom_gateways:  
        mygateway:
          gateway_class: App\EasySms\Gateways\MyGateway
          configuration_factory_class: App\DependencyInjection\Factory\Gateway\MyGatewayFactory

Create gateway configuration factory:

<?php

namespace App\DependencyInjection\Factory\Gateway;

use Akanunov\EasySmsBundle\DependencyInjection\Factory\GatewayFactoryInterface;
use Symfony\Component\Config\Definition\Builder\NodeDefinition;

class MyGatewayFactory implements GatewayFactoryInterface
{
    public function addConfiguration(NodeDefinition $node)
    {
        $node
            ->children()
                ->scalarNode('api_key')
                    ->isRequired()
                    ->cannotBeEmpty()
                ->end()
            ->end()
        ;
    }
}