class LogController in Log entity 8

Returns responses for Log routes.

View source

class LogController extends ControllerBase implements ContainerInjectionInterface {

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

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

  /**
   * Constructs a LogController object.
   *
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   */
  public function __construct(DateFormatterInterface $date_formatter, RendererInterface $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 add content links for available content types.
   *
   * Redirects to log/add/[type] if only one content type is available.
   *
   * @return array|\Symfony\Component\HttpFoundation\RedirectResponse
   *   A render array for a list of the log types that can be added; however,
   *   if there is only one log type defined for the site, the function
   *   will return a RedirectResponse to the log add page for that one log
   *   type.
   */
  public function addPage() {
    $build = [
      '#theme' => 'log_add_list',
      '#cache' => [
        'tags' => $this
          ->entityManager()
          ->getDefinition('log_type')
          ->getListCacheTags(),
      ],
    ];
    $content = array();

    // Only use log types the user has access to.
    foreach ($this
      ->entityManager()
      ->getStorage('log_type')
      ->loadMultiple() as $type) {
      $access = $this
        ->entityManager()
        ->getAccessControlHandler('log')
        ->createAccess($type
        ->id(), NULL, [], TRUE);
      if ($access
        ->isAllowed()) {
        $content[$type
          ->id()] = $type;
      }
      $this->renderer
        ->addCacheableDependency($build, $access);
    }

    // Bypass the log/add listing if only one content type is available.
    if (count($content) == 1) {
      $type = array_shift($content);
      return $this
        ->redirect('log.add', array(
        'log_type' => $type
          ->id(),
      ));
    }
    $build['#content'] = $content;
    return $build;
  }

  /**
   * Provides the log submission form.
   *
   * @param \Drupal\log\LogTypeInterface $log_type
   *   The log type entity for the log.
   *
   * @return array
   *   A log submission form.
   */
  public function add(LogTypeInterface $log_type) {
    $log = $this
      ->entityManager()
      ->getStorage('log')
      ->create(array(
      'type' => $log_type
        ->id(),
    ));
    $form = $this
      ->entityFormBuilder()
      ->getForm($log);
    return $form;
  }

  /**
   * Displays a log revision.
   *
   * @param int $log_revision
   *   The log revision ID.
   *
   * @return array
   *   An array suitable for drupal_render().
   */
  public function revisionShow($log_revision) {
    $log = $this
      ->entityManager()
      ->getStorage('log')
      ->loadRevision($log_revision);
    $log_view_controller = new LogViewController($this->entityManager, $this->renderer);
    $page = $log_view_controller
      ->view($log);
    unset($page['logs'][$log
      ->id()]['#cache']);
    return $page;
  }

  /**
   * Page title callback for a log revision.
   *
   * @param int $log_revision
   *   The log revision ID.
   *
   * @return string
   *   The page title.
   */
  public function revisionPageTitle($log_revision) {
    $log = $this
      ->entityManager()
      ->getStorage('log')
      ->loadRevision($log_revision);
    return $this
      ->t('Revision of %title from %date', array(
      '%title' => $log
        ->label(),
      '%date' => format_date($log
        ->getRevisionCreationTime()),
    ));
  }

  /**
   * Generates an overview table of older revisions of a log.
   *
   * @param \Drupal\log\LogInterface $log
   *   A log object.
   *
   * @return array
   *   An array as expected by drupal_render().
   */
  public function revisionOverview(LogInterface $log) {
    $account = $this
      ->currentUser();
    $langcode = $this
      ->languageManager()
      ->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)
      ->getId();
    $langname = $this
      ->languageManager()
      ->getLanguageName($langcode);
    $languages = $log
      ->getTranslationLanguages();
    $has_translations = count($languages) > 1;
    $log_storage = $this
      ->entityManager()
      ->getStorage('log');
    $type = $log
      ->getType();
    $build['#title'] = $has_translations ? $this
      ->t('@langname revisions for %title', [
      '@langname' => $langname,
      '%title' => $log
        ->label(),
    ]) : $this
      ->t('Revisions for %title', [
      '%title' => $log
        ->label(),
    ]);
    $header = array(
      $this
        ->t('Revision'),
      $this
        ->t('Operations'),
    );
    $revert_permission = ($account
      ->hasPermission("revert {$type} revisions") || $account
      ->hasPermission('revert all revisions') || $account
      ->hasPermission('administer logs')) && $log
      ->access('update');
    $delete_permission = ($account
      ->hasPermission("delete {$type} revisions") || $account
      ->hasPermission('delete all revisions') || $account
      ->hasPermission('administer logs')) && $log
      ->access('delete');
    $rows = array();
    $vids = $log_storage
      ->revisionIds($log);
    $latest_revision = TRUE;
    foreach (array_reverse($vids) as $vid) {

      /** @var \Drupal\log\LogInterface $revision */
      $revision = $log_storage
        ->loadRevision($vid);
      if ($revision
        ->hasTranslation($langcode) && $revision
        ->getTranslation($langcode)
        ->isRevisionTranslationAffected()) {
        $username = [
          '#theme' => 'username',
          '#account' => $revision
            ->getRevisionAuthor(),
        ];

        // Use revision link to link to revisions that are not active.
        $date = $this->dateFormatter
          ->format($revision->revision_timestamp->value, 'short');
        if ($vid != $log
          ->getRevisionId()) {
          $link = $this
            ->l($date, new Url('entity.log.revision', [
            'log' => $log
              ->id(),
            'log_revision' => $vid,
          ]));
        }
        else {
          $link = $log
            ->link($date);
        }
        $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->revision_log->value,
                '#allowed_tags' => Xss::getHtmlTagList(),
              ],
            ],
          ],
        ];

        // @todo Simplify once https://www.drupal.org/log/2334319 lands.
        $this->renderer
          ->addCacheableDependency($column['data'], $username);
        $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('log.revision_revert_translation_confirm', [
                'log' => $log
                  ->id(),
                'log_revision' => $vid,
                'langcode' => $langcode,
              ]) : Url::fromRoute('log.revision_revert_confirm', [
                'log' => $log
                  ->id(),
                'log_revision' => $vid,
              ]),
            ];
          }
          if ($delete_permission) {
            $links['delete'] = [
              'title' => $this
                ->t('Delete'),
              'url' => Url::fromRoute('log.revision_delete_confirm', [
                'log' => $log
                  ->id(),
                'log_revision' => $vid,
              ]),
            ];
          }
          $row[] = [
            'data' => [
              '#type' => 'operations',
              '#links' => $links,
            ],
          ];
        }
        $rows[] = $row;
      }
    }
    $build['log_revisions_table'] = array(
      '#theme' => 'table',
      '#rows' => $rows,
      '#header' => $header,
      '#attached' => array(
        'library' => array(
          'log/drupal.log.admin',
        ),
      ),
    );
    return $build;
  }

  /**
   * The _title_callback for the log.add route.
   *
   * @param \Drupal\log\LogTypeInterface $log_type
   *   The current log.
   *
   * @return string
   *   The page title.
   */
  public function addPageTitle(LogTypeInterface $log_type) {
    return $this
      ->t('Create @name', array(
      '@name' => $log_type
        ->label(),
    ));
  }

}

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::$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.
LogController::$dateFormatter	protected	property	The date formatter service.
LogController::$renderer	protected	property	The renderer service.
LogController::add	public	function	Provides the log submission form.
LogController::addPage	public	function	Displays add content links for available content types.
LogController::addPageTitle	public	function	The _title_callback for the log.add route.
LogController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
LogController::revisionOverview	public	function	Generates an overview table of older revisions of a log.
LogController::revisionPageTitle	public	function	Page title callback for a log revision.
LogController::revisionShow	public	function	Displays a log revision.
LogController::__construct	public	function	Constructs a LogController object.
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.
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 LogController in Log entity 8

Hierarchy

File

Namespace

Members

API Navigation