You are here

Home » API reference » Paragraphs grid 8 » ParagraphsGridFormatter.php

class ParagraphsGridFormatter in Paragraphs grid 8

Plugin implementation of the 'entity reference rendered entity' formatter.

Plugin annotation


@FieldFormatter(
  id = "paragraphs_grid_formatter",
  label = @Translation("Paragraphs Grid (rendered entity)"),
  description = @Translation("Display the referenced entities rendered by entity_view()."),
  field_types = {
    "entity_reference_revisions"
  }
)

Hierarchy

Expanded class hierarchy of ParagraphsGridFormatter

File

src/Plugin/Field/FieldFormatter/ParagraphsGridFormatter.php, line 28

Namespace

Drupal\paragraphs_grid\Plugin\Field\FieldFormatter
View source 
class ParagraphsGridFormatter extends EntityReferenceRevisionsEntityFormatter implements ContainerFactoryPluginInterface {

  /**
   * The Drupal config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactory
   */
  protected $configFactory;

  /**
   * Constructs a StringFormatter instance.
   *
   * @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\EntityDisplayRepositoryInterface $entity_display_repository
   *   The entity display repository.
   * @param \Drupal\Core\Config\ConfigFactory $config_factory
   *   The entity display repository.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, LoggerChannelFactoryInterface $logger_factory, EntityDisplayRepositoryInterface $entity_display_repository, ConfigFactory $config_factory) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $logger_factory, $entity_display_repository);
    $this->configFactory = $config_factory;
  }

  /**
   * {@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_display.repository'), $container
      ->get('config.factory'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $module_config = $this->configFactory
      ->get('paragraphs_grid.settings');
    $grid_config = $this->configFactory
      ->get($module_config
      ->get('gridtype'));
    $elements['container'] = [
      '#type' => 'select',
      '#options' => $grid_config
        ->get('wrapper.grid.options'),
      '#title' => $this
        ->t('Select grid container'),
      '#default_value' => $this
        ->getSetting('container'),
      '#required' => $grid_config
        ->get('wrapper.grid.required'),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $module_config = $this->configFactory
      ->get('paragraphs_grid.settings');
    $grid_config = $this->configFactory
      ->get($module_config
      ->get('gridtype'));
    $options = $grid_config
      ->get('wrapper.grid.options');
    $container = $this
      ->getSetting('container');
    $container = isset($options[$container]) ? $options[$container] : $container;
    $summary[] = $this
      ->t('Grid container: @container', [
      '@container' => $container,
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function view(FieldItemListInterface $items, $langcode = NULL) {
    $elements = parent::view($items, $langcode);
    if ($this
      ->getSetting('container') !== 'none') {
      $elements['#container_attributes'] = new Attribute([
        'class' => [
          $this
            ->getSetting('container'),
        ],
      ]);
    }
    return $elements;
  }

}

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
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
EntityReferenceRevisionsEntityFormatter::$entityDisplayRepository protected property The entity display repository.
EntityReferenceRevisionsEntityFormatter::$loggerFactory protected property The logger factory.
EntityReferenceRevisionsEntityFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
EntityReferenceRevisionsEntityFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
EntityReferenceRevisionsFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being viewed. Overrides EntityReferenceFormatterBase::prepareView
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.
ParagraphsGridFormatter::$configFactory protected property The Drupal config factory.
ParagraphsGridFormatter::create public static function Creates an instance of the plugin. Overrides EntityReferenceRevisionsEntityFormatter::create
ParagraphsGridFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides EntityReferenceRevisionsEntityFormatter::defaultSettings
ParagraphsGridFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides EntityReferenceRevisionsEntityFormatter::settingsForm
ParagraphsGridFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides EntityReferenceRevisionsEntityFormatter::settingsSummary
ParagraphsGridFormatter::view public function Builds a renderable array for a fully themed field. Overrides EntityReferenceFormatterBase::view
ParagraphsGridFormatter::__construct public function Constructs a StringFormatter instance. Overrides EntityReferenceRevisionsEntityFormatter::__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.