You are here

Home » API reference » Facets 8 » FacetListBuilder.php

class FacetListBuilder in Facets 8

Builds a listing of facet entities.

Hierarchy

Expanded class hierarchy of FacetListBuilder

File

src/FacetListBuilder.php, line 17

Namespace

Drupal\facets
View source 
class FacetListBuilder extends DraggableListBuilder {

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

  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);
    if ($entity instanceof FacetInterface) {
      if ($entity
        ->access('update') && $entity
        ->hasLinkTemplate('edit-form')) {
        $operations['edit'] = [
          'title' => $this
            ->t('Edit'),
          'weight' => 10,
          'url' => $entity
            ->toUrl('edit-form'),
        ];
      }
      if ($entity
        ->access('update') && $entity
        ->hasLinkTemplate('settings-form')) {
        $operations['settings'] = [
          'title' => $this
            ->t('Facet settings'),
          'weight' => 20,
          'url' => $entity
            ->toUrl('settings-form'),
        ];
      }
      if ($entity
        ->access('update') && $entity
        ->hasLinkTemplate('clone-form')) {
        $operations['clone'] = [
          'title' => $this
            ->t('Clone facet'),
          'weight' => 90,
          'url' => $entity
            ->toUrl('clone-form'),
        ];
      }
      if ($entity
        ->access('delete') && $entity
        ->hasLinkTemplate('delete-form')) {
        $operations['delete'] = [
          'title' => $this
            ->t('Delete'),
          'weight' => 100,
          'url' => $entity
            ->toUrl('delete-form'),
        ];
      }
    }
    elseif ($entity instanceof FacetsSummaryInterface) {
      $operations['edit'] = [
        'title' => $this
          ->t('Edit'),
        'weight' => 10,
        'url' => $entity
          ->toUrl('edit-form'),
      ];
      if ($entity
        ->access('update') && $entity
        ->hasLinkTemplate('settings-form')) {
        $operations['settings'] = [
          'title' => $this
            ->t('Facet Summary settings'),
          'weight' => 20,
          'url' => $entity
            ->toUrl('settings-form'),
        ];
      }
      if ($entity
        ->access('delete') && $entity
        ->hasLinkTemplate('delete-form')) {
        $operations['delete'] = [
          'title' => $this
            ->t('Delete'),
          'weight' => 100,
          'url' => $entity
            ->toUrl('delete-form'),
        ];
      }
    }
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header = [
      'type' => $this
        ->t('Type'),
      'machine_name' => $this
        ->t('Machine name'),
      'title' => [
        'data' => $this
          ->t('Title'),
      ],
    ];
    return $header + parent::buildHeader();
  }

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

    /** @var \Drupal\facets\FacetInterface $entity */
    $facet_configs = \Drupal::entityTypeManager()
      ->getStorage('facets_facet')
      ->load($entity
      ->getConfigTarget());
    $row = [
      'type' => [
        '#theme_wrappers' => [
          'container' => [
            '#attributes' => [
              'class' => 'facets-type',
            ],
          ],
        ],
        '#type' => 'markup',
        '#markup' => 'Facet',
      ],
      'machine_name' => [
        '#markup' => $entity
          ->id(),
      ],
      'title' => [
        '#type' => 'link',
        '#title' => $facet_configs
          ->get('name'),
        '#suffix' => '<div>' . $entity
          ->getFieldAlias() . ' - ' . $entity
          ->getWidget()['type'] . '</div>',
        '#attributes' => [
          'class' => [
            'search-api-title',
          ],
        ],
      ] + $entity
        ->toUrl('edit-form')
        ->toRenderArray(),
      '#attributes' => [
        'title' => $this
          ->t('ID: @name', [
          '@name' => $entity
            ->id(),
        ]),
        'class' => [
          'facet',
        ],
      ],
    ];
    return array_merge_recursive($row, parent::buildRow($entity));
  }

  /**
   * Builds an array of facet summary for display in the overview.
   */
  public function buildFacetSummaryRow(FacetsSummaryInterface $entity) {
    $row = parent::buildRow($entity);
    return [
      'type' => [
        '#theme_wrappers' => [
          'container' => [
            '#attributes' => [
              'class' => 'facets-summary-type',
            ],
          ],
        ],
        '#type' => 'markup',
        '#markup' => 'Facets Summary',
      ],
      'machine_name' => [
        '#markup' => $entity
          ->id(),
      ],
      'title' => [
        '#theme_wrappers' => [
          'container' => [
            '#attributes' => [
              'class' => 'facets-title',
            ],
          ],
        ],
        '#type' => 'link',
        '#title' => $entity
          ->label(),
        '#attributes' => [
          'class' => [
            'search-api-title',
          ],
        ],
        '#wrapper_attributes' => [
          'colspan' => 2,
        ],
      ] + $entity
        ->toUrl('edit-form')
        ->toRenderArray(),
      'operations' => $row['operations'],
      '#attributes' => [
        'title' => $this
          ->t('ID: @name', [
          '@name' => $entity
            ->id(),
        ]),
        'class' => [
          'facet',
        ],
      ],
    ];
  }

  /**
   * Builds an array of facet sources for display in the overview.
   */
  public function buildFacetSourceRow(array $facet_source = []) {
    return [
      'type' => [
        '#theme_wrappers' => [
          'container' => [
            '#attributes' => [
              'class' => 'facets-type',
            ],
          ],
        ],
        '#type' => 'markup',
        '#markup' => 'Facet source',
      ],
      'title' => [
        '#theme_wrappers' => [
          'container' => [
            '#attributes' => [
              'class' => 'facets-title',
            ],
          ],
        ],
        '#type' => 'markup',
        '#markup' => $facet_source['id'],
        '#wrapper_attributes' => [
          'colspan' => 3,
        ],
      ],
      'operations' => [
        'data' => Link::createFromRoute($this
          ->t('Configure'), 'entity.facets_facet_source.edit_form', [
          'facets_facet_source' => $facet_source['id'],
        ])
          ->toRenderable(),
      ],
      '#attributes' => [
        'class' => [
          'facet-source',
          'facet-source-' . $facet_source['id'],
        ],
        'no_striping' => TRUE,
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $groups = $this
      ->loadGroups();
    $form['facets'] = [
      '#type' => 'table',
      '#header' => $this
        ->buildHeader(),
      '#empty' => $groups['lone_facets'] ? '' : $this
        ->t('There are no facet sources or facets defined.'),
      '#attributes' => [
        'class' => [
          'facets-groups-list',
        ],
      ],
    ];

    // When no facet sources are found, we should show a message that you can't
    // add facets yet.
    if (empty($groups['facet_source_groups'])) {
      return [
        '#markup' => $this
          ->t('You currently have no facet sources defined. You should start by adding a facet source before creating facets.<br />
           An example of a facet source is a view based on Search API or a Search API page.
           Other modules can also implement a facet source by providing a plugin that implements the FacetSourcePluginInterface.'),
      ];
    }
    $form['#attached']['library'][] = 'facets/drupal.facets.admin_css';
    foreach ($groups['facet_source_groups'] as $facet_source_group) {
      $subgroup_class = Html::cleanCssIdentifier('facets-weight-' . $facet_source_group['facet_source']['id']);
      $delta = round(count($facet_source_group['facets']) / 2);
      $form['facets']['#tabledrag'][] = [
        'action' => 'order',
        'relationship' => 'sibling',
        'group' => 'weight',
        'subgroup' => $subgroup_class,
      ];
      $form['facets'][$facet_source_group['facet_source']['id']] = $this
        ->buildFacetSourceRow($facet_source_group['facet_source']);
      foreach ($facet_source_group['facets'] as $facet) {
        if ($facet instanceof FacetInterface) {
          $form['facets'][$facet
            ->id()] = $this
            ->buildRow($facet);
          $form['facets'][$facet
            ->id()]['weight']['#attributes']['class'][] = $subgroup_class;
          $form['facets'][$facet
            ->id()]['weight']['#delta'] = $delta;
        }
        elseif ($facet instanceof FacetsSummaryInterface) {
          $form['facets'][$facet
            ->id()] = $this
            ->buildFacetSummaryRow($facet);
        }
      }
    }

    // Output the list of facets without a facet source separately.
    if (!empty($groups['lone_facets'])) {
      $subgroup_class = 'facets-weight-lone-facets';
      $form['facets']['#tabledrag'][] = [
        'action' => 'order',
        'relationship' => 'sibling',
        'group' => 'weight',
        'subgroup' => $subgroup_class,
      ];
      $form['facets']['lone_facets'] = [
        'type' => [
          '#theme_wrappers' => [
            'container' => [
              '#attributes' => [
                'class' => 'facets-type',
              ],
            ],
          ],
          '#type' => 'markup',
          '#markup' => '<h3>' . $this
            ->t('Facets not currently associated with any facet source') . '</h3>',
        ],
        '#wrapper_attributes' => [
          'colspan' => 4,
        ],
      ];

      /** @var \Drupal\facets\FacetInterface $facet */
      foreach ($groups['lone_facets'] as $facet) {

        // Facets core search moved into a separate project. Show a clean
        // message to notify users how to resolve their broken facets.
        if (substr($facet
          ->getFacetSourceId(), 0, 16) == 'core_node_search') {
          $project_link = Link::fromTextAndUrl('https://www.drupal.org/project/facets_core_search', Url::fromUri('https://www.drupal.org/project/facets_core_search'))
            ->toString();
          \Drupal::messenger()
            ->addError(t('Core search facets has been moved to a separate project. You need to download and enable this module from @project_link to continue using your core search facets.', [
            '@project_link' => $project_link,
          ]), 'error');
        }
        $form['facets'][$facet
          ->id()] = $this
          ->buildRow($facet);
        $form['facets'][$facet
          ->id()]['weight']['#attributes']['class'][] = $subgroup_class;
      }
    }
    $form['actions']['#type'] = 'actions';
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => t('Save'),
      '#button_type' => 'primary',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $entities = $this->storage
      ->loadMultiple(array_keys($form_state
      ->getValue('facets')));

    /** @var \Drupal\block\BlockInterface[] $entities */
    foreach ($entities as $entity_id => $entity) {
      $entity_values = $form_state
        ->getValue([
        'facets',
        $entity_id,
      ]);
      $entity
        ->setWeight($entity_values['weight']);
      $entity
        ->save();
    }
    \Drupal::messenger()
      ->addMessage(t('The facets have been updated.'));
  }

  /**
   * Loads facet sources and facets, grouped by facet sources.
   *
   * @return \Drupal\Core\Config\Entity\ConfigEntityInterface[][]
   *   An associative array with two keys:
   *   - facet sources: All available facet sources, each followed by all facets
   *     attached to it.
   *   - lone_facets: All facets that aren't attached to any facet source.
   */
  public function loadGroups() {
    $facet_source_plugin_manager = \Drupal::service('plugin.manager.facets.facet_source');
    $facets = $this
      ->load();
    $facets_summaries = [];
    if (\Drupal::moduleHandler()
      ->moduleExists('facets_summary')) {
      $facets_summaries = FacetsSummary::loadMultiple();
    }
    $facet_sources = $facet_source_plugin_manager
      ->getDefinitions();
    $facet_source_groups = [];
    foreach ($facet_sources as $facet_source) {
      $facet_source_groups[$facet_source['id']] = [
        'facet_source' => $facet_source,
        'facets' => [],
      ];
      foreach ($facets as $facet) {

        /** @var \Drupal\facets\FacetInterface $facet */
        if ($facet
          ->getFacetSourceId() == $facet_source['id']) {
          $facet_source_groups[$facet_source['id']]['facets'][$facet
            ->id()] = $facet;

          // Remove this facet from $facet so it will finally only contain those
          // facets not belonging to any facet_source.
          unset($facets[$facet
            ->id()]);
        }
      }
      foreach ($facets_summaries as $summary) {

        /** @var \Drupal\facets_summary\FacetsSummaryInterface $summary */
        if ($summary
          ->getFacetSourceId() == $facet_source['id']) {
          $facet_source_groups[$facet_source['id']]['facets'][$summary
            ->id()] = $summary;

          // Remove this facet from $facet so it will finally only contain those
          // facets not belonging to any facet_source.
          unset($facets_summaries[$summary
            ->id()]);
        }
      }
    }
    return [
      'facet_source_groups' => $facet_source_groups,
      'lone_facets' => $facets,
    ];
  }

}

Members

Namesort descending 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
DraggableListBuilder::$entities protected property The entities being listed. 1
DraggableListBuilder::$entitiesKey protected property The key to use for the form element containing the entities. 3
DraggableListBuilder::$formBuilder protected property The form builder.
DraggableListBuilder::$limit protected property The number of entities to list per page, or FALSE to list all entities. Overrides EntityListBuilder::$limit
DraggableListBuilder::$weightKey protected property Name of the entity's weight field or FALSE if no field is provided.
DraggableListBuilder::formBuilder protected function Returns the form builder.
DraggableListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render 1
DraggableListBuilder::validateForm public function Form validation handler. Overrides FormInterface::validateForm 2
DraggableListBuilder::__construct public function Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct 5
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::$storage protected property The entity storage class. 1
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. 2
EntityListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance 20
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
FacetListBuilder::buildFacetSourceRow public function Builds an array of facet sources for display in the overview.
FacetListBuilder::buildFacetSummaryRow public function Builds an array of facet summary for display in the overview.
FacetListBuilder::buildForm public function Form constructor. Overrides DraggableListBuilder::buildForm
FacetListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides DraggableListBuilder::buildHeader
FacetListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides DraggableListBuilder::buildRow
FacetListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
FacetListBuilder::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FacetListBuilder::loadGroups public function Loads facet sources and facets, grouped by facet sources.
FacetListBuilder::submitForm public function Form submission handler. Overrides DraggableListBuilder::submitForm
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.