oauth2_server-2.0.x-dev/src/ScopeListBuilder.php

<?php

namespace Drupal\oauth2_server;

use Drupal\Component\Utility\Html;
use Drupal\Core\Config\Entity\ConfigEntityInterface;
use Drupal\Core\Config\Entity\ConfigEntityListBuilder;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Url;

/**
 * Builds a listing of oauth2 server entities.
 *
 * @package Drupal\oauth2_server
 */
class ScopeListBuilder extends ConfigEntityListBuilder {

  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);
    if ($entity instanceof ScopeInterface) {
      $route_parameters['oauth2_server'] = $entity->getServer()->id();
      $route_parameters['oauth2_server_scope'] = $entity->id();

      $operations['edit'] = [
        'title' => $this->t('Edit'),
        'weight' => 20,
        'url' => new Url('entity.oauth2_server.scopes.edit_form', $route_parameters),
      ];
      $operations['delete'] = [
        'title' => $this->t('Delete'),
        'weight' => 30,
        'url' => new Url('entity.oauth2_server.scopes.delete_form', $route_parameters),
      ];
    }
    return $operations;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    /** @var \Drupal\Core\Config\Entity\ConfigEntityInterface $entity */
    $row = parent::buildRow($entity);
    return [
      'data' => [
        'label' => [
          'data' => $entity->label(),
          'class' => ['oauth2-server-scope-name'],
        ],
        'operations' => $row['operations'],
      ],
      'title' => $this->t('ID: @name', ['@name' => $entity->id()]),
      'class' => [
        Html::cleanCssIdentifier($entity->getEntityTypeId() . '-' . $entity->id()),
      ],
    ];
  }

  /**
   * {@inheritdoc}
   *
   * @param \Drupal\oauth2_server\ServerInterface|null $oauth2_server
   *   The server of which the scopes should be limited to.
   *
   * @return array
   *   The scope list as a renderable array.
   */
  public function render(?ServerInterface $oauth2_server = NULL) {
    $build = [];
    $build['table'] = [
      '#type' => 'table',
      '#header' => $this->buildHeader(),
      '#title' => $this->getTitle(),
      '#rows' => [],
      '#cache' => [
        'contexts' => $this->entityType->getListCacheContexts(),
      ],
      '#attributes' => [
        'id' => 'oauth2-server-scope-entity-list',
      ],
    ];
    $build['table']['#empty'] = $this->t('No scopes available. <a href="@link">Add scope</a>.', [
      '@link' => Url::fromRoute('entity.oauth2_server.scopes.add_form', ['oauth2_server' => $oauth2_server->id()])->toString(),
    ]);

    if ($oauth2_server) {
      /** @var \Drupal\oauth2_server\ScopeInterface[] $scopes */
      $scopes = $this->storage->loadByProperties(['server_id' => $oauth2_server->id()]);
    }
    else {
      /** @var \Drupal\oauth2_server\ScopeInterface[] $scopes */
      $scopes = $this->storage->loadMultiple();
    }

    $this->sortAlphabetically($scopes);
    foreach ($scopes as $entity) {
      if ($row = $this->buildRow($entity)) {
        $build['table']['#rows'][$entity->id()] = $row;
      }
    }

    $build['pager'] = [
      '#type' => 'pager',
    ];
    return $build;
  }

  /**
   * Sorts an array of entities alphabetically.
   *
   * Will preserve the key/value association of the array.
   *
   * @param \Drupal\Core\Config\Entity\ConfigEntityInterface[] $entities
   *   An array of config entities.
   */
  protected function sortAlphabetically(array &$entities) {
    uasort($entities, function (ConfigEntityInterface $a, ConfigEntityInterface $b) {
      return strnatcasecmp($a->label(), $b->label());
    });
  }

}