class LibraryItemController in Paragraphs 8

Hierarchy

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

Expanded class hierarchy of LibraryItemController

File

modules/paragraphs_library/src/Controller/LibraryItemController.php, line 15

Namespace

View source

class LibraryItemController extends ControllerBase implements ContainerInjectionInterface {

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

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

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

  /**
   * LibraryItemController constructor.
   *
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date formatter service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager service.
   * @param \Drupal\Core\Render\Renderer $renderer
   *   The renderer service.
   */
  public function __construct(DateFormatterInterface $date_formatter, EntityTypeManagerInterface $entity_type_manager, Renderer $renderer) {
    $this->dateFormatter = $date_formatter;
    $this->entityTypeManager = $entity_type_manager;
    $this->renderer = $renderer;
  }

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

  /**
   * Generates an overview table of older revisions of a library item.
   *
   * @param \Drupal\paragraphs_library\Entity\LibraryItem $paragraphs_library_item
   *   A library item object.
   *
   * @return array
   *   An array as expected by drupal_render()
   */
  public function revisionOverview(LibraryItem $paragraphs_library_item) {
    $label = $paragraphs_library_item
      ->get('label')->value;
    $build['#title'] = $this
      ->t('Revisions for %label', [
      '%label' => $label,
    ]);
    $header = [
      $this
        ->t('Revision'),
      $this
        ->t('Operations'),
    ];
    $rows = [];
    $default_revision = $paragraphs_library_item
      ->getRevisionId();
    $storage = $this->entityTypeManager
      ->getStorage('paragraphs_library_item');
    foreach ($this
      ->getRevisionIds($paragraphs_library_item) as $revision_id) {
      $revision = $storage
        ->loadRevision($revision_id);
      $date = $this->dateFormatter
        ->format($revision
        ->get('revision_created')->value, 'short');
      $row = [];
      $username = [
        '#theme' => 'username',
        '#account' => $revision
          ->getRevisionUser(),
      ];
      $column = [
        'data' => [
          '#type' => 'inline_template',
          '#template' => '{% trans %}{{ date }}: {{ label }} by {{ author }}{% endtrans %}{% if message %}<p class="revision-log">{{ message }}</p>{% endif %}',
          '#context' => [
            'date' => $revision
              ->toLink($date, $revision
              ->isDefaultRevision() ? 'canonical' : 'revision')
              ->toString(),
            'label' => $revision
              ->label(),
            'author' => $this->renderer
              ->renderPlain($username),
            'message' => [
              '#markup' => $revision
                ->get('revision_log')->value,
              '#allowed_tags' => Xss::getHtmlTagList(),
            ],
          ],
        ],
      ];
      $row[] = $column;
      if ($revision_id == $default_revision) {
        $row[] = [
          'data' => [
            '#prefix' => '<em>',
            '#markup' => $this
              ->t('Current revision'),
            '#suffix' => '</em>',
          ],
        ];
        $rows[] = [
          'data' => $row,
          'class' => [
            'revision-current',
          ],
        ];
      }
      else {
        $links = [
          'revert' => [
            'title' => $revision_id < $paragraphs_library_item
              ->getRevisionId() ? $this
              ->t('Revert') : $this
              ->t('Set as current revision'),
            'url' => $revision
              ->toUrl('revision-revert'),
          ],
          'delete' => [
            'title' => $this
              ->t('Delete'),
            'url' => $revision
              ->toUrl('revision-delete'),
          ],
        ];
        $row[] = [
          'data' => [
            '#type' => 'operations',
            '#links' => $links,
          ],
        ];
        $rows[] = $row;
      }
    }
    $build['paragraphs_library_item_revisions_table'] = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
    ];
    $build['pager'] = [
      '#type' => 'pager',
    ];
    return $build;
  }

  /**
   * Page title callback for library item revision.
   *
   * @param int $paragraphs_library_item_revision
   *   The library item revision ID.
   *
   * @return string
   *   The page title.
   */
  public function revisionPageTitle($paragraphs_library_item_revision) {
    $library_item = $this->entityTypeManager
      ->getStorage('paragraphs_library_item')
      ->loadRevision($paragraphs_library_item_revision);
    return $this
      ->t('Revision of %title from %date', [
      '%title' => $library_item
        ->label(),
      '%date' => $this->dateFormatter
        ->format($library_item
        ->getChangedTime()),
    ]);
  }

  /**
   *  Display a library item revision.
   *
   * @param int $paragraphs_library_item_revision
   *   The library item revision ID.
   *
   * @return array
   *   An array suitable for drupal_render().
   */
  public function revisionShow($paragraphs_library_item_revision) {
    $library_item = $this->entityTypeManager
      ->getStorage('paragraphs_library_item')
      ->loadRevision($paragraphs_library_item_revision);
    $view = $this->entityTypeManager
      ->getViewBuilder('paragraphs_library_item')
      ->view($library_item);
    return $view;
  }

  /**
   * Gets a list of library item revision IDs for a specific library item.
   *
   * @param \Drupal\paragraphs_library\LibraryItemInterface $library_item
   *   Library item entity.
   *
   * @return int[]
   *   Library item revision IDs (in descending order)
   */
  protected function getRevisionIds(LibraryItemInterface $library_item) {
    $result = $this->entityTypeManager
      ->getStorage('paragraphs_library_item')
      ->getQuery()
      ->allRevisions()
      ->condition('id', $library_item
      ->id())
      ->sort($library_item
      ->getEntityType()
      ->getKey('revision'), 'DESC')
      ->pager(50)
      ->execute();
    return array_keys($result);
  }

}

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.
LibraryItemController::$dateFormatter	protected	property	The date formatter service.
LibraryItemController::$entityTypeManager	protected	property	The entity type manager. Overrides ControllerBase::$entityTypeManager
LibraryItemController::$renderer	protected	property	The renderer service.
LibraryItemController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
LibraryItemController::getRevisionIds	protected	function	Gets a list of library item revision IDs for a specific library item.
LibraryItemController::revisionOverview	public	function	Generates an overview table of older revisions of a library item.
LibraryItemController::revisionPageTitle	public	function	Page title callback for library item revision.
LibraryItemController::revisionShow	public	function	Display a library item revision.
LibraryItemController::__construct	public	function	LibraryItemController constructor.
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.
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 LibraryItemController in Paragraphs 8

Hierarchy

File

Namespace

Members

API Navigation