LoginRedirectPerRoleInterface.php in Login And Logout Redirect Per Role 8

Namespace

Drupal\login_redirect_per_role

File

src/LoginRedirectPerRoleInterface.php

<?php

namespace Drupal\login_redirect_per_role;

use Drupal\Core\Session\AccountInterface;

/**
 * Interface defining Login And Logout Redirect Per Role helper service.
 */
interface LoginRedirectPerRoleInterface {

  /**
   * Config key for Login configuration.
   */
  const CONFIG_KEY_LOGIN = 'login';

  /**
   * Config key for Logout configuration.
   */
  const CONFIG_KEY_LOGOUT = 'logout';

  /**
   * Checks is login redirect action applicable on current page.
   *
   * @return bool
   *   Result of check.
   */
  public function isApplicableOnCurrentPage();

  /**
   * Return URL to redirect on user login.
   *
   * @return \Drupal\Core\Url|null
   *   URL to redirect to on success or NULL otherwise.
   */
  public function getLoginRedirectUrl();

  /**
   * Set Login destination parameter to do redirect.
   *
   * @param \Drupal\Core\Session\AccountInterface|null $account
   *   User account to set destination for.
   */
  public function setLoginDestination(AccountInterface $account = NULL);

  /**
   * Return URL to redirect on user logout.
   *
   * @return \Drupal\Core\Url|null
   *   URL to redirect to on success or NULL otherwise.
   */
  public function getLogoutRedirectUrl();

  /**
   * Set Logout destination parameter to do redirect.
   *
   * @param \Drupal\Core\Session\AccountInterface|null $account
   *   User account to set destination for.
   */
  public function setLogoutDestination(AccountInterface $account = NULL);

  /**
   * Return logout configuration.
   *
   * @return array
   *   Logout configuration on success or an empty array otherwise.
   */
  public function getLogoutConfig();

  /**
   * Return login configuration.
   *
   * @return array
   *   Login configuration on success or an empty array otherwise.
   */
  public function getLoginConfig();

}

Interfaces

Name	Description
LoginRedirectPerRoleInterface	Interface defining Login And Logout Redirect Per Role helper service.