BundleListSelector.php

Go to the documentation of this file.

<?php

namespace Drupal\paragraphs_editor\Plugin\ParagraphsEditor\bundle_selector;

use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityListBuilder;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\paragraphs_editor\EditorCommand\CommandContextInterface;
use Drupal\paragraphs_editor\Plugin\ParagraphsEditor\BundleSelectorInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides a simple listing of bundles to choose from.
 *
 * @ParagraphsEditorBundleSelector(
 *   id = "list",
 *   title = @Translation("List"),
 *   description = @Translation("Provides a basic list of bundles."),
 * )
 */
class BundleListSelector extends EntityListBuilder implements BundleSelectorInterface, ContainerFactoryPluginInterface {

  /**
   * The plugin id for this plugin.
   *
   * @var string
   */
  protected $pluginId;

  /**
   * The plugin definition for this plugin.
   *
   * @var object
   */
  protected $pluginDefinition;

  /**
   * The command context the plugin is executing within.
   *
   * @var \Drupal\paragraphs_editor\EditorCommand\CommandContextInterface
   */
  protected $context;

  /**
   * The number of bundles to show on a page.
   *
   * @var int
   */
  protected $limit = 15;

  /**
   * Creates a bundle selector form object.
   *
   * @param string $plugin_id
   *   The bundle selector plugin id.
   * @param mixed $plugin_definition
   *   The bundle selector plugin definition.
   * @param \Drupal\paragraphs_editor\EditorCommand\CommandContextInterface $context
   *   The editor command context to build the bundle form for.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager service.
   */
  public function __construct($plugin_id, $plugin_definition, CommandContextInterface $context, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($entity_type_manager->getDefinition('paragraphs_type'), $entity_type_manager->getStorage('paragraphs_type'));
    $this->pluginId = $plugin_id;
    $this->pluginDefinition = $plugin_definition;
    $this->context = $context;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static(
      $plugin_id,
      $plugin_definition,
      $configuration['context'],
      $container->get('entity_type.manager')
    );
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['search_container'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'paragraphs-editor-bundle-selector-search',
        ],
      ],
      '#attached' => [
        'library' => [
          'paragraphs_editor/core',
        ],
      ],
    ];
    $form['search_container']['search'] = [
      '#title' => $this->t('Search'),
      '#type' => 'textfield',
      '#attributes' => [
        'class' => [
          'paragraphs-editor-bundle-selector-search__input',
        ],
        'autocomplete' => 'off',
      ],
    ];
    $form['search_container']['search_button'] = [
      '#type' => 'submit',
      '#value' => 'Search',
      '#submit' => [],
      '#limit_validation_errors' => [],
      '#ajax' => [
        'callback' => [get_class($this), 'ajaxSearch'],
        'wrapper' => 'paragraphs-editor-bundle-selector-options',
      ],
      '#attributes' => [
        'class' => [
          'paragraphs-editor-bundle-selector-search__submit',
          'visually-hidden',
        ],
      ],
    ];
    $form['options'] = [
      '#prefix' => '<div id="paragraphs-editor-bundle-selector-options">',
      '#suffix' => '</div>',
      '#type' => 'table',
      '#header' => $this->buildHeader(),
      '#empty' => t('Could not find any matching options.', ['@label' => $this->entityType->getLabel()]),
    ];

    $input = $form_state->getUserInput();
    $search = isset($input['search']) ? $input['search'] : '';
    $search = trim(preg_replace('/\(.*\)$/', '', $search));
    $entities = $this->load($search);
    foreach ($entities as $entity) {
      $row = $this->buildRow($entity);
      if (isset($row['label'])) {
        $row['label'] = ['#markup' => $row['label']];
      }
      $form['options'][$entity->id()] = $row;
    }

    $form['cancel'] = [
      '#type' => 'link',
      '#title' => $this->t('Cancel'),
      '#url' => $this->context->createCommandUrl('cancel'),
      '#attributes' => [
        'class' => [
          'button',
          'use-ajax',
        ],
      ],
    ];

    return $form;
  }

  /**
   * Callback for handling the search box updates over ajax.
   *
   * @param array $form
   *   The regenerated form.
   * @param \Drupal\Core\FOrm\FormStateInterface $form_state
   *   The form state.
   *
   * @return array
   *   The portion of the form to deliver.
   */
  public static function ajaxSearch(array $form, FormStateInterface $form_state) {
    return $form['options'];
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header = [];
    $header['label'] = t('Type');
    $header['operations'] = '';
    return $header;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildOperations(EntityInterface $entity) {
    // Create an ajax link that will take the user to an 'insert' endpoint for
    // the bundle the operation relates to.
    $build = [];
    $build['add'] = [
      '#type' => 'link',
      '#title' => t('Add'),
      '#url' => $this->context->createCommandUrl('insert', [
        'bundle_name' => $entity->id(),
      ]),
      '#attributes' => [
        'class' => [
          'button',
          'use-ajax',
        ],
      ],
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    // This needs to be implemented, but we don't have anything to validate.
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    // This needs to be implemented, but we don't have anything to submit.
  }

  /**
   * {@inheritdoc}
   */
  public function load($search = NULL) {
    $entity_ids = $this->getEntityIds($search);
    $entities = $this->storage->loadMultiple($entity_ids);

    // Sort the entities using the entity class's sort() method.
    // See \Drupal\Core\Config\Entity\ConfigEntityBase::sort().
    uasort($entities, [$this->entityType->getClass(), 'sort']);
    return $entities;
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntityIds($search = NULL) {
    $query = $this->getStorage()->getQuery()
      ->sort($this->entityType->getKey('id'));

    if ($search) {
      $query->condition('label', $search, 'CONTAINS');
    }

    $this->context->getBundleFilter()->filterQuery($query);

    // Only add the pager if a limit is specified.
    if ($this->limit) {
      $query->pager($this->limit);
    }
    $results = $query->execute();
    return is_array($results) ? $results : [];
  }

}