class LayoutParagraphsBuilderFormatter in Layout Paragraphs 2.0.x

Layout Paragraphs field formatter.

Plugin annotation

@FieldFormatter(
  id = "layout_paragraphs_builder",
  label = @Translation("Layout Paragraphs Builder"),
  description = @Translation("Renders editable paragraphs with layout."),
  field_types = {
    "entity_reference_revisions"
  }
)

Hierarchy

• class \Drupal\layout_paragraphs\Plugin\Field\FieldFormatter\LayoutParagraphsFormatter extends \Drupal\entity_reference_revisions\Plugin\Field\FieldFormatter\EntityReferenceRevisionsEntityFormatter implements ContainerFactoryPluginInterface
  • class \Drupal\layout_paragraphs\Plugin\Field\FieldFormatter\LayoutParagraphsBuilderFormatter implements ContainerFactoryPluginInterface

File

src/Plugin/Field/FieldFormatter/LayoutParagraphsBuilderFormatter.php, line 29

Namespace

Drupal\layout_paragraphs\Plugin\Field\FieldFormatter

class LayoutParagraphsBuilderFormatter extends LayoutParagraphsFormatter implements ContainerFactoryPluginInterface {

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

  /**
   * {@inheritDoc}
   */
  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, LayoutParagraphsLayoutTempstoreRepository $tempstore) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $logger_factory, $entity_display_repository);
    $this->tempstore = $tempstore;
  }

  /**
   * {@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('layout_paragraphs.tempstore_repository'));
  }

  /**
   * {@inheritDoc}
   */
  public function view(FieldItemListInterface $items, $langcode = NULL) {
    $elements = [
      '#theme' => 'layout_paragraphs_builder_formatter',
      '#root_components' => parent::view($items, $langcode),
    ];
    $entity = $items
      ->getEntity();
    if (!$entity
      ->access('update')) {
      return $elements['#root_components'];
    }

    /** @var \Drupal\Core\Entity\EntityDefintion $definition */
    $definition = $items
      ->getFieldDefinition();
    $layout = new LayoutParagraphsLayout($items, $this
      ->getSettings() + [
      'reference_field_view_mode' => $this->viewMode,
    ]);
    $this->tempstore
      ->set($layout);
    $layout = $this->tempstore
      ->get($layout);
    $elements['#link_text'] = $this
      ->t('Edit @label', [
      '@label' => $definition
        ->label(),
    ]);
    $elements['#link_url'] = Url::fromRoute('layout_paragraphs.builder.formatter', [
      'layout_paragraphs_layout' => $layout
        ->id(),
    ]);
    $elements['#field_label'] = $definition
      ->label();
    $elements['#type'] = 'container';
    $elements['#is_empty'] = count($layout
      ->getRootComponents()) == 0;
    $elements['#attributes'] = [
      'class' => [
        'lpb-formatter',
      ],
      'data-lpb-id' => $layout
        ->id(),
    ];
    $elements['#attached']['library'][] = 'layout_paragraphs/builder';
    $elements['#attached']['library'][] = 'layout_paragraphs/builder_form';
    return $elements;
  }

  /**
   * Replicates settings from Layout Paragraphs Widget.
   *
   * @see \Drupal\layout_paragraphs\Plugin\Field\FieldWidget\LayoutParagraphsWidget
   *
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $widget = $this
      ->widgetInstance();
    return $widget
      ->settingsForm($form, $form_state);
  }

  /**
   * Replicates settings from Layout Paragraphs Widget.
   *
   * @see \Drupal\layout_paragraphs\Plugin\Field\FieldWidget\LayoutParagraphsWidget
   *
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $widget = $this
      ->widgetInstance();
    return $widget
      ->settingsSummary();
  }

  /**
   * Replicates settings from Layout Paragraphs Widget.
   *
   * @see \Drupal\layout_paragraphs\Plugin\Field\FieldWidget\LayoutParagraphsWidget
   *
   * @return array
   *   The default settings array.
   */
  public static function defaultSettings() {
    $defaults = parent::defaultSettings();
    return LayoutParagraphsWidget::defaultSettings() + $defaults;
  }

  /**
   * Returns a layout paragraphs field widget with correct settings applied.
   *
   * @return \Drupal\Core\Field\WidgetInterface
   *   The widget instance.
   */
  protected function widgetInstance() {
    $plugin_manager = \Drupal::service('plugin.manager.field.widget');
    $widget = $plugin_manager
      ->getInstance([
      'field_definition' => $this->fieldDefinition,
      'form_mode' => 'layout_paragraphs_editor',
      'prepare' => TRUE,
      'configuration' => [
        'type' => 'layout_paragraphs',
        'settings' => $this
          ->getSettings(),
        'third_party_settings' => [],
      ],
    ]);
    return $widget;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LayoutParagraphsBuilderFormatter::$tempstore	protected	property	The tempstore.
LayoutParagraphsBuilderFormatter::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LayoutParagraphsBuilderFormatter::defaultSettings	public static	function	Replicates settings from Layout Paragraphs Widget.
LayoutParagraphsBuilderFormatter::settingsForm	public	function	Replicates settings from Layout Paragraphs Widget.
LayoutParagraphsBuilderFormatter::settingsSummary	public	function	Replicates settings from Layout Paragraphs Widget.
LayoutParagraphsBuilderFormatter::view	public	function
LayoutParagraphsBuilderFormatter::widgetInstance	protected	function	Returns a layout paragraphs field widget with correct settings applied.
LayoutParagraphsBuilderFormatter::__construct	public	function
LayoutParagraphsFormatter::getEntitiesToView	protected	function	Returns the referenced entities for display.