class SiteAlertController in Site Alert 8

Implements SiteAlertController class.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\site_alert\Controller\SiteAlertController

Expanded class hierarchy of SiteAlertController

File

src/Controller/SiteAlertController.php, line 16

Namespace

Drupal\site_alert\Controller

View source

class SiteAlertController extends ControllerBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The service that retrieves site alerts.
   *
   * @var \Drupal\site_alert\GetAlertsInterface
   */
  protected $getAlerts;

  /**
   * Constructs a new SiteAlertController.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   * @param \Drupal\site_alert\GetAlertsInterface $getAlerts
   *   The service that retrieves site alerts.
   */
  public function __construct(EntityTypeManagerInterface $entityTypeManager, RendererInterface $renderer, GetAlertsInterface $getAlerts) {
    $this->entityTypeManager = $entityTypeManager;
    $this->renderer = $renderer;
    $this->getAlerts = $getAlerts;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('renderer'), $container
      ->get('site_alert.get_alerts'));
  }

  /**
   * {@inheritdoc}
   */
  public function getUpdatedAlerts() {
    $cache_metadata = new CacheableMetadata();

    // Add the list cache tags so that the response will be invalidated when
    // the alerts change.
    $cache_metadata
      ->addCacheTags($this->entityTypeManager
      ->getDefinition('site_alert')
      ->getListCacheTags());

    // Add the 'rendered' cache tag as this response is not processed by
    // \Drupal\Core\Render\MainContent\HtmlRenderer::renderResponse().
    $cache_metadata
      ->addCacheTags([
      'rendered',
    ]);

    // Set the max age to the first scheduled change in visible alerts.
    $cache_metadata
      ->setCacheMaxAge($this->entityTypeManager
      ->getStorage('site_alert')
      ->getCacheMaxAge());

    // Apply the cache context that varies by the currently active alerts.
    $cache_metadata
      ->setCacheContexts([
      'active_site_alerts',
    ]);
    $build = [];
    foreach ($this->getAlerts
      ->getActiveAlerts() as $alert) {
      $build[] = [
        '#theme' => 'site_alert',
        '#alert' => [
          'severity' => $alert
            ->getSeverity(),
          'label' => $alert
            ->getLabel(),
          'message' => [
            '#type' => 'markup',
            '#markup' => $alert
              ->getMessage(),
          ],
        ],
        '#attached' => [
          'library' => [
            'site_alert/drupal.site_alert',
          ],
        ],
      ];
      $cache_metadata
        ->addCacheableDependency($alert);
    }
    $cache_metadata
      ->applyTo($build);
    $response = new HtmlResponse();
    $response
      ->setContent($this->renderer
      ->renderRoot($build))
      ->addCacheableDependency($cache_metadata);
    return $response;
  }

}

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::$entityManager	protected	property	The entity 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.
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.
SiteAlertController::$entityTypeManager	protected	property	The entity type manager. Overrides ControllerBase::$entityTypeManager
SiteAlertController::$getAlerts	protected	property	The service that retrieves site alerts.
SiteAlertController::$renderer	protected	property	The renderer service.
SiteAlertController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
SiteAlertController::getUpdatedAlerts	public	function
SiteAlertController::__construct	public	function	Constructs a new SiteAlertController.
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.

You are here

class SiteAlertController in Site Alert 8

Hierarchy

File

Namespace

Members

API Navigation