You are here

Home » API reference » Sitewide Alert 8 » SitewideAlertController.php

class SitewideAlertController in Sitewide Alert 8

Class SitewideAlertController.

Returns responses for Sitewide Alert routes.

Hierarchy

Expanded class hierarchy of SitewideAlertController

File

src/Controller/SitewideAlertController.php, line 20

Namespace

Drupal\sitewide_alert\Controller
View source 
class SitewideAlertController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * The date formatter.
   *
   * @var \Drupal\Core\Datetime\DateFormatter
   */
  protected $dateFormatter;

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

  /**
   * Constructs a new SitewideAlertController.
   *
   * @param \Drupal\Core\Datetime\DateFormatter $date_formatter
   *   The date formatter.
   * @param \Drupal\Core\Render\Renderer $renderer
   *   The renderer.
   */
  public function __construct(DateFormatter $date_formatter, Renderer $renderer) {
    $this->dateFormatter = $date_formatter;
    $this->renderer = $renderer;
  }

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

  /**
   * Displays a Sitewide Alert revision.
   *
   * @param int $sitewide_alert_revision
   *   The Sitewide Alert revision ID.
   *
   * @return array
   *   An array suitable for drupal_render().
   */
  public function revisionShow($sitewide_alert_revision) {
    $sitewide_alert = $this
      ->entityTypeManager()
      ->getStorage('sitewide_alert')
      ->loadRevision($sitewide_alert_revision);
    $view_builder = $this
      ->entityTypeManager()
      ->getViewBuilder('sitewide_alert');
    return $view_builder
      ->view($sitewide_alert);
  }

  /**
   * Page title callback for a Sitewide Alert revision.
   *
   * @param int $sitewide_alert_revision
   *   The Sitewide Alert revision ID.
   *
   * @return string
   *   The page title.
   */
  public function revisionPageTitle($sitewide_alert_revision) {
    $sitewide_alert = $this
      ->entityTypeManager()
      ->getStorage('sitewide_alert')
      ->loadRevision($sitewide_alert_revision);
    return $this
      ->t('Revision of %title from %date', [
      '%title' => $sitewide_alert
        ->label(),
      '%date' => $this->dateFormatter
        ->format($sitewide_alert
        ->getRevisionCreationTime()),
    ]);
  }

  /**
   * Generates an overview table of older revisions of a Sitewide Alert.
   *
   * @param \Drupal\sitewide_alert\Entity\SitewideAlertInterface $sitewide_alert
   *   A Sitewide Alert object.
   *
   * @return array
   *   An array as expected by drupal_render().
   *
   * @throws \Drupal\Core\Entity\EntityMalformedException
   */
  public function revisionOverview(SitewideAlertInterface $sitewide_alert) {
    $account = $this
      ->currentUser();
    $sitewide_alert_storage = $this
      ->entityTypeManager()
      ->getStorage('sitewide_alert');
    $langcode = $sitewide_alert
      ->language()
      ->getId();
    $langname = $sitewide_alert
      ->language()
      ->getName();
    $languages = $sitewide_alert
      ->getTranslationLanguages();
    $has_translations = count($languages) > 1;
    $build['#title'] = $has_translations ? $this
      ->t('@langname revisions for %title', [
      '@langname' => $langname,
      '%title' => $sitewide_alert
        ->label(),
    ]) : $this
      ->t('Revisions for %title', [
      '%title' => $sitewide_alert
        ->label(),
    ]);
    $header = [
      $this
        ->t('Revision'),
      $this
        ->t('Operations'),
    ];
    $revert_permission = $account
      ->hasPermission("revert all sitewide alert revisions") || $account
      ->hasPermission('administer sitewide alert entities');
    $delete_permission = $account
      ->hasPermission("delete all sitewide alert revisions") || $account
      ->hasPermission('administer sitewide alert entities');
    $rows = [];
    $vids = $sitewide_alert_storage
      ->revisionIds($sitewide_alert);
    $latest_revision = TRUE;
    foreach (array_reverse($vids) as $vid) {

      /** @var \Drupal\sitewide_alert\SitewideAlertInterface $revision */
      $revision = $sitewide_alert_storage
        ->loadRevision($vid);

      // Only show revisions that are affected by the language that is being
      // displayed.
      if ($revision
        ->hasTranslation($langcode) && $revision
        ->getTranslation($langcode)
        ->isRevisionTranslationAffected()) {
        $username = [
          '#theme' => 'username',
          '#account' => $revision
            ->getRevisionUser(),
        ];

        // Use revision link to link to revisions that are not active.
        $date = $this->dateFormatter
          ->format($revision
          ->getRevisionCreationTime(), 'short');
        if ($vid != $sitewide_alert
          ->getRevisionId()) {
          $link = Link::fromTextAndUrl($date, new Url('entity.sitewide_alert.revision', [
            'sitewide_alert' => $sitewide_alert
              ->id(),
            'sitewide_alert_revision' => $vid,
          ]));
        }
        else {
          $link = $sitewide_alert
            ->toLink($date)
            ->toString();
        }
        $row = [];
        $column = [
          'data' => [
            '#type' => 'inline_template',
            '#template' => '{% trans %}{{ date }} by {{ username }}{% endtrans %}{% if message %}<p class="revision-log">{{ message }}</p>{% endif %}',
            '#context' => [
              'date' => $link,
              'username' => $this->renderer
                ->renderPlain($username),
              'message' => [
                '#markup' => $revision
                  ->getRevisionLogMessage(),
                '#allowed_tags' => Xss::getHtmlTagList(),
              ],
            ],
          ],
        ];
        $row[] = $column;
        if ($latest_revision) {
          $row[] = [
            'data' => [
              '#prefix' => '<em>',
              '#markup' => $this
                ->t('Current revision'),
              '#suffix' => '</em>',
            ],
          ];
          foreach ($row as &$current) {
            $current['class'] = [
              'revision-current',
            ];
          }
          $latest_revision = FALSE;
        }
        else {
          $links = [];
          if ($revert_permission) {
            $links['revert'] = [
              'title' => $this
                ->t('Revert'),
              'url' => $has_translations ? Url::fromRoute('entity.sitewide_alert.translation_revert', [
                'sitewide_alert' => $sitewide_alert
                  ->id(),
                'sitewide_alert_revision' => $vid,
                'langcode' => $langcode,
              ]) : Url::fromRoute('entity.sitewide_alert.revision_revert', [
                'sitewide_alert' => $sitewide_alert
                  ->id(),
                'sitewide_alert_revision' => $vid,
              ]),
            ];
          }
          if ($delete_permission) {
            $links['delete'] = [
              'title' => $this
                ->t('Delete'),
              'url' => Url::fromRoute('entity.sitewide_alert.revision_delete', [
                'sitewide_alert' => $sitewide_alert
                  ->id(),
                'sitewide_alert_revision' => $vid,
              ]),
            ];
          }
          $row[] = [
            'data' => [
              '#type' => 'operations',
              '#links' => $links,
            ],
          ];
        }
        $rows[] = $row;
      }
    }
    $build['sitewide_alert_revisions_table'] = [
      '#theme' => 'table',
      '#rows' => $rows,
      '#header' => $header,
    ];
    return $build;
  }

}

Members

Namesort descending 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::$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.
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.
SitewideAlertController::$dateFormatter protected property The date formatter.
SitewideAlertController::$renderer protected property The renderer.
SitewideAlertController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
SitewideAlertController::revisionOverview public function Generates an overview table of older revisions of a Sitewide Alert.
SitewideAlertController::revisionPageTitle public function Page title callback for a Sitewide Alert revision.
SitewideAlertController::revisionShow public function Displays a Sitewide Alert revision.
SitewideAlertController::__construct public function Constructs a new SitewideAlertController.
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.