SMS Framework provides a service for getting phone numbers and sending SMS messages directly to an entity.

Under the hood, the default implementation makes use of Notifier recipients, including field mapping or custom event subscribers.

Phone number service

Autowiring

The recipient service is autowired with Drupal\sms\PhoneNumber\SmsPhoneNumberInterface.

Service example

my_module.services.yml

services:
  _defaults:
    autowire: true
    
  my_service:
    class: Drupal\my_module\MyService

MyService.php

namespace Drupal\my_module;

final class MyService {
  public function __construct(
    private readonly Drupal\sms\PhoneNumber\SmsPhoneNumberInterface $phoneNumber,
  ) {}

  public function myMethod(){
    $this->phoneNumber->send(...);
    $this->phoneNumber->getPhoneNumbers(...);
  }
}

Adding phone numbers for an object

Preferably, phone numbers are added for an object by listening for the Recipients events and producing a SmsRecipient event, see Recipients.

Default implementation

Internally, phone numbers are produced via Notifier recipients in \Drupal\sms\PhoneNumber\EventListener\NotifierRecipients.

An additional event is available if you want to produce phone numbers for objects or entities without involving Notifier or the recipient system:

Event subscriber

my_module.services.yml

services:
  _defaults:
    autoconfigure: true
    autowire: true
    
  Drupal\my_module\EventListener\MyPhoneNumbers: ~

MyPhoneNumbers.php

namespace Drupal\my_module\EventListener;

use Drupal\sms\PhoneNumber\Event\ObjectPhoneNumbers;
use Drupal\notifier\Recipients\Recipient\EmailRecipient;
use Drupal\user\UserInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;

final class MyPhoneNumbers implements EventSubscriberInterface {
  public function onObjectPhoneNumbers(ObjectPhoneNumbers $event): void {
    // $event->for is the object we are producing phone numbers for.
    if ($event->for instanceof SomeCriteria) {
      $event->addPhoneNumber(PhoneNumber::create('+123456789'));
    }
  }

  public static function getSubscribedEvents(): array {
    return [ObjectPhoneNumbers::class => 'onObjectPhoneNumbers'];
  }
}

Event

The event has the following public API surface. See source code for further documentation.

\Drupal\sms\PhoneNumber\Event\ObjectPhoneNumbers {
  public function addPhoneNumber(PhoneNumber $phone_number);
}