You are here

Home » API reference » Facets 8 » ShowTextWhenEmptyProcessor.php

class ShowTextWhenEmptyProcessor in Facets 8

Provides a processor that shows a text when there are no results.

Plugin annotation


@SummaryProcessor(
  id = "show_text_when_empty",
  label = @Translation("Show a text when there are no results"),
  description = @Translation("Show a text when there are no results, otherwise it will hide the block."),
  default_enabled = TRUE,
  stages = {
    "build" = 10
  }
)

Hierarchy

Expanded class hierarchy of ShowTextWhenEmptyProcessor

1 file declares its use of ShowTextWhenEmptyProcessor
ShowTextWhenEmptyProcessorTest.php in modules/facets_summary/tests/src/Unit/Plugin/Processor/ShowTextWhenEmptyProcessorTest.php

File

modules/facets_summary/src/Plugin/facets_summary/processor/ShowTextWhenEmptyProcessor.php, line 23

Namespace

Drupal\facets_summary\Plugin\facets_summary\processor
View source 
class ShowTextWhenEmptyProcessor extends ProcessorPluginBase implements BuildProcessorInterface {

  /**
   * {@inheritdoc}
   */
  public function build(FacetsSummaryInterface $facets_summary, array $build, array $facets) {
    $config = $this
      ->getConfiguration();
    $results_count = array_sum(array_map(function ($it) {

      /** @var \Drupal\facets\FacetInterface $it */
      return count($it
        ->getResults());
    }, $facets));

    // No items are found, so we should return the empty summary.
    if (!isset($build['#items']) || $results_count === 0) {
      return [
        '#theme' => 'facets_summary_empty',
        '#message' => [
          '#type' => 'processed_text',
          '#text' => $config['text']['value'],
          '#format' => $config['text']['format'],
        ],
      ];
    }

    // Return the actual items.
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state, FacetsSummaryInterface $facets_summary) {

    // By default, there should be no config form.
    $config = $this
      ->getConfiguration();
    $build['text'] = [
      '#type' => 'text_format',
      '#title' => $this
        ->t('Empty text'),
      '#format' => $config['text']['format'],
      '#editor' => TRUE,
      '#default_value' => $config['text']['value'],
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'text' => [
        'format' => 'plain_text',
        'value' => $this
          ->t('No results found.'),
      ],
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
ProcessorInterface::STAGE_BUILD constant Processing stage: build.
ProcessorPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ProcessorPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ProcessorPluginBase::getDefaultWeight public function Returns the default weight for a specific processing stage. Overrides ProcessorInterface::getDefaultWeight
ProcessorPluginBase::getDescription public function Retrieves the processor description. Overrides ProcessorInterface::getDescription
ProcessorPluginBase::isHidden public function Determines whether this processor should be hidden from the user. Overrides ProcessorInterface::isHidden
ProcessorPluginBase::isLocked public function Determines whether this processor should always be enabled. Overrides ProcessorInterface::isLocked
ProcessorPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ProcessorPluginBase::submitConfigurationForm public function Submits a configuration form for this processor. Overrides ProcessorInterface::submitConfigurationForm
ProcessorPluginBase::supportsStage public function Checks whether this processor implements a particular stage. Overrides ProcessorInterface::supportsStage
ProcessorPluginBase::validateConfigurationForm public function Validates a configuration form for this processor. Overrides ProcessorInterface::validateConfigurationForm
ShowTextWhenEmptyProcessor::build public function Alter the items in the summary before creating the renderable array. Overrides BuildProcessorInterface::build
ShowTextWhenEmptyProcessor::buildConfigurationForm public function Adds a configuration form for this processor. Overrides ProcessorPluginBase::buildConfigurationForm
ShowTextWhenEmptyProcessor::defaultConfiguration public function Gets default configuration for this plugin. Overrides ProcessorPluginBase::defaultConfiguration
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.