You are here

Home » API reference » UI Patterns Field Formatters 8 » PatternWrapperEntityReferenceFormatter.php

class PatternWrapperEntityReferenceFormatter in UI Patterns Field Formatters 8

Plugin implementation of 'pattern_wrapper_entity_reference_formatter'.

Plugin annotation


@FieldFormatter(
  id = "pattern_wrapper_entity_reference_formatter",
  label = @Translation("Rendered entity, wrapped in a pattern"),
  description = @Translation("Display the rendered referenced entities with UI Patterns)."),
  field_types = {
    "entity_reference"
  }
)

Hierarchy

Expanded class hierarchy of PatternWrapperEntityReferenceFormatter

File

src/Plugin/Field/FieldFormatter/PatternWrapperEntityReferenceFormatter.php, line 30

Namespace

Drupal\ui_patterns_field_formatters\Plugin\Field\FieldFormatter
View source 
class PatternWrapperEntityReferenceFormatter extends EntityReferenceEntityFormatter {
  use PatternDisplayFormTrait;

  /**
   * UI Patterns manager.
   *
   * @var \Drupal\ui_patterns\UiPatternsManager
   */
  protected $patternsManager;

  /**
   * UI Patterns source manager.
   *
   * @var \Drupal\ui_patterns\UiPatternsSourceManager
   */
  protected $sourceManager;

  /**
   * A module manager object.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Constructs a Drupal\Component\Plugin\PluginBase 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 settings.
   * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory
   *   The logger factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
   *   The entity display repository.
   * @param \Drupal\ui_patterns\UiPatternsManager $patterns_manager
   *   The UI Patterns manager.
   * @param \Drupal\ui_patterns\UiPatternsSourceManager $source_manager
   *   The UI Patterns source manager.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, LoggerChannelFactoryInterface $logger_factory, EntityTypeManagerInterface $entity_type_manager, EntityDisplayRepositoryInterface $entity_display_repository, UiPatternsManager $patterns_manager, UiPatternsSourceManager $source_manager, ModuleHandlerInterface $module_handler) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $logger_factory, $entity_type_manager, $entity_display_repository);
    $this->patternsManager = $patterns_manager;
    $this->sourceManager = $source_manager;
    $this->moduleHandler = $module_handler;
  }

  /**
   * {@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('logger.factory'), $container
      ->get('entity_type.manager'), $container
      ->get('entity_display.repository'), $container
      ->get('plugin.manager.ui_patterns'), $container
      ->get('plugin.manager.ui_patterns_source'), $container
      ->get('module_handler'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'pattern' => '',
      'variants' => '',
      'pattern_mapping' => [],
      // Used by ui_patterns_settings.
      'pattern_settings' => [],
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $field_storage_definition = $this->fieldDefinition
      ->getFieldStorageDefinition();
    $context = [
      'storageDefinition' => $field_storage_definition,
      'limit' => $field_storage_definition
        ->getPropertyNames(),
    ];

    // Some modifications to make 'variant' default value working.
    $configuration = $this
      ->getSettings();
    $pattern = $this
      ->getSetting('pattern');
    $pattern_variant = $this
      ->getCurrentVariant($pattern);
    if (isset($pattern_variant)) {
      $configuration['pattern_variant'] = $pattern_variant;
    }
    $this
      ->buildPatternDisplayForm($form, 'field_wrapper', $context, $configuration);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $pattern = $this
      ->getSetting('pattern');
    if (!empty($pattern)) {
      $pattern_definition = $this->patternsManager
        ->getDefinition($pattern);
      $label = $this
        ->t('None');
      if (!empty($this
        ->getSetting('pattern'))) {
        $label = $pattern_definition
          ->getLabel();
      }
      $summary[] = $this
        ->t('Pattern: @pattern', [
        '@pattern' => $label,
      ]);
      $pattern_variant = $this
        ->getCurrentVariant($pattern);
      if (isset($pattern_variant)) {
        $variant = $this
          ->getSetting('variants')[$pattern_definition
          ->id()];
        $variant = $pattern_definition
          ->getVariant($variant)
          ->getLabel();
        $summary[] = $this
          ->t('Variant: @variant', [
          '@variant' => $variant,
        ]);
      }
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = parent::viewElements($items, $langcode);
    $pattern = $this
      ->getSetting('pattern');

    // Set pattern fields.
    $fields = [];
    $mapping = $this
      ->getSetting('pattern_mapping');
    $mapping = $mapping[$pattern]['settings'];
    foreach ($mapping as $source => $field) {
      if ($field['destination'] === '_hidden') {
        continue;
      }

      // Get rid of the source tag.
      $source = explode(":", $source)[1];
      if ($source === 'items') {
        $fields[$field['destination']][] = $elements;
      }
      if ($source === 'label') {
        $fields[$field['destination']][] = $items
          ->getFieldDefinition()
          ->getLabel();
      }
    }

    // Set pattern render array.
    $build = [
      '#type' => 'pattern',
      '#id' => $this
        ->getSetting('pattern'),
      '#fields' => $fields,
      '#multiple_sources' => TRUE,
    ];

    // Set the variant.
    $pattern_variant = $this
      ->getCurrentVariant($pattern);
    if (isset($pattern_variant)) {
      $build['#variant'] = $pattern_variant;
    }

    // Set the settings.
    $settings = $this
      ->getSetting('pattern_settings');
    $pattern_settings = !empty($settings) && isset($settings[$pattern]) ? $settings[$pattern] : NULL;
    if (isset($pattern_settings)) {
      $build['#settings'] = $pattern_settings;
    }

    // Set pattern context.
    $entity = $items
      ->getEntity();
    $build['#context'] = [
      'type' => 'field_formatter',
      'entity' => $entity,
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  protected function getDefaultValue(array $configuration, $field_name, $value) {

    // Some modifications to make 'destination' default value working.
    $pattern = $configuration['pattern'];
    if (isset($configuration['pattern_mapping'][$pattern]['settings'][$field_name][$value])) {
      return $configuration['pattern_mapping'][$pattern]['settings'][$field_name][$value];
    }
    return NULL;
  }

  /**
   * Checks if a given pattern has a corresponding value on the variants array.
   *
   * @param string $pattern
   *   The pattern.
   *
   * @return string|null
   *   The variant.
   */
  protected function getCurrentVariant($pattern) {
    $variants = $this
      ->getSetting('variants');
    return !empty($variants) && isset($variants[$pattern]) ? $variants[$pattern] : NULL;
  }

}

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
EntityReferenceEntityFormatter::$entityDisplayRepository protected property The entity display repository.
EntityReferenceEntityFormatter::$entityTypeManager protected property The entity type manager.
EntityReferenceEntityFormatter::$loggerFactory protected property The logger factory.
EntityReferenceEntityFormatter::$recursiveRenderDepth protected static property An array of counters for the recursive rendering protection.
EntityReferenceEntityFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
EntityReferenceEntityFormatter::RECURSIVE_RENDER_LIMIT constant The number of times this formatter allows rendering the same entity.
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.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PatternDisplayFormTrait::buildPatternDisplayForm public function Build pattern display form.
PatternDisplayFormTrait::getMappingDestination public function Helper function: return mapping destination given plugin id and field name.
PatternDisplayFormTrait::getMappingForm public function Get mapping form.
PatternDisplayFormTrait::hasMappingDestination public function Helper function: check if given source field has mapping destination.
PatternDisplayFormTrait::processFormStateValues public static function Normalize settings coming from a form submission.
PatternWrapperEntityReferenceFormatter::$moduleHandler protected property A module manager object.
PatternWrapperEntityReferenceFormatter::$patternsManager protected property UI Patterns manager.
PatternWrapperEntityReferenceFormatter::$sourceManager protected property UI Patterns source manager.
PatternWrapperEntityReferenceFormatter::create public static function Creates an instance of the plugin. Overrides EntityReferenceEntityFormatter::create
PatternWrapperEntityReferenceFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides EntityReferenceEntityFormatter::defaultSettings
PatternWrapperEntityReferenceFormatter::getCurrentVariant protected function Checks if a given pattern has a corresponding value on the variants array.
PatternWrapperEntityReferenceFormatter::getDefaultValue protected function Helper function: get default value. Overrides PatternDisplayFormTrait::getDefaultValue
PatternWrapperEntityReferenceFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides EntityReferenceEntityFormatter::settingsForm
PatternWrapperEntityReferenceFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides EntityReferenceEntityFormatter::settingsSummary
PatternWrapperEntityReferenceFormatter::viewElements public function Builds a renderable array for a field value. Overrides EntityReferenceEntityFormatter::viewElements
PatternWrapperEntityReferenceFormatter::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. Overrides EntityReferenceEntityFormatter::__construct
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::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
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.