You are here

Home » API reference » JSON:API Extras 8 » JsonapiResourceConfigListBuilder.php

class JsonapiResourceConfigListBuilder in JSON:API Extras 8

Same name and namespace in other branches
  1. 8.3 src/JsonapiResourceConfigListBuilder.php \Drupal\jsonapi_extras\JsonapiResourceConfigListBuilder
  2. 8.2 src/JsonapiResourceConfigListBuilder.php \Drupal\jsonapi_extras\JsonapiResourceConfigListBuilder

Provides a listing of JSON API Resource Config entities.

Hierarchy

Expanded class hierarchy of JsonapiResourceConfigListBuilder

File

src/JsonapiResourceConfigListBuilder.php, line 16

Namespace

Drupal\jsonapi_extras
View source 
class JsonapiResourceConfigListBuilder extends ConfigEntityListBuilder {

  /**
   * The JSON API configurable resource type repository.
   *
   * @var \Drupal\jsonapi_extras\ResourceType\ConfigurableResourceTypeRepository
   */
  protected $resourceTypeRepository;

  /**
   * The JSON API extras config.
   *
   * @var \Drupal\Core\Config\ImmutableConfig
   */
  protected $config;

  /**
   * Constructs new JsonapiResourceConfigListBuilder.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The storage.
   * @param \Drupal\jsonapi_extras\ResourceType\ConfigurableResourceTypeRepository $resource_type_repository
   *   The JSON API configurable resource type repository.
   * @param \Drupal\Core\Config\ImmutableConfig $config
   *   The config instance.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, ConfigurableResourceTypeRepository $resource_type_repository, ImmutableConfig $config) {
    parent::__construct($entity_type, $storage);
    $this->resourceTypeRepository = $resource_type_repository;
    $this->config = $config;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity.manager')
      ->getStorage($entity_type
      ->id()), $container
      ->get('jsonapi.resource_type.repository'), $container
      ->get('config.factory')
      ->get('jsonapi_extras.settings'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header = [
      'name' => $this
        ->t('Name'),
      'entity_type' => $this
        ->t('Entity type'),
      'bundle' => $this
        ->t('Bundle'),
      'path' => $this
        ->t('Path'),
      'status' => $this
        ->t('Status'),
      'state' => $this
        ->t('State'),
      'operations' => $this
        ->t('Operations'),
    ];
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $list = [];
    $resource_status = [
      'enabled' => t('Enabled Resources'),
      'disabled' => t('Disabled resources'),
    ];
    $title = $this
      ->t('Filter resources by name, entity type, bundle or path.');
    $list['status']['filters']['text'] = [
      '#type' => 'search',
      '#title' => $this
        ->t('Filter'),
      '#title_display' => 'invisible',
      '#size' => 60,
      '#placeholder' => $title,
      '#attributes' => [
        'class' => [
          'jsonapi-resources-filter-text',
        ],
        'data-table' => '.jsonapi-resources-table',
        'autocomplete' => 'off',
        'title' => $title,
      ],
    ];
    foreach ($resource_status as $status => $label) {
      $list[$status] = [
        '#type' => 'details',
        '#title' => $label,
        '#open' => $status == 'enabled',
        '#attributes' => [
          'id' => 'jsonapi-' . $status . '-resources-list',
        ],
        '#attached' => [
          'library' => [
            'jsonapi_extras/admin',
          ],
        ],
      ];
      $list[$status]['table'] = [
        '#type' => 'table',
        '#header' => [
          'name' => $this
            ->t('Name'),
          'entity_type' => $this
            ->t('Entity type'),
          'bundle' => $this
            ->t('Bundle'),
          'path' => $this
            ->t('Path'),
          'status' => $this
            ->t('Status'),
          'state' => $this
            ->t('State'),
          'operations' => $this
            ->t('Operations'),
        ],
        '#attributes' => [
          'class' => [
            'jsonapi-resources-table',
          ],
        ],
        '#attached' => [
          'library' => [
            'jsonapi_extras/admin',
          ],
        ],
      ];
    }
    $prefix = $this->config
      ->get('path_prefix');
    foreach ($this->resourceTypeRepository
      ->all() as $resource_type) {

      /** @var \Drupal\jsonapi_extras\ResourceType\ConfigurableResourceType $resource_type */
      $entity_type_id = $resource_type
        ->getEntityTypeId();
      $bundle = $resource_type
        ->getBundle();
      $row = [
        'name' => [
          '#plain_text' => $resource_type
            ->getTypeName(),
        ],
        'entity_type' => [
          '#plain_text' => $entity_type_id,
        ],
        'bundle' => [
          '#plain_text' => $bundle,
        ],
        'path' => [
          '#type' => 'html_tag',
          '#tag' => 'code',
          '#value' => sprintf('/%s/%s/%s', $prefix, $entity_type_id, $bundle),
        ],
        'status' => [
          '#type' => 'html_tag',
          '#tag' => 'span',
          '#value' => $this
            ->t('Enabled'),
          '#attributes' => [
            'class' => [
              'label',
              'label--status',
            ],
          ],
        ],
        'state' => [
          '#type' => 'html_tag',
          '#tag' => 'span',
          '#value' => $this
            ->t('Default'),
          '#attributes' => [
            'class' => [
              'label',
            ],
          ],
        ],
        'operations' => [
          '#type' => 'operations',
          '#links' => [
            'overwrite' => [
              'title' => t('Overwrite'),
              'weight' => -10,
              'url' => Url::fromRoute('entity.jsonapi_resource_config.add_form', [
                'entity_type_id' => $entity_type_id,
                'bundle' => $bundle,
              ]),
            ],
          ],
        ],
      ];

      /** @var \Drupal\jsonapi_extras\Entity\JsonapiResourceConfig $resource_config */
      $resource_config = $resource_type
        ->getJsonapiResourceConfig();
      if ($resource_config
        ->id()) {
        $row['state']['#value'] = $this
          ->t('Overwritten');
        $row['state']['#attributes']['class'][] = 'label--overwritten';
        $row['operations']['#links'] = $this
          ->getDefaultOperations($resource_config);
        $row['operations']['#links']['delete']['title'] = $this
          ->t('Revert');
        if ($config_path = $resource_config
          ->get('path')) {
          $row['path']['#value'] = sprintf('/%s/%s', $prefix, $config_path);
        }
        if ($resource_config
          ->get('disabled')) {
          $row['status']['#value'] = $this
            ->t('Disabled');
          $row['status']['#attributes']['class'][] = 'label--status--disabled';
        }
      }
      $list[$resource_config
        ->get('disabled') ? 'disabled' : 'enabled']['table'][] = $row;
    }
    return $list;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigEntityListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations 15
ConfigEntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load 7
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::buildRow public function Builds a row for an entity in the entity listing. 26
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
JsonapiResourceConfigListBuilder::$config protected property The JSON API extras config.
JsonapiResourceConfigListBuilder::$resourceTypeRepository protected property The JSON API configurable resource type repository.
JsonapiResourceConfigListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
JsonapiResourceConfigListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
JsonapiResourceConfigListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
JsonapiResourceConfigListBuilder::__construct public function Constructs new JsonapiResourceConfigListBuilder. 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.