You are here

Home » API reference » Group Menu 8 » GroupMenuContentListBuilder.php

class GroupMenuContentListBuilder in Group Menu 8

Provides a list controller for menus entities in a group.

Hierarchy

Expanded class hierarchy of GroupMenuContentListBuilder

File

src/GroupMenuContentListBuilder.php, line 12

Namespace

Drupal\groupmenu
View source 
class GroupMenuContentListBuilder extends GroupContentListBuilder {

  /**
   * {@inheritdoc}
   */
  protected function getEntityIds() {
    $plugin_id = 'group_menu:menu';
    $group_content_types = GroupContentType::loadByContentPluginId($plugin_id);

    // If we don't have any group menu plugins, we don't have any group menu's.
    if (empty($group_content_types)) {
      return [];
    }
    $query = $this
      ->getStorage()
      ->getQuery();

    // Filter by group menu plugins.
    $query
      ->condition('type', array_keys($group_content_types), 'IN');

    // Only show group content for the group on the route.
    $query
      ->condition('gid', $this->group
      ->id());

    // Only add the pager if a limit is specified.
    if ($this->limit) {
      $query
        ->pager($this->limit);
    }
    $query
      ->sort($this->entityType
      ->getKey('id'));
    return $query
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header = [
      'id' => $this
        ->t('ID'),
      'label' => $this
        ->t('Menu'),
    ];
    $row = $header + parent::buildHeader();
    unset($row['entity_type'], $row['plugin']);
    return $row;
  }

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

    /** @var \Drupal\group\Entity\GroupContentInterface $entity */
    $row['id'] = $entity
      ->id();
    $row['label']['data'] = $entity
      ->getEntity()
      ->toLink(NULL, 'edit-form');
    $row = $row + parent::buildRow($entity);
    unset($row['entity_type'], $row['plugin']);
    return $row;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build = parent::render();
    $build['table']['#empty'] = $this
      ->t("There are no menus related to this group yet.");
    return $build;
  }

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

    /** @var \Drupal\group\Entity\GroupContentInterface $entity */
    $operations = parent::getDefaultOperations($entity);

    // Add view operation for the Group Content Relation.
    if (!isset($operations['view']) && $entity
      ->access('view')) {
      $operations['view'] = [
        'title' => $this
          ->t('View relation'),
        'weight' => 1,
        'url' => $entity
          ->toUrl(),
      ];
    }

    // Slap on redirect destinations for the administrative operations.
    $destination = $this->redirectDestination
      ->getAsArray();
    foreach ($operations as $key => $operation) {
      $operations[$key]['query'] = $destination;
    }

    // Add operations to edit and delete the actual entity.
    if ($entity
      ->getEntity()
      ->access('update')) {
      $operations['edit-entity'] = [
        'title' => $this
          ->t('Edit menu'),
        'weight' => 102,
        'url' => $entity
          ->getEntity()
          ->toUrl(),
      ];
    }
    if ($entity
      ->getEntity()
      ->access('delete')) {
      $operations['delete-entity'] = [
        'title' => $this
          ->t('Delete menu'),
        'weight' => 103,
        'url' => $entity
          ->getEntity()
          ->toUrl('delete-form'),
      ];
    }
    return $operations;
  }

}

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::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
GroupContentListBuilder::$entityTypeManager protected property The entity type manager.
GroupContentListBuilder::$group protected property The group to show the content for.
GroupContentListBuilder::$redirectDestination protected property The redirect destination. Overrides RedirectDestinationTrait::$redirectDestination
GroupContentListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
GroupContentListBuilder::__construct public function Constructs a new GroupContentListBuilder object. Overrides EntityListBuilder::__construct
GroupMenuContentListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides GroupContentListBuilder::buildHeader
GroupMenuContentListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides GroupContentListBuilder::buildRow
GroupMenuContentListBuilder::getDefaultOperations protected function Gets this list's default operations. Overrides GroupContentListBuilder::getDefaultOperations
GroupMenuContentListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. Overrides GroupContentListBuilder::getEntityIds
GroupMenuContentListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides GroupContentListBuilder::render
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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.