class RouteSubscriber in SMS Framework 2.x

Subscriber for SMS Framework routes.

Hierarchy

• class \Drupal\sms\Routing\RouteSubscriber implements ContainerInjectionInterface

File

src/Routing/RouteSubscriber.php, line 17

Namespace

Drupal\sms\Routing

class RouteSubscriber implements ContainerInjectionInterface {

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Constructs a new SMS Framework RouteSubscriber.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The gateway manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory) {
    $this->configFactory = $config_factory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'));
  }

  /**
   * Returns a set of route objects.
   *
   * @return \Symfony\Component\Routing\RouteCollection
   *   A route collection.
   */
  public function routes() {
    $sms_settings = $this->configFactory
      ->get('sms.settings');
    $collection = new RouteCollection();

    // Phone number verification.
    $path_verify = $sms_settings
      ->get('page.verify');

    // String length must include at least a slash + another character.
    if (isset($path_verify) && mb_strlen($path_verify) >= 2) {
      $collection
        ->add('sms.phone.verify', new Route($path_verify, [
        '_form' => '\\Drupal\\sms\\Form\\VerifyPhoneNumberForm',
        '_title' => 'Verify a phone number',
      ], [
        '_permission' => 'sms verify phone number',
      ]));
    }

    /** @var \Drupal\sms\Entity\SmsGatewayInterface $gateway */
    foreach (SmsGateway::loadMultiple() as $id => $gateway) {
      if ($gateway
        ->supportsReportsPush()) {
        $path = $gateway
          ->getPushReportPath();
        if (isset($path) && mb_strlen($path) >= 2 && mb_substr($path, 0, 1) == '/') {
          $route = (new Route($path))
            ->setDefault('_controller', '\\Drupal\\sms\\DeliveryReportController::processDeliveryReport')
            ->setDefault('_sms_gateway_push_endpoint', $id)
            ->setRequirement('_sms_gateway_supports_pushed_reports', 'TRUE');
          $collection
            ->add('sms.delivery_report.receive.' . $id, $route);
        }
      }
      if ($gateway
        ->autoCreateIncomingRoute()) {
        $path = $gateway
          ->getPushIncomingPath();
        if (isset($path) && mb_strlen($path) >= 2 && mb_substr($path, 0, 1) == '/') {
          $parameters['sms_gateway']['type'] = 'entity:sms_gateway';
          $route = (new Route($path))
            ->setDefault('sms_gateway', $id)
            ->setDefault('_controller', '\\Drupal\\sms\\SmsIncomingController::processIncoming')
            ->setRequirement('_access', 'TRUE')
            ->setOption('parameters', $parameters)
            ->setMethods([
            'POST',
          ]);
          $collection
            ->add('sms.incoming.receive.' . $id, $route);
        }
      }
    }
    return $collection;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RouteSubscriber::$configFactory	protected	property	The config factory.
RouteSubscriber::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
RouteSubscriber::routes	public	function	Returns a set of route objects.
RouteSubscriber::__construct	public	function	Constructs a new SMS Framework RouteSubscriber.