og-8.x-1.x-dev/src/Entity/OgRoleListBuilder.php

<?php

declare(strict_types=1);

namespace Drupal\og\Entity;

use Drupal\Core\Config\Entity\DraggableListBuilder;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Url;
use Drupal\og\Og;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

/**
 * Defines a class to build a listing of og_role entities.
 *
 * @see \Drupal\og\Entity\OgRole
 */
class OgRoleListBuilder extends DraggableListBuilder {

  /**
   * The group entity type.
   */
  protected string $groupType;

  /**
   * The group entity bundle ID.
   */
  protected string $groupBundle;

  /**
   * {@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('current_route_match')
    );
  }

  /**
   * Constructs a new OgRoleListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage class.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route matcher.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, RouteMatchInterface $route_match) {
    parent::__construct($entity_type, $storage);

    // When on the default og_role list route,
    // we should have a group entity type and bundle.
    if ($route_match->getRouteName() == 'entity.og_role.collection') {
      $parameters = $route_match->getParameters();

      // Check if the route had a group type parameter.
      if ($parameters->has('entity_type_id')) {
        $this->groupType = $parameters->get('entity_type_id');
      }
      if ($parameters->has('bundle_id')) {
        $this->groupBundle = $parameters->get('bundle_id');
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntityIds() {
    $query = $this->getStorage()->getQuery()
      ->condition('group_type', $this->groupType, '=')
      ->condition('group_bundle', $this->groupBundle, '=')
      ->sort($this->entityType->getKey('weight'));

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

    return array_values($query->execute());
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'og_roles_admin';
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this->t('Name');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['label'] = $entity->label();
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $role) {
    $operations = parent::getDefaultOperations($role);

    // @todo If ($entity->hasLinkTemplate('edit-permissions-form')).
    $operations['permissions'] = [
      'title' => $this->t('Edit permissions'),
      'weight' => 20,
      'url' => Url::fromRoute('og_ui.permissions_edit_form', [
        'entity_type_id' => $this->groupType,
        'bundle_id' => $this->groupBundle,
        'role_name' => $role->getName(),
      ]),
    ];

    if ($role->isLocked()) {
      if (isset($operations['edit'])) {
        unset($operations['edit']);
      }

      if (isset($operations['delete'])) {
        unset($operations['delete']);
      }
    }

    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    // Return a 404 error when this is not a group.
    if (!Og::isGroup($this->groupType, $this->groupBundle)) {
      throw new NotFoundHttpException();
    }

    $build = parent::render();
    $build['entities']['#empty'] = $this->t('There are no OG roles available yet. <a href="@link">Add an OG role</a>.', [
      '@link' => Url::fromRoute('entity.og_role.add_form', [
        'entity_type_id' => $this->groupType,
        'bundle_id' => $this->groupBundle,
      ])->toString(),
    ]);

    return $build;
  }

}