class PageController in Restrict IP 8

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\restrict_ip\Controller\PageController implements PageControllerInterface

File

src/Controller/PageController.php, line 16

Namespace

Drupal\restrict_ip\Controller

class PageController extends ControllerBase implements PageControllerInterface {

  /**
   * The Form Builder service
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * The Config Factory service
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

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

  /**
   * The Module Handler service
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Constructs the PageController object for the Restrict IP module
   *
   * @param \Drupal\Core\Form\FormBuilderInterface $formBuilder
   *   The Form Builder service
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   The Config Factory service
   * @param \Drupal\Core\Session\AccountProxyInterface $currentUser;
   *   The current user
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   The Module Handler service
   */
  public function __construct(FormBuilderInterface $formBuilder, ConfigFactoryInterface $configFactory, AccountProxyInterface $currentUser, ModuleHandlerInterface $moduleHandler) {
    $this->formBuilder = $formBuilder;
    $this->configFactory = $configFactory;
    $this->currentUser = $currentUser;
    $this->moduleHandler = $moduleHandler;
  }

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

  /**
   * {@inheritdoc}
   */
  public function configPage() {
    $page = [
      '#prefix' => '<div id="restrict_ip_config_page">',
      '#suffix' => '</div.',
      'form' => $this->formBuilder
        ->getForm('\\Drupal\\restrict_ip\\Form\\ConfigForm'),
    ];
    return $page;
  }

  /**
   * {@inheritdoc}
   */
  public function accessDeniedPage() {
    if (!isset($_SESSION['restrict_ip']) || !$_SESSION['restrict_ip']) {
      return new RedirectResponse(Url::fromRoute('<front>')
        ->toString());
    }
    $config = $this->configFactory
      ->get('restrict_ip.settings');
    $page['access_denied'] = [
      '#markup' => $this
        ->t('The page you are trying to access cannot be accessed from your IP address.'),
      '#prefix' => '<p>',
      '#suffix' => '</p>',
    ];
    $contact_mail = $config
      ->get('mail_address');
    if (strlen($contact_mail)) {
      $contact_mail = str_replace('@', '[at]', $contact_mail);
      $mail_markup = new FormattableMarkup('<span id="restrict_ip_contact_mail">@address</span>', [
        '@address' => $contact_mail,
      ]);
      $page['contact_us'] = [
        '#prefix' => '<p>',
        '#suffix' => '</p>',
        '#markup' => $this
          ->t('If you feel this is in error, please contact an administrator at @email.', [
          '@email' => $mail_markup,
        ]),
        '#attached' => [
          'library' => [
            'restrict_ip/mail_fixer',
          ],
        ],
      ];
    }
    if ($config
      ->get('allow_role_bypass')) {
      if ($this->currentUser
        ->isAuthenticated()) {
        $url = Url::fromRoute('user.logout');
        $link = Link::fromTextAndUrl($this
          ->t('Logout'), $url);
        $page['logout_link'] = [
          '#markup' => $link
            ->toString(),
          '#prefix' => '<p>',
          '#suffix' => '</p>',
        ];
      }
      elseif ($config
        ->get('bypass_action') === 'provide_link_login_page') {
        $url = Url::fromRoute('user.login');
        $link = Link::fromTextAndUrl($this
          ->t('Sign in'), $url);
        $page['login_link'] = [
          '#markup' => $link
            ->toString(),
          '#prefix' => '<p>',
          '#suffix' => '</p>',
        ];
      }
    }
    $this->moduleHandler
      ->alter('restrict_ip_access_denied_page', $page);
    return $page;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
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::entityManager Deprecated	protected	function	Retrieves the entity manager service.
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. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator 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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PageController::$configFactory	protected	property	* The Config Factory service * * Overrides ControllerBase::$configFactory
PageController::$currentUser	protected	property	* The current user * * Overrides ControllerBase::$currentUser
PageController::$formBuilder	protected	property	* The Form Builder service * * Overrides ControllerBase::$formBuilder
PageController::$moduleHandler	protected	property	* The Module Handler service * * Overrides ControllerBase::$moduleHandler
PageController::accessDeniedPage	public	function	* Overrides PageControllerInterface::accessDeniedPage
PageController::configPage	public	function	* Overrides PageControllerInterface::configPage
PageController::create	public static	function	* Overrides ControllerBase::create
PageController::__construct	public	function	* Constructs the PageController object for the Restrict IP module * *
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.	1
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.