You are here

Home » API reference » Layout builder library 8 » LayoutListBuilder.php

class LayoutListBuilder in Layout builder library 8

Defines a list builder for layouts.

Hierarchy

Expanded class hierarchy of LayoutListBuilder

File

src/Entity/LayoutListBuilder.php, line 19

Namespace

Drupal\layout_library\Entity
View source 
class LayoutListBuilder extends EntityListBuilder {

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

  /**
   * Entity type bundle info.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $bundleInfo;

  /**
   * Current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * Constructs a new LayoutListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   Entity type.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   Entity storage.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   Entity type manager.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $bundleInfo
   *   Bundle info.
   * @param \Drupal\Core\Session\AccountInterface $currentUser
   *   Current user.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, EntityTypeManagerInterface $entityTypeManager, EntityTypeBundleInfoInterface $bundleInfo, AccountInterface $currentUser) {
    parent::__construct($entity_type, $storage);
    $this->entityTypeManager = $entityTypeManager;
    $this->bundleInfo = $bundleInfo;
    $this->currentUser = $currentUser;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    $entityTypeManager = $container
      ->get('entity_type.manager');
    return new static($entity_type, $entityTypeManager
      ->getStorage($entity_type
      ->id()), $entityTypeManager, $container
      ->get('entity_type.bundle.info'), $container
      ->get('current_user'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $rows = [
      'label' => $this
        ->t('Label'),
      'entity_type_id' => $this
        ->t('Entity Type'),
      'bundle' => $this
        ->t('Bundle'),
    ];
    return $rows + parent::buildHeader();
  }

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

    /** @var \Drupal\layout_library\Entity\Layout $entity */
    $targetEntityTypeId = $entity
      ->getTargetEntityType();
    $bundle_info = $this->bundleInfo
      ->getBundleInfo($targetEntityTypeId);
    $bundle_name = isset($bundle_info[$entity
      ->getTargetBundle()]) ? $bundle_info[$entity
      ->getTargetBundle()]['label'] : $entity
      ->getTargetBundle();
    $row = [
      'label' => [
        'data' => $entity
          ->label(),
      ],
      'entity_type_id' => [
        'data' => $this->entityTypeManager
          ->getDefinition($targetEntityTypeId)
          ->getLabel(),
      ],
      'bundle' => [
        'data' => $bundle_name,
      ],
    ];
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  protected function getDefaultOperations(EntityInterface $entity) {

    /** @var \Drupal\layout_library\Entity\Layout $entity */
    $operations = [];
    if ($this->currentUser
      ->hasPermission('administer ' . $entity
      ->getTargetEntityType() . ' display')) {
      $operations['edit'] = [
        'title' => $this
          ->t('Edit layout'),
        'weight' => 0,
        'url' => $this
          ->getLayoutBuilderUrl($entity),
      ];
    }
    return $operations + parent::getDefaultOperations($entity);
  }

  /**
   * {@inheritdoc}
   */
  protected function getLayoutBuilderUrl(Layout $layout) {
    return Url::fromRoute("layout_builder.layout_library.{$layout->getTargetEntityType()}.view", $this
      ->getRouteParameters($layout));
  }

  /**
   * {@inheritdoc}
   */
  protected function getRouteParameters(Layout $layout) {
    $route_parameters = FieldUI::getRouteBundleParameter($this->entityTypeManager
      ->getDefinition($layout
      ->getTargetEntityType()), $layout
      ->getTargetBundle());
    $route_parameters['layout'] = $layout
      ->id();
    return $route_parameters;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 2
EntityHandlerBase::moduleHandler protected function Gets the module handler. 2
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. 3
EntityListBuilder::$storage protected property The entity storage class. 1
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. 2
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL.
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 4
EntityListBuilder::getLabel Deprecated protected function Gets the label of an entity.
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
EntityListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render 16
LayoutListBuilder::$bundleInfo protected property Entity type bundle info.
LayoutListBuilder::$currentUser protected property Current user.
LayoutListBuilder::$entityTypeManager protected property Entity type manager.
LayoutListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
LayoutListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
LayoutListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
LayoutListBuilder::getDefaultOperations protected function Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations
LayoutListBuilder::getLayoutBuilderUrl protected function
LayoutListBuilder::getRouteParameters protected function
LayoutListBuilder::__construct public function Constructs a new LayoutListBuilder object. Overrides EntityListBuilder::__construct
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.