vendor/symfony/notifier/Notifier.php line 36

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Notifier;
  14. use Psr\Container\ContainerInterface;
  15. use Symfony\Component\Notifier\Channel\ChannelInterface;
  16. use Symfony\Component\Notifier\Channel\ChannelPolicy;
  17. use Symfony\Component\Notifier\Channel\ChannelPolicyInterface;
  18. use Symfony\Component\Notifier\Channel\SmsChannel;
  19. use Symfony\Component\Notifier\Exception\LogicException;
  20. use Symfony\Component\Notifier\Notification\Notification;
  21. use Symfony\Component\Notifier\Recipient\NoRecipient;
  22. use Symfony\Component\Notifier\Recipient\RecipientInterface;
  24. /**
  25.  * @author Fabien Potencier <fabien@symfony.com>
  26.  */
  27. final class Notifier implements NotifierInterface
  28. {
  29.     private array $adminRecipients = [];
  30.     private array|ContainerInterface $channels;
  31.     private ?ChannelPolicyInterface $policy;
  33.     /**
  34.      * @param ChannelInterface[]|ContainerInterface $channels
  35.      */
  36.     public function __construct(array|ContainerInterface $channels, ChannelPolicyInterface $policy = null)
  37.     {
  38.         $this->channels = $channels;
  39.         $this->policy = $policy;
  40.     }
  42.     public function send(Notification $notification, RecipientInterface ...$recipients): void
  43.     {
  44.         if (!$recipients) {
  45.             $recipients = [new NoRecipient()];
  46.         }
  48.         foreach ($recipients as $recipient) {
  49.             foreach ($this->getChannels($notification, $recipient) as $channel => $transportName) {
  50.                 $channel->notify($notification, $recipient, $transportName);
  51.             }
  52.         }
  53.     }
  55.     public function addAdminRecipient(RecipientInterface $recipient): void
  56.     {
  57.         $this->adminRecipients[] = $recipient;
  58.     }
  60.     /**
  61.      * @return RecipientInterface[]
  62.      */
  63.     public function getAdminRecipients(): array
  64.     {
  65.         return $this->adminRecipients;
  66.     }
  68.     /**
  69.      * @return iterable<ChannelInterface, string|null>
  70.      */
  71.     private function getChannels(Notification $notification, RecipientInterface $recipient): iterable
  72.     {
  73.         $channels = $notification->getChannels($recipient);
  74.         if (!$channels) {
  75.             $errorPrefix = sprintf('Unable to determine which channels to use to send the "%s" notification', $notification::class);
  76.             $error = 'you should either pass channels in the constructor, override its "getChannels()" method';
  77.             if (null === $this->policy) {
  78.                 throw new LogicException(sprintf('%s; %s, or configure a "%s".', $errorPrefix, $error, ChannelPolicy::class));
  79.             }
  80.             if (!$channels = $this->policy->getChannels($notification->getImportance())) {
  81.                 throw new LogicException(sprintf('%s; the "%s" returns no channels for importance "%s"; %s.', $errorPrefix, ChannelPolicy::class, $notification->getImportance(), $error));
  82.             }
  83.         }
  85.         foreach ($channels as $channelName) {
  86.             $transportName = null;
  87.             if (false !== $pos = strpos($channelName, '/')) {
  88.                 $transportName = substr($channelName, $pos + 1);
  89.                 $channelName = substr($channelName, 0, $pos);
  90.             }
  92.             if (null === $channel = $this->getChannel($channelName)) {
  93.                 throw new LogicException(sprintf('The "%s" channel does not exist.', $channelName));
  94.             }
  96.             if ($channel instanceof SmsChannel && $recipient instanceof NoRecipient) {
  97.                 throw new LogicException(sprintf('The "%s" channel needs a Recipient.', $channelName));
  98.             }
  100.             if (!$channel->supports($notification, $recipient)) {
  101.                 throw new LogicException(sprintf('The "%s" channel is not supported.', $channelName));
  102.             }
  104.             yield $channel => $transportName;
  105.         }
  106.     }
  108.     private function getChannel(string $name): ?ChannelInterface
  109.     {
  110.         if ($this->channels instanceof ContainerInterface) {
  111.             return $this->channels->has($name) ? $this->channels->get($name) : null;
  112.         }
  114.         return $this->channels[$name] ?? null;
  115.     }
  116. }