You are here

Home » API reference » Popup message 8 » PopupMessageStatus.php

class PopupMessageStatus in Popup message 8

Class PopupMessageStatus.

@package Drupal\popup_message\Helper

Hierarchy

Expanded class hierarchy of PopupMessageStatus

File

src/Controller/PopupMessageStatus.php, line 18

Namespace

Drupal\popup_message\Controller
View source 
class PopupMessageStatus extends ControllerBase {

  /**
   * Path matcher services.
   *
   * @var \Drupal\Core\Path\PathMatcher
   */
  protected $pathMatcher;

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

  /**
   * PopupMessageStatus constructor.
   *
   * @param \Drupal\Core\Path\PathMatcherInterface $path_matcher
   *   Path matcher services.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Config factory service.
   */
  public function __construct(PathMatcherInterface $path_matcher, ConfigFactoryInterface $config_factory) {
    $this->pathMatcher = $path_matcher;
    $this->configFactory = $config_factory;
  }

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

  /**
   * Check and send popup status to js.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   Request.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   Popup status in json.
   */
  public function check(Request $request) {
    $config = $this->configFactory
      ->get('popup_message.settings');

    // Get popup message visibility settings.
    $visibility = $config
      ->get('visibility') ? $config
      ->get('visibility') : 0;

    // Get popup message visibility pages settings.
    $visibility_pages = $config
      ->get('visibility_pages') ? $config
      ->get('visibility_pages') : '';

    // Predefine value.
    $page_match = TRUE;

    // Limited visibility popup message must list at least one page.
    $status = TRUE;
    if ($visibility == 1 && empty($visibility_pages)) {
      $status = FALSE;
    }

    // Match path if necessary.
    if ($visibility_pages && $status) {

      // Convert path to lowercase. This allows comparison of the same path
      // with different case. Ex: /Page, /page, /PAGE.
      $real_path = $request
        ->get('popup_path');
      if ($real_path == '/') {
        $real_path = $this->configFactory
          ->get('system.site')
          ->get('page.front');
      }
      else {
        $real_path = substr($real_path, 1);
      }
      $pages = mb_strtolower($visibility_pages);
      if ($visibility < 2) {

        // Convert the Drupal path to lowercase.
        $path = mb_strtolower($real_path);

        // Compare the lowercase internal and lowercase path alias (if any).
        $page_match = $this->pathMatcher
          ->matchPath($path, $pages);
        $page_match = !($visibility xor $page_match);
      }
      else {
        $page_match = FALSE;
      }
    }
    $show_popup = (int) $page_match;
    $response = new Response();
    $response
      ->setContent(json_encode([
      'status' => $show_popup,
    ]));
    $response->headers
      ->set('Content-Type', 'application/json');
    return $response;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
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::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.
PopupMessageStatus::$configFactory protected property Config factory service. Overrides ControllerBase::$configFactory
PopupMessageStatus::$pathMatcher protected property Path matcher services.
PopupMessageStatus::check public function Check and send popup status to js.
PopupMessageStatus::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
PopupMessageStatus::__construct public function PopupMessageStatus 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. 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.