class LoginRedirectPerRole in Login And Logout Redirect Per Role 8

Hierarchy

class \Drupal\login_redirect_per_role\LoginRedirectPerRole implements LoginRedirectPerRoleInterface

Expanded class hierarchy of LoginRedirectPerRole

1 string reference to 'LoginRedirectPerRole'

login_redirect_per_role.services.yml in ./login_redirect_per_role.services.yml: login_redirect_per_role.services.yml

1 service uses LoginRedirectPerRole

login_redirect_per_role.service in ./login_redirect_per_role.services.yml: Drupal\login_redirect_per_role\LoginRedirectPerRole

File

src/LoginRedirectPerRole.php, line 17

Namespace

Drupal\login_redirect_per_role

View source

class LoginRedirectPerRole implements LoginRedirectPerRoleInterface {

  /**
   * The currently active route match object.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $currentRouteMatch;

  /**
   * The currently active request object.
   *
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $currentRequest;

  /**
   * The login_redirect_per_role.settings config object.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $config;

  /**
   * The current active user.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $currentUser;

  /**
   * The token service.
   *
   * @var \Drupal\Core\Utility\Token
   */
  protected $token;

  /**
   * Constructs a new Login And Logout Redirect Per Role service object.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $current_route_match
   *   The currently active route match object.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Session\AccountProxyInterface $current_user
   *   The current active user.
   * @param \Drupal\Core\Utility\Token $token
   *   The token service.
   */
  public function __construct(RouteMatchInterface $current_route_match, RequestStack $request_stack, ConfigFactoryInterface $config_factory, AccountProxyInterface $current_user, Token $token) {
    $this->currentRouteMatch = $current_route_match;
    $this->currentRequest = $request_stack
      ->getCurrentRequest();
    $this->config = $config_factory
      ->get('login_redirect_per_role.settings');
    $this->currentUser = $current_user;
    $this->token = $token;
  }

  /**
   * {@inheritdoc}
   */
  public function isApplicableOnCurrentPage() {
    switch ($this->currentRouteMatch
      ->getRouteName()) {
      case 'user.reset':
      case 'user.reset.login':
      case 'user.reset.form':
        return FALSE;
      default:
        return TRUE;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getLoginRedirectUrl() {
    return $this
      ->getRedirectUrl(LoginRedirectPerRoleInterface::CONFIG_KEY_LOGIN);
  }

  /**
   * {@inheritdoc}
   */
  public function setLoginDestination(AccountInterface $account = NULL) {
    $this
      ->setDestination(LoginRedirectPerRoleInterface::CONFIG_KEY_LOGIN, $account);
  }

  /**
   * {@inheritdoc}
   */
  public function getLogoutRedirectUrl() {
    return $this
      ->getRedirectUrl(LoginRedirectPerRoleInterface::CONFIG_KEY_LOGOUT);
  }

  /**
   * {@inheritdoc}
   */
  public function setLogoutDestination(AccountInterface $account = NULL) {
    $this
      ->setDestination(LoginRedirectPerRoleInterface::CONFIG_KEY_LOGOUT, $account);
  }

  /**
   * {@inheritdoc}
   */
  public function getLogoutConfig() {
    return $this
      ->getConfig(LoginRedirectPerRoleInterface::CONFIG_KEY_LOGOUT);
  }

  /**
   * {@inheritdoc}
   */
  public function getLoginConfig() {
    return $this
      ->getConfig(LoginRedirectPerRoleInterface::CONFIG_KEY_LOGIN);
  }

  /**
   * Set "destination" parameter to do redirect.
   *
   * @param string $key
   *   Configuration key (login or logout).
   * @param \Drupal\Core\Session\AccountInterface|null $account
   *   User account to set destination for.
   */
  protected function setDestination($key, AccountInterface $account = NULL) {
    $url = $this
      ->getRedirectUrl($key, $account);
    if ($url instanceof Url) {
      $this->currentRequest->query
        ->set('destination', $url
        ->toString());
    }
  }

  /**
   * Return redirect URL related to requested key and current user.
   *
   * @param string $key
   *   Configuration key (login or logout).
   * @param \Drupal\Core\Session\AccountInterface|null $account
   *   User account to get redirect URL for.
   *
   * @return \Drupal\Core\Url|null
   *   Redirect URL related to requested key and current user.
   */
  protected function getRedirectUrl($key, AccountInterface $account = NULL) {
    $url = NULL;
    switch ($key) {
      case LoginRedirectPerRoleInterface::CONFIG_KEY_LOGIN:
        if (!$this
          ->isApplicableOnCurrentPage()) {
          return $url;
        }
        break;
    }
    $config = $this
      ->getConfig($key);
    if (!$config) {
      return $url;
    }
    $user_roles = $this
      ->getUserRoles($account);
    $destination = $this->currentRequest->query
      ->get('destination');
    foreach ($config as $role_id => $settings) {

      // Do action only if user have a role and
      // "Redirect URL" is set for this role.
      if (in_array($role_id, $user_roles) && $settings['redirect_url']) {

        // Prevent redirect if destination usage is allowed.
        if ($settings['allow_destination'] && $destination) {
          break;
        }
        if ($settings['redirect_url'] === '<front>') {
          $url = Url::fromRoute($settings['redirect_url']);
          break;
        }
        $path = $this->token
          ->replace($settings['redirect_url']);
        $url = Url::fromUserInput($this
          ->stripSubdirectoryFromPath($path));
        break;
      }
    }
    return $url;
  }

  /**
   * Return requested configuration items (login or logout) ordered by weight.
   *
   * @param string $key
   *   Configuration key (login or logout).
   *
   * @return array
   *   Requested configuration items (login or logout) ordered by weight.
   */
  protected function getConfig($key) {
    $config = $this->config
      ->get($key);
    if ($config) {
      uasort($config, [
        SortArray::class,
        'sortByWeightElement',
      ]);
      return $config;
    }
    return [];
  }

  /**
   * Return user roles list from given account or from current user.
   *
   * @param \Drupal\Core\Session\AccountInterface|null $account
   *   User account to get roles.
   *
   * @return array
   *   Roles list.
   */
  protected function getUserRoles(AccountInterface $account = NULL) {
    if ($account instanceof AccountInterface) {
      $user_roles = $account
        ->getRoles();
    }
    else {
      $user_roles = $this->currentUser
        ->getRoles();
    }
    return $user_roles;
  }

  /**
   * Strips subdirectories from a URI.
   *
   * URIs created by \Drupal\Core\Url::toString() always contain the
   * subdirectories. When further processing needs to be done on a URI, the
   * subdirectories need to be stripped before feeding the URI to
   * \Drupal\Core\Url::fromUserInput().
   *
   * @param string $uri
   *   A plain-text URI that might contain a subdirectory.
   *
   * @return string
   *   A plain-text URI stripped of the subdirectories.
   */
  public function stripSubdirectoryFromPath(string $uri) {
    if (!empty($this->currentRequest
      ->getBasePath()) && strpos($uri, $this->currentRequest
      ->getBasePath()) === 0) {
      return substr($uri, mb_strlen($this->currentRequest
        ->getBasePath()));
    }
    return $uri;
  }

}

Members

Name	Modifiers	Type	Description
LoginRedirectPerRole::$config	protected	property	The login_redirect_per_role.settings config object.
LoginRedirectPerRole::$currentRequest	protected	property	The currently active request object.
LoginRedirectPerRole::$currentRouteMatch	protected	property	The currently active route match object.
LoginRedirectPerRole::$currentUser	protected	property	The current active user.
LoginRedirectPerRole::$token	protected	property	The token service.
LoginRedirectPerRole::getConfig	protected	function	Return requested configuration items (login or logout) ordered by weight.
LoginRedirectPerRole::getLoginConfig	public	function	Return login configuration. Overrides LoginRedirectPerRoleInterface::getLoginConfig
LoginRedirectPerRole::getLoginRedirectUrl	public	function	Return URL to redirect on user login. Overrides LoginRedirectPerRoleInterface::getLoginRedirectUrl
LoginRedirectPerRole::getLogoutConfig	public	function	Return logout configuration. Overrides LoginRedirectPerRoleInterface::getLogoutConfig
LoginRedirectPerRole::getLogoutRedirectUrl	public	function	Return URL to redirect on user logout. Overrides LoginRedirectPerRoleInterface::getLogoutRedirectUrl
LoginRedirectPerRole::getRedirectUrl	protected	function	Return redirect URL related to requested key and current user.
LoginRedirectPerRole::getUserRoles	protected	function	Return user roles list from given account or from current user.
LoginRedirectPerRole::isApplicableOnCurrentPage	public	function	Checks is login redirect action applicable on current page. Overrides LoginRedirectPerRoleInterface::isApplicableOnCurrentPage
LoginRedirectPerRole::setDestination	protected	function	Set "destination" parameter to do redirect.
LoginRedirectPerRole::setLoginDestination	public	function	Set Login destination parameter to do redirect. Overrides LoginRedirectPerRoleInterface::setLoginDestination
LoginRedirectPerRole::setLogoutDestination	public	function	Set Logout destination parameter to do redirect. Overrides LoginRedirectPerRoleInterface::setLogoutDestination
LoginRedirectPerRole::stripSubdirectoryFromPath	public	function	Strips subdirectories from a URI.
LoginRedirectPerRole::__construct	public	function	Constructs a new Login And Logout Redirect Per Role service object.
LoginRedirectPerRoleInterface::CONFIG_KEY_LOGIN		constant	Config key for Login configuration.
LoginRedirectPerRoleInterface::CONFIG_KEY_LOGOUT		constant	Config key for Logout configuration.

You are here

class LoginRedirectPerRole in Login And Logout Redirect Per Role 8

Hierarchy

File

Namespace

Members

API Navigation