You are here

Home » API reference » Layout Paragraphs 2.0.x » LayoutParagraphsWidget.php

class LayoutParagraphsWidget in Layout Paragraphs 2.0.x

Same name and namespace in other branches
  1. 1.0.x src/Plugin/Field/FieldWidget/LayoutParagraphsWidget.php \Drupal\layout_paragraphs\Plugin\Field\FieldWidget\LayoutParagraphsWidget

Layout paragraphs widget.

Plugin annotation


@FieldWidget(
  id = "layout_paragraphs",
  label = @Translation("Layout Paragraphs"),
  description = @Translation("Layout builder for paragraphs."),
  multiple_values = TRUE,
  field_types = {
    "entity_reference_revisions"
  },
)

Hierarchy

Expanded class hierarchy of LayoutParagraphsWidget

1 file declares its use of LayoutParagraphsWidget
LayoutParagraphsBuilderFormatter.php in src/Plugin/Field/FieldFormatter/LayoutParagraphsBuilderFormatter.php

File

src/Plugin/Field/FieldWidget/LayoutParagraphsWidget.php, line 32

Namespace

Drupal\layout_paragraphs\Plugin\Field\FieldWidget
View source 
class LayoutParagraphsWidget extends WidgetBase implements ContainerFactoryPluginInterface {

  /**
   * The tempstore.
   *
   * @var \Drupal\layout_paragraphs\LayoutParagraphsLayoutTempstoreRepository
   */
  protected $tempstore;

  /**
   * The Entity Type Manager service property.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The Layouts Manager.
   *
   * @var \Drupal\Core\Layout\LayoutPluginManager
   */
  protected $layoutPluginManager;

  /**
   * The layout paragraphs layout.
   *
   * @var \Drupal\layout_paragraphs\LayoutParagraphsLayout
   */
  protected $layoutParagraphsLayout;

  /**
   * The layout paragraphs layout tempstore storage key.
   *
   * @var string
   */
  protected $storageKey;

  /**
   * The form builder service.
   *
   * @var Drupal\Core\Form\FormBuilder
   */
  protected $formBuilder;

  /**
   * The entity display repository.
   *
   * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * The module configuration.
   *
   * @var \Drupal\Core\Config\ImmutableConfig
   */
  protected $config;

  /**
   * {@inheritDoc}
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, LayoutParagraphsLayoutTempstoreRepository $tempstore, EntityTypeManagerInterface $entity_type_manager, LayoutPluginManager $layout_plugin_manager, FormBuilder $form_builder, EntityDisplayRepositoryInterface $entity_display_repository, ConfigFactoryInterface $config_factory) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->tempstore = $tempstore;
    $this->entityTypeManager = $entity_type_manager;
    $this->layoutPluginManager = $layout_plugin_manager;
    $this->formBuilder = $form_builder;
    $this->entityDisplayRepository = $entity_display_repository;
    $this->config = $config_factory
      ->get('layout_paragraphs.settings');
  }

  /**
   * {@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['third_party_settings'], $container
      ->get('layout_paragraphs.tempstore_repository'), $container
      ->get('entity_type.manager'), $container
      ->get('plugin.manager.core.layout'), $container
      ->get('form_builder'), $container
      ->get('entity_display.repository'), $container
      ->get('config.factory'));
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $this->layoutParagraphsLayout = new LayoutParagraphsLayout($items, $this
      ->getSettings());
    if (!$form_state
      ->getUserInput()) {
      $this->tempstore
        ->set($this->layoutParagraphsLayout);
    }
    else {
      $this->layoutParagraphsLayout = $this->tempstore
        ->get($this->layoutParagraphsLayout);
    }
    $element += [
      '#type' => 'fieldset',
      '#title' => $this->fieldDefinition
        ->getLabel(),
      'layout_paragraphs_builder' => [
        '#type' => 'layout_paragraphs_builder',
        '#layout_paragraphs_layout' => $this->layoutParagraphsLayout,
      ],
    ];
    if ($source = $form_state
      ->get([
      'content_translation',
      'source',
    ])) {
      $element['layout_paragraphs_builder']['#source_langcode'] = $source
        ->getId();
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function extractFormValues(FieldItemListInterface $items, array $form, FormStateInterface $form_state) {
    $field_name = $this->fieldDefinition
      ->getName();
    $path = array_merge($form['#parents'], [
      $field_name,
    ]);
    $layout_paragraphs_layout = $this->tempstore
      ->get(new LayoutParagraphsLayout($items));
    $values = [];
    foreach ($layout_paragraphs_layout
      ->getParagraphsReferenceField() as $item) {
      if ($item->entity) {
        $entity = $item->entity;
        $entity
          ->setNeedsSave(TRUE);
        $values[] = [
          'entity' => $entity,
          'target_id' => $entity
            ->id(),
          'target_revision_id' => $entity
            ->getRevisionId(),
        ];
      }
    }
    $form_state
      ->setValue($path, $values);
    return parent::extractFormValues($items, $form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $entity_type_id = $this
      ->getFieldSetting('target_type');
    $element = parent::settingsForm($form, $form_state);
    $element['preview_view_mode'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Preview view mode'),
      '#default_value' => $this
        ->getSetting('preview_view_mode'),
      '#options' => $this->entityDisplayRepository
        ->getViewModeOptions($entity_type_id),
      '#description' => $this
        ->t('View mode for the referenced entity preview on the edit form. Automatically falls back to "default", if it is not enabled in the referenced entity type displays.'),
    ];
    $element['nesting_depth'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Maximum nesting depth'),
      '#options' => range(0, 10),
      '#default_value' => $this
        ->getSetting('nesting_depth'),
      '#description' => $this
        ->t('Choosing 0 will prevent nesting layouts within other layouts.'),
    ];
    $element['require_layouts'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Require paragraphs to be added inside a layout'),
      '#default_value' => $this
        ->getSetting('require_layouts'),
    ];
    $element['empty_message'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Placeholder message to display when field is empty'),
      '#default_value' => $this
        ->getSetting('empty_message'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $summary[] = $this
      ->t('Preview view mode: @preview_view_mode', [
      '@preview_view_mode' => $this
        ->getSetting('preview_view_mode'),
    ]);
    $summary[] = $this
      ->t('Maximum nesting depth: @max_depth', [
      '@max_depth' => $this
        ->getSetting('nesting_depth'),
    ]);
    if ($this
      ->getSetting('require_layouts')) {
      $summary[] = $this
        ->t('Paragraphs <b>must be</b> added within layouts.');
    }
    else {
      $summary[] = $this
        ->t('Layouts are optional.');
    }
    $summary[] = $this
      ->t('Maximum nesting depth: @max_depth', [
      '@max_depth' => $this
        ->getSetting('nesting_depth'),
    ]);
    return $summary;
  }

  /**
   * Default settings for widget.
   *
   * @return array
   *   The default settings array.
   */
  public static function defaultSettings() {
    $defaults = parent::defaultSettings();
    $defaults += [
      'empty_message' => '',
      'preview_view_mode' => 'default',
      'nesting_depth' => 0,
      'require_layouts' => 0,
    ];
    return $defaults;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
LayoutParagraphsWidget::$config protected property The module configuration.
LayoutParagraphsWidget::$entityDisplayRepository protected property The entity display repository.
LayoutParagraphsWidget::$entityTypeManager protected property The Entity Type Manager service property.
LayoutParagraphsWidget::$formBuilder protected property The form builder service.
LayoutParagraphsWidget::$layoutParagraphsLayout protected property The layout paragraphs layout.
LayoutParagraphsWidget::$layoutPluginManager protected property The Layouts Manager.
LayoutParagraphsWidget::$storageKey protected property The layout paragraphs layout tempstore storage key.
LayoutParagraphsWidget::$tempstore protected property The tempstore.
LayoutParagraphsWidget::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
LayoutParagraphsWidget::defaultSettings public static function Default settings for widget. Overrides PluginSettingsBase::defaultSettings
LayoutParagraphsWidget::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBase::extractFormValues
LayoutParagraphsWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
LayoutParagraphsWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
LayoutParagraphsWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
LayoutParagraphsWidget::__construct public function Constructs a WidgetBase object. Overrides WidgetBase::__construct
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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. 4
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.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues 7
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState