class MultipleRegistrationController extends ControllerBase {

  /**
   * Path pattern.
   */
  const MULTIPLE_REGISTRATION_SIGNUP_PATH_PATTERN = '/user/register/';

  /**
   * Registration id.
   */
  const MULTIPLE_REGISTRATION_GENERAL_REGISTRATION_ID = 'authenticated';

  /**
   * Pages config.
   *
   * @var \Drupal\Core\Config\Config
   */
  public $regPagesConfig;

  /**
   * Available user roles service.
   *
   * @var \Drupal\multiple_registration\AvailableUserRolesService
   */
  protected $availableUserRolesService;

  /**
   * The alias manager that caches alias lookups based on the request.
   *
   * @var \Drupal\path_alias\AliasManagerInterface
   */
  protected $aliasManager;

  /**
   * The route match service.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * Messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messengerService;

  /**
   * MultipleRegistrationController constructor.
   *
   * @param \Drupal\multiple_registration\AvailableUserRolesService $availableUserRolesService
   *   AvailableUserRoles Service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   Config factory.
   * @param \Drupal\path_alias\AliasManager $aliasManager
   *   Alias manager.
   * @param \Drupal\Core\Routing\CurrentRouteMatch $routeMatch
   *   RouteMatch service.
   * @param \Drupal\Core\Messenger\Messenger $messengerService
   *   Messenger service.
   */
  public function __construct(AvailableUserRolesService $availableUserRolesService, ConfigFactoryInterface $configFactory, AliasManager $aliasManager, CurrentRouteMatch $routeMatch, Messenger $messengerService) {
    $this->regPagesConfig = $configFactory
      ->getEditable('multiple_registration.create_registration_page_form_config');
    $this->availableUserRolesService = $availableUserRolesService;
    $this->aliasManager = $aliasManager;
    $this->routeMatch = $routeMatch;
    $this->messengerService = $messengerService;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('multiple_registration.service'), $container
      ->get('config.factory'), $container
      ->get('path_alias.manager'), $container
      ->get('current_route_match'), $container
      ->get('messenger'));
  }

  /**
   * Checks access for register page.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Run access checks for this account.
   *
   * @return \Drupal\Core\Access\AccessResult
   *   Returns access result.
   */
  public function access(AccountInterface $account) {
    $registerAccessCheck = new RegisterAccessCheck();
    $clear_roles_list = [];
    $page_access_config = $this
      ->config('multiple_registration.access_settings_page_form_config');
    $page_access_roles_whitelist = $page_access_config
      ->get('multiple_registration_pages_white_list');
    if (is_array($page_access_roles_whitelist)) {
      foreach ($page_access_roles_whitelist as $role) {
        if (!empty($role)) {
          $clear_roles_list[] = $role;
        }
      }
    }

    // Allow user to access this page if user is authenticated.
    if ($account
      ->isAuthenticated()) {
      return AccessResult::allowed();
    }

    // Disabling non-whitelisted roles registration pages.
    $rid = $this->routeMatch
      ->getParameter('rid');
    if ($rid !== NULL && !\in_array($rid, $clear_roles_list, TRUE)) {
      return AccessResult::forbidden();
    }

    // Check access by permissions system.
    return AccessResult::allowedIf($account
      ->hasPermission('administer multiple_registration') || $registerAccessCheck
      ->access($account)
      ->isAllowed());
  }

  /**
   * Redirects the current user to its profile page if user has logged in.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Current user account object.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse|null
   *   Returns RedirectResponse object or NULL.
   */
  public function authenticatedUserRedirect(AccountInterface $account) {
    $is_redirect_enabled = FALSE;
    $config = $this
      ->config('multiple_registration.common_settings_page_form_config');
    if ($config !== NULL && $config !== $config
      ->isNew()) {
      $is_redirect_enabled = $config
        ->get('enable_redirect_to_user_profile_when_user_logged_in');
    }
    if ($account
      ->isAuthenticated() && $is_redirect_enabled) {
      return $this
        ->redirect('user.page', [
        'user' => $account
          ->id(),
      ])
        ->send();
    }
    return NULL;
  }

  /**
   * Page with registration pages list.
   *
   * @return array
   *   Returns index.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function index() {
    $regPages = $this->availableUserRolesService
      ->getRegistrationPages();
    if ($regPages) {
      foreach ($regPages as $rid => $role) {
        $row = [];
        $row[] = $role['role_name'];
        $path_alias = $this->aliasManager
          ->getAliasByPath($role['url']);
        $row[] = $path_alias;
        if ($role['hidden'] === 1) {
          $isHiddenLabel = $this
            ->t('Yes');
        }
        else {
          $isHiddenLabel = $this
            ->t('No');
        }
        $row[] = $isHiddenLabel;
        $row[] = $role['form_mode_register'];
        $row[] = $role['form_mode_edit'];
        $edit_url = Url::fromRoute('multiple_registration.create_registration_page_form', [
          'rid' => $rid,
        ], [
          'attributes' => [
            'class' => 'use-ajax',
            'data-accepts' => 'application/vnd.drupal-modal',
            'data-dialog-type' => 'modal',
            'data-dialog-options' => '{"width": "50%"}',
          ],
        ]);
        $remove_url = Url::fromRoute('multiple_registration.delete_registration_page_form', [
          'rid' => $rid,
        ], [
          'attributes' => [
            'class' => 'use-ajax',
            'data-accepts' => 'application/vnd.drupal-modal',
            'data-dialog-type' => 'modal',
            'data-dialog-options' => '{"width": "50%"}',
          ],
        ]);
        $row[] = [
          'data' => [
            '#type' => 'dropbutton',
            '#links' => [
              'edit' => [
                'title' => $this
                  ->t('Edit'),
                'url' => $edit_url,
              ],
              'remove' => [
                'title' => $this
                  ->t('Remove'),
                'url' => $remove_url,
              ],
            ],
          ],
        ];
        $rows[] = [
          'data' => $row,
        ];
      }
      $header = [
        $this
          ->t('Role'),
        $this
          ->t('Registration page path'),
        $this
          ->t('Hidden'),
        $this
          ->t('Register form mode'),
        $this
          ->t('Edit form mode'),
        [
          'data' => $this
            ->t('Operations'),
        ],
      ];
      $output = [
        '#theme' => 'table',
        '#header' => $header,
        '#rows' => $rows,
        '#attributes' => [
          'id' => 'user-roles-reg-pages',
        ],
        '#attached' => [
          'library' => [
            'core/drupal.dialog.ajax',
          ],
        ],
        '#empty' => $this
          ->t('No custom Role registration pages defined'),
      ];
    }
    else {
      $add_reg_pages_link = Link::fromTextAndUrl($this
        ->t('here'), Url::fromRoute('entity.user_role.collection'))
        ->toString();
      $output = [
        '#markup' => $this
          ->t('There are no additional registration pages created yet. You can add new pages %here', [
          '%here' => $add_reg_pages_link,
        ]),
      ];
    }
    $common_settings_url = Url::fromRoute('multiple_registration.common_settings_page_form', [], [
      'attributes' => [
        'class' => 'use-ajax',
        'data-accepts' => 'application/vnd.drupal-modal',
        'data-dialog-type' => 'modal',
        'data-dialog-options' => '{"width": "50%"}',
      ],
    ]);
    $access_settings_url = Url::fromRoute('multiple_registration.access_settings_page_form', [], [
      'attributes' => [
        'class' => 'use-ajax',
        'data-accepts' => 'application/vnd.drupal-modal',
        'data-dialog-type' => 'modal',
        'data-dialog-options' => '{"width": "50%"}',
      ],
    ]);

    // Adding reminder for configuring multiple registration pages access.
    $access_settings_reminder = Markup::create("Don't forget to configure " . Link::fromTextAndUrl($this
      ->t('Multiple Registration pages access settings'), $access_settings_url)
      ->toString() . ' before start using this module.');
    $this
      ->messenger()
      ->addWarning($access_settings_reminder);

    // Adding multiple registration setting links.
    $output['#suffix'] = '<p>' . Link::fromTextAndUrl($this
      ->t('Common settings'), $common_settings_url)
      ->toString() . '</p>';
    $output['#suffix'] .= '<p>' . Link::fromTextAndUrl($this
      ->t('Multiple Registration pages access settings'), $access_settings_url)
      ->toString() . '</p>';
    $output['#suffix'] .= '<p>' . Link::fromTextAndUrl($this
      ->t('Go to Roles managing page'), Url::fromRoute('entity.user_role.collection'))
      ->toString() . '</p>';
    return $output;
  }

  /**
   * Adds alias for registration page.
   *
   * @param string $source
   *   Source string.
   * @param string $alias
   *   Path alias string.
   *
   * @throws \Exception
   */
  public function addRegisterPageAlias($source, $alias) {
    $path_alias = $this
      ->entityTypeManager()
      ->getStorage('path_alias')
      ->create([
      'path' => $source,
      'alias' => $alias,
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ]);
    $path_alias
      ->save();
  }

  /**
   * Removes registration page alias for role.
   *
   * @param int $rid
   *   Role ID.
   */
  public function removeRegisterPageAlias($rid) {
    $pages_config = $this->regPagesConfig;
    $source = $pages_config
      ->get('multiple_registration_url_' . $rid);
    $path_alias_storage = $this
      ->entityTypeManager()
      ->getStorage('path_alias');
    $entities = $path_alias_storage
      ->loadByProperties([
      'path' => $source,
      'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
    ]);
    $path_alias_storage
      ->delete($entities);
  }

  /**
   * Removes registration page for role.
   *
   * @param int $rid
   *   Role ID.
   */
  public function removeRegisterPage($rid) {
    $pages_config = $this->regPagesConfig;
    if ($pages_config
      ->get('multiple_registration_url_' . $rid)) {
      $this
        ->removeRegisterPageAlias($rid);
      $pages_config
        ->clear('multiple_registration_path_' . $rid)
        ->clear('multiple_registration_url_' . $rid)
        ->save();
      $this->messengerService
        ->addMessage($this
        ->t('Registration page has been removed.'));
    }
    else {
      $this->messengerService
        ->addError($this
        ->t('Registration page has not been removed. There are no pages for this role.'));
    }
  }

  /**
   * Check is field available for role.
   *
   * @param array $fieldRoles
   *   Array with assigned roles for the fields.
   *
   * @return bool
   *   Returns access result.
   */
  public static function checkFieldAccess(array $fieldRoles) {
    $routeMatch = \Drupal::routeMatch();
    $roles = [];
    switch ($routeMatch
      ->getRouteName()) {

      // Role page registration.
      case 'multiple_registration.role_registration_page':
        $roles = [
          $routeMatch
            ->getParameter('rid'),
        ];
        break;

      // Default registration.
      case 'user.register':
        $roles = [
          self::MULTIPLE_REGISTRATION_GENERAL_REGISTRATION_ID,
        ];
        break;

      // User edit page.
      case 'entity.user.edit_form':
        $roles = $routeMatch
          ->getParameter('user')
          ->getRoles();
        if (!static::useRegistrationPage($roles)) {

          // Fall back to 'General registered users' if user does not have any
          // special role.
          $roles = [
            self::MULTIPLE_REGISTRATION_GENERAL_REGISTRATION_ID,
          ];
        }
        break;
    }
    $extractKeys = array_intersect($roles, $fieldRoles);
    if (!empty($extractKeys)) {
      return TRUE;
    }
    else {
      return FALSE;
    }
  }

  /**
   * Gets the title for registration page.
   */
  public function getRegisterPageTitle(RouteMatchInterface $route) {
    $role = $route
      ->getRawParameter('rid');
    $roles = user_role_names();
    if (isset($roles[$role])) {
      return $this
        ->t('Create new @role account', [
        '@role' => $roles[$role],
      ]);
    }
    else {
      return $this
        ->t('Role @role not found, you can use default registration page.', [
        '@role' => ucfirst($role),
      ]);
    }
  }

  /**
   * Checks whether there're special registration pages for any of given roles.
   *
   * @param array $roles
   *   Array of role IDs.
   *
   * @return bool
   *   Whether there is a special registration form available for at least one
   *   of given roles.
   */
  protected static function useRegistrationPage(array $roles) {
    $pages_config = \Drupal::configFactory()
      ->get('multiple_registration.create_registration_page_form_config');
    foreach ($roles as $rid) {
      if ($pages_config
        ->get('multiple_registration_url_' . $rid)) {
        return TRUE;
      }
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route.
ControllerBase::state	protected	function	Returns the state storage service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
MultipleRegistrationController::$aliasManager	protected	property	The alias manager that caches alias lookups based on the request.
MultipleRegistrationController::$availableUserRolesService	protected	property	Available user roles service.
MultipleRegistrationController::$messengerService	protected	property	Messenger service.
MultipleRegistrationController::$regPagesConfig	public	property	Pages config.
MultipleRegistrationController::$routeMatch	protected	property	The route match service.
MultipleRegistrationController::access	public	function	Checks access for register page.
MultipleRegistrationController::addRegisterPageAlias	public	function	Adds alias for registration page.
MultipleRegistrationController::authenticatedUserRedirect	public	function	Redirects the current user to its profile page if user has logged in.
MultipleRegistrationController::checkFieldAccess	public static	function	Check is field available for role.
MultipleRegistrationController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
MultipleRegistrationController::getRegisterPageTitle	public	function	Gets the title for registration page.
MultipleRegistrationController::index	public	function	Page with registration pages list.
MultipleRegistrationController::MULTIPLE_REGISTRATION_GENERAL_REGISTRATION_ID		constant	Registration id.
MultipleRegistrationController::MULTIPLE_REGISTRATION_SIGNUP_PATH_PATTERN		constant	Path pattern.
MultipleRegistrationController::removeRegisterPage	public	function	Removes registration page for role.
MultipleRegistrationController::removeRegisterPageAlias	public	function	Removes registration page alias for role.
MultipleRegistrationController::useRegistrationPage	protected static	function	Checks whether there're special registration pages for any of given roles.
MultipleRegistrationController::__construct	public	function	MultipleRegistrationController constructor.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class MultipleRegistrationController in Multiple Registration 3.x

Hierarchy

File

Namespace

Members

API Navigation