You are here

Home » API reference » Drupal 10 » PathAliasListBuilder.php

class PathAliasListBuilder in Drupal 10

Same name and namespace in other branches
  1. 8 core/modules/path/src/PathAliasListBuilder.php \Drupal\path\PathAliasListBuilder
  2. 9 core/modules/path/src/PathAliasListBuilder.php \Drupal\path\PathAliasListBuilder

Defines a class to build a listing of path_alias entities.

Hierarchy

Expanded class hierarchy of PathAliasListBuilder

See also

\Drupal\path_alias\Entity\PathAlias

1 file declares its use of PathAliasListBuilder
path.module in core/modules/path/path.module
Enables users to rename URLs.

File

core/modules/path/src/PathAliasListBuilder.php, line 23

Namespace

Drupal\path
View source 
class PathAliasListBuilder extends EntityListBuilder {

  /**
   * The current request.
   *
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $currentRequest;

  /**
   * The form builder.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * The path alias manager.
   *
   * @var \Drupal\path_alias\AliasManagerInterface
   */
  protected $aliasManager;

  /**
   * Constructs a new PathAliasListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage class.
   * @param \Symfony\Component\HttpFoundation\Request $current_request
   *   The current request.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\path_alias\AliasManagerInterface $alias_manager
   *   The path alias manager.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, Request $current_request, FormBuilderInterface $form_builder, LanguageManagerInterface $language_manager, AliasManagerInterface $alias_manager) {
    parent::__construct($entity_type, $storage);
    $this->currentRequest = $current_request;
    $this->formBuilder = $form_builder;
    $this->languageManager = $language_manager;
    $this->aliasManager = $alias_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager')
      ->getStorage($entity_type
      ->id()), $container
      ->get('request_stack')
      ->getCurrentRequest(), $container
      ->get('form_builder'), $container
      ->get('language_manager'), $container
      ->get('path_alias.manager'));
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntityIds() {
    $query = $this
      ->getStorage()
      ->getQuery()
      ->accessCheck(TRUE);
    $search = $this->currentRequest->query
      ->get('search');
    if ($search) {
      $query
        ->condition('alias', $search, 'CONTAINS');
    }

    // Only add the pager if a limit is specified.
    if ($this->limit) {
      $query
        ->pager($this->limit);
    }

    // Allow the entity query to sort using the table header.
    $header = $this
      ->buildHeader();
    $query
      ->tableSort($header);
    return $query
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $keys = $this->currentRequest->query
      ->get('search');
    $build['path_admin_filter_form'] = $this->formBuilder
      ->getForm(PathFilterForm::class, $keys);
    $build += parent::render();
    $build['table']['#empty'] = $this
      ->t('No path aliases available. <a href=":link">Add URL alias</a>.', [
      ':link' => Url::fromRoute('entity.path_alias.add_form')
        ->toString(),
    ]);
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header = [
      'alias' => [
        'data' => $this
          ->t('Alias'),
        'field' => 'alias',
        'specifier' => 'alias',
        'sort' => 'asc',
      ],
      'path' => [
        'data' => $this
          ->t('System path'),
        'field' => 'path',
        'specifier' => 'path',
      ],
    ];

    // Enable language column and filter if multiple languages are added.
    if ($this->languageManager
      ->isMultilingual()) {
      $header['language_name'] = [
        'data' => $this
          ->t('Language'),
        'field' => 'langcode',
        'specifier' => 'langcode',
        'class' => [
          RESPONSIVE_PRIORITY_MEDIUM,
        ],
      ];
    }
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {

    /** @var \Drupal\Core\Path\Entity\PathAlias $entity */
    $langcode = $entity
      ->language()
      ->getId();
    $alias = $entity
      ->getAlias();
    $path = $entity
      ->getPath();
    $url = Url::fromUserInput($path);
    $row['data']['alias']['data'] = [
      '#type' => 'link',
      '#title' => Unicode::truncate($alias, 50, FALSE, TRUE),
      '#url' => $url
        ->setOption('attributes', [
        'title' => $alias,
      ]),
    ];
    $row['data']['path']['data'] = [
      '#type' => 'link',
      '#title' => Unicode::truncate($path, 50, FALSE, TRUE),
      '#url' => $url
        ->setOption('attributes', [
        'title' => $path,
      ]),
    ];
    if ($this->languageManager
      ->isMultilingual()) {
      $row['data']['language_name'] = $this->languageManager
        ->getLanguageName($langcode);
    }
    $row['data']['operations']['data'] = $this
      ->buildOperations($entity);

    // If the system path maps to a different URL alias, highlight this table
    // row to let the user know of old aliases.
    if ($alias != $this->aliasManager
      ->getAliasByPath($path, $langcode)) {
      $row['class'] = [
        'warning',
      ];
    }
    return $row;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 5
EntityHandlerBase::moduleHandler protected function Gets the module handler. 5
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityListBuilder::$entityType protected property Information about the entity type.
EntityListBuilder::$entityTypeId protected property The entity type ID.
EntityListBuilder::$limit protected property The number of entities to list per page, or FALSE to list all entities.
EntityListBuilder::$storage protected property The entity storage class. 1
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity.
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL. 1
EntityListBuilder::getDefaultOperations protected function Gets this list's default operations. 2
EntityListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations 2
EntityListBuilder::getStorage public function Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle protected function Gets the title of the page. 1
EntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load 4
MessengerTrait::$messenger protected property The messenger. 18
MessengerTrait::messenger public function Gets the messenger. 18
MessengerTrait::setMessenger public function Sets the messenger.
PathAliasListBuilder::$aliasManager protected property The path alias manager.
PathAliasListBuilder::$currentRequest protected property The current request.
PathAliasListBuilder::$formBuilder protected property The form builder.
PathAliasListBuilder::$languageManager protected property The language manager.
PathAliasListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
PathAliasListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
PathAliasListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
PathAliasListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. Overrides EntityListBuilder::getEntityIds
PathAliasListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
PathAliasListBuilder::__construct public function Constructs a new PathAliasListBuilder object. Overrides EntityListBuilder::__construct
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. 3
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. 1
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.