You are here

Home » API reference » Entity Reference Facet Link 8 » EntityReferenceFacetFormatterBase.php

abstract class EntityReferenceFacetFormatterBase in Entity Reference Facet Link 8

Hierarchy

Expanded class hierarchy of EntityReferenceFacetFormatterBase

File

src/Plugin/Field/FieldFormatter/EntityReferenceFacetFormatterBase.php, line 19

Namespace

Drupal\entity_reference_facet_link\Plugin\Field\FieldFormatter
View source 
abstract class EntityReferenceFacetFormatterBase extends EntityReferenceFormatterBase implements ContainerFactoryPluginInterface {

  /**
   * A facet entity.
   *
   * @var \Drupal\facets\FacetInterface
   */
  protected $facet;

  /**
   * The facet entity storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $facetStorage;

  /**
   * A URL processor plugin manager.
   *
   * @var \Drupal\facets\UrlProcessor\UrlProcessorPluginManager
   */
  protected $urlProcessorPluginManager;

  /**
   * Constructs a EntityReferenceFacetLink object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\Core\Entity\EntityStorageInterface $facet_storage
   *   An entity type manager.
   * @param \Drupal\facets\UrlProcessor\UrlProcessorPluginManager $url_processor_plugin_manager
   *   A URL processor plugin manager.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityStorageInterface $facet_storage, UrlProcessorPluginManager $url_processor_plugin_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->facetStorage = $facet_storage;
    $this->urlProcessorPluginManager = $url_processor_plugin_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('entity_type.manager')
      ->getStorage('facets_facet'), $container
      ->get('plugin.manager.facets.url_processor'));
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $dependencies = parent::calculateDependencies();
    if ($facet = $this
      ->getFacet()) {
      $dependencies[$facet
        ->getConfigDependencyKey()][] = $facet
        ->getConfigDependencyName();
    }
    return $dependencies;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'facet' => '',
    ] + parent::defaultSettings();
  }

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

    /** @var \Drupal\facets\FacetInterface[] $facets */
    $facets = $this->facetStorage
      ->loadMultiple();
    $options = [];
    foreach ($facets as $facet) {

      // Add a facet to the options only if that facet is faceting this field.
      if ($facet
        ->getFieldIdentifier() == $this->fieldDefinition
        ->getName()) {
        $options[$facet
          ->id()] = $facet
          ->label();
      }
    }
    $elements['facet'] = [
      '#title' => $this
        ->t('Select the facet to which the labels should be linked.'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('facet'),
      '#options' => $options,
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    if ($facet = $this
      ->getFacet()) {
      $summary[] = $this
        ->t('Selected facet: @facet', [
        '@facet' => $facet
          ->label(),
      ]);
    }
    else {
      $summary[] = $this
        ->t('No facet selected');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $facet = $this
      ->getFacet();
    if (empty($facet)) {
      return [];
    }

    // Instead of trying to guess how the facet URLs should be formatted, let
    // the facet's own URL processor do the work of building them.  Then the
    // URLs will be formatted correctly no matter what processor is being used,
    // for instance Facets Pretty Paths.
    $url_processor_id = $facet
      ->getFacetSourceConfig()
      ->getUrlProcessorName();
    $configuration = [
      'facet' => $facet,
    ];

    /** @var \Drupal\facets\UrlProcessor\UrlProcessorInterface $url_processor */
    $url_processor = $this->urlProcessorPluginManager
      ->createInstance($url_processor_id, $configuration);
    $elements = [];
    foreach ($this
      ->getEntitiesToView($items, $langcode) as $delta => $entity) {

      // Create a fake Result object from the field item so that we can pass
      // it to the URL processor.
      $result = new Result($facet, $entity
        ->id(), $entity
        ->label(), 0);
      $result = $url_processor
        ->buildUrls($facet, [
        $result,
      ])[0];

      // Invalidate the cache when the referenced entity or the facet source
      // config changes.  The source display config, for instance a view, should
      // be added here too, but there really isn't any way to access that config
      // entity through the API.
      $cache_tags = Cache::mergeTags($entity
        ->getCacheTags(), $facet
        ->getFacetSourceConfig()
        ->getCacheTags());
      $elements[$delta] = $this
        ->buildElement($result
        ->getUrl(), $entity) + [
        '#cache' => [
          'tags' => $cache_tags,
        ],
      ];
    }
    return $elements;
  }

  /**
   * Builds a single element's render array.
   *
   * @param \Drupal\Core\Url $url
   *   The processed facet URL.
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity being displayed.
   *
   * @return array
   *   A render array.
   */
  protected abstract function buildElement(Url $url, EntityInterface $entity);

  /**
   * Gets the configured facet entity.
   *
   * @return \Drupal\facets\FacetInterface|null
   *   The configured facet or null if not set.
   */
  protected function getFacet() {
    if (!isset($this->facet)) {
      $this->facet = $this->facetStorage
        ->load($this
        ->getSetting('facet'));
    }
    return $this->facet;
  }

}

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
EntityReferenceFacetFormatterBase::$facet protected property A facet entity.
EntityReferenceFacetFormatterBase::$facetStorage protected property The facet entity storage.
EntityReferenceFacetFormatterBase::$urlProcessorPluginManager protected property A URL processor plugin manager.
EntityReferenceFacetFormatterBase::buildElement abstract protected function Builds a single element's render array. 2
EntityReferenceFacetFormatterBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
EntityReferenceFacetFormatterBase::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
EntityReferenceFacetFormatterBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
EntityReferenceFacetFormatterBase::getFacet protected function Gets the configured facet entity.
EntityReferenceFacetFormatterBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
EntityReferenceFacetFormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
EntityReferenceFacetFormatterBase::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
EntityReferenceFacetFormatterBase::__construct public function Constructs a EntityReferenceFacetLink object. Overrides FormatterBase::__construct
EntityReferenceFormatterBase::checkAccess protected function Checks access to the given entity. 3
EntityReferenceFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. 1
EntityReferenceFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. 1
EntityReferenceFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view public function Overrides FormatterBase::view
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.