class WebformOptionsListBuilder in Webform 8.5

Same name and namespace in other branches

6.x src/WebformOptionsListBuilder.php \Drupal\webform\WebformOptionsListBuilder

Defines a class to build a listing of webform options entities.

View source

class WebformOptionsListBuilder extends ConfigEntityListBuilder {

  /**
   * Search keys.
   *
   * @var string
   */
  protected $keys;

  /**
   * Search category.
   *
   * @var string
   */
  protected $category;

  /**
   * Constructs a new WebformOptionsListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage class.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, RequestStack $request_stack) {
    parent::__construct($entity_type, $storage);
    $this->request = $request_stack
      ->getCurrentRequest();
    $this->keys = $this->request->query
      ->get('search');
    $this->category = $this->request->query
      ->get('category');
  }

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

  /**
   * {@inheritdoc}
   */
  public function render() {

    // Handler autocomplete redirect.
    if ($this->keys && preg_match('#\\(([^)]+)\\)$#', $this->keys, $match)) {
      if ($webform_options = $this
        ->getStorage()
        ->load($match[1])) {
        return new RedirectResponse($webform_options
          ->toUrl()
          ->setAbsolute(TRUE)
          ->toString());
      }
    }
    $build = [];

    // Filter form.
    $build['filter_form'] = $this
      ->buildFilterForm();

    // Display info.
    $build['info'] = $this
      ->buildInfo();

    // Table.
    $build += parent::render();
    $build['table']['#sticky'] = TRUE;

    // Attachments.
    $build['#attached']['library'][] = 'webform/webform.admin.dialog';
    return $build;
  }

  /**
   * Build the filter form.
   *
   * @return array
   *   A render array representing the filter form.
   */
  protected function buildFilterForm() {
    $categories = $this
      ->getStorage()
      ->getCategories();
    return \Drupal::formBuilder()
      ->getForm('\\Drupal\\webform\\Form\\WebformOptionsFilterForm', $this->keys, $this->category, $categories);
  }

  /**
   * Build information summary.
   *
   * @return array
   *   A render array representing the information summary.
   */
  protected function buildInfo() {
    $total = $this
      ->getQuery($this->keys, $this->category)
      ->count()
      ->execute();
    if (!$total) {
      return [];
    }
    return [
      '#markup' => $this
        ->formatPlural($total, '@total option', '@total options', [
        '@total' => $total,
      ]),
      '#prefix' => '<div>',
      '#suffix' => '</div>',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('Label');
    $header['category'] = $this
      ->t('Category');
    $header['likert'] = $this
      ->t('Likert');
    $header['alter'] = [
      'data' => $this
        ->t('Altered'),
      'class' => [
        RESPONSIVE_PRIORITY_LOW,
      ],
    ];
    $header['options'] = [
      'data' => $this
        ->t('Options'),
      'class' => [
        RESPONSIVE_PRIORITY_LOW,
      ],
    ];
    $header['used_by'] = [
      'data' => $this
        ->t('Used by'),
      'class' => [
        RESPONSIVE_PRIORITY_LOW,
      ],
    ];
    return $header + parent::buildHeader();
  }

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

    /** @var \Drupal\webform\WebformOptionsInterface $entity */
    $row['label'] = $entity
      ->toLink($entity
      ->label(), 'edit-form');
    $row['category'] = $entity
      ->get('category');
    $row['likert'] = $entity
      ->isLikert() ? $this
      ->t('Yes') : $this
      ->t('No');
    $row['alter'] = $entity
      ->hasAlterHooks() ? $this
      ->t('Yes') : $this
      ->t('No');
    $row['options'] = $this
      ->buildOptions($entity);
    $row['used_by'] = $this
      ->buildUsedBy($entity);
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $entity, $type = 'edit') {
    $operations = parent::getDefaultOperations($entity);
    if ($entity
      ->access('duplicate')) {
      $operations['duplicate'] = [
        'title' => $this
          ->t('Duplicate'),
        'weight' => 23,
        'url' => Url::fromRoute('entity.webform_options.duplicate_form', [
          'webform_options' => $entity
            ->id(),
        ]),
      ];
    }
    if (isset($operations['delete'])) {
      $operations['delete']['attributes'] = WebformDialogHelper::getModalDialogAttributes(WebformDialogHelper::DIALOG_NARROW);
    }
    return $operations;
  }

  /**
   * Build list of webforms and composite elements that the webform options is used by.
   *
   * @param \Drupal\webform\WebformOptionsInterface $webform_options
   *   A webform options entity.
   *
   * @return array
   *   Table data containing list of webforms and composite elements that the
   *   webform options is used by.
   */
  protected function buildUsedBy(WebformOptionsInterface $webform_options) {
    $links = [];
    $webforms = $this
      ->getStorage()
      ->getUsedByWebforms($webform_options);
    foreach ($webforms as $id => $title) {
      $links[] = [
        '#type' => 'link',
        '#title' => $title,
        '#url' => Url::fromRoute('entity.webform.canonical', [
          'webform' => $id,
        ]),
        '#suffix' => '</br>',
      ];
    }
    $elements = $this
      ->getStorage()
      ->getUsedByCompositeElements($webform_options);
    foreach ($elements as $id => $title) {
      $links[] = [
        '#markup' => $title,
        '#suffix' => '</br>',
      ];
    }
    return [
      'nowrap' => TRUE,
      'data' => $links,
    ];
  }

  /**
   * Build list of webform options.
   *
   * @param \Drupal\webform\WebformOptionsInterface $webform_options
   *   A webform options entity.
   *
   * @return string
   *   Semi-colon delimited list of webform options.
   */
  protected function buildOptions(WebformOptionsInterface $webform_options) {
    $element = [
      '#options' => $webform_options
        ->id(),
    ];
    $options = WebformOptions::getElementOptions($element);
    $options = OptGroup::flattenOptions($options);
    foreach ($options as $key => &$value) {
      if ($key !== $value) {
        $value .= ' (' . $key . ')';
      }
    }
    return implode('; ', array_slice($options, 0, 12)) . (count($options) > 12 ? '; …' : '');
  }

  /**
   * {@inheritdoc}
   */
  public function buildOperations(EntityInterface $entity) {
    return parent::buildOperations($entity) + [
      '#prefix' => '<div class="webform-dropbutton">',
      '#suffix' => '</div>',
    ];
  }

  /**
   * Get the base entity query filtered by search and category.
   *
   * @param string $keys
   *   (optional) Search key.
   * @param string $category
   *   (optional) Category.
   *
   * @return \Drupal\Core\Entity\Query\QueryInterface
   *   An entity query.
   */
  protected function getQuery($keys = '', $category = '') {
    $query = $this
      ->getStorage()
      ->getQuery();

    // Filter by key(word).
    if ($keys) {
      $or = $query
        ->orConditionGroup()
        ->condition('id', $keys, 'CONTAINS')
        ->condition('title', $keys, 'CONTAINS')
        ->condition('options', $keys, 'CONTAINS');
      $query
        ->condition($or);
    }

    // Filter by category.
    if ($category) {
      $query
        ->condition('category', $category);
    }
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntityIds() {
    $header = $this
      ->buildHeader();
    $query = $this
      ->getQuery($this->keys, $this->category);
    $query
      ->tableSort($header);
    $query
      ->pager($this->limit);
    return $query
      ->execute();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::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
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.
WebformOptionsListBuilder::$category	protected	property	Search category.
WebformOptionsListBuilder::$keys	protected	property	Search keys.
WebformOptionsListBuilder::buildFilterForm	protected	function	Build the filter form.
WebformOptionsListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
WebformOptionsListBuilder::buildInfo	protected	function	Build information summary.
WebformOptionsListBuilder::buildOperations	public	function	Builds a renderable list of operation links for the entity. Overrides EntityListBuilder::buildOperations
WebformOptionsListBuilder::buildOptions	protected	function	Build list of webform options.
WebformOptionsListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
WebformOptionsListBuilder::buildUsedBy	protected	function	Build list of webforms and composite elements that the webform options is used by.
WebformOptionsListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
WebformOptionsListBuilder::getDefaultOperations	public	function	Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
WebformOptionsListBuilder::getEntityIds	protected	function	Loads entity IDs using a pager sorted by the entity id. Overrides EntityListBuilder::getEntityIds
WebformOptionsListBuilder::getQuery	protected	function	Get the base entity query filtered by search and category.
WebformOptionsListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
WebformOptionsListBuilder::__construct	public	function	Constructs a new WebformOptionsListBuilder object. Overrides EntityListBuilder::__construct

You are here

class WebformOptionsListBuilder in Webform 8.5

Hierarchy

See also

File

Namespace

Members

API Navigation