class ParagraphsSummaryFormatter

Plugin implementation of the 'paragraph_summary' formatter.

Plugin annotation


@FieldFormatter(
  id = "paragraph_summary",
  label = @Translation("Paragraph summary"),
  field_types = {
    "entity_reference_revisions"
  }
)

Hierarchy

  • class \Drupal\paragraphs\Plugin\Field\FieldFormatter\ParagraphsSummaryFormatter extends \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase

Expanded class hierarchy of ParagraphsSummaryFormatter

1 file declares its use of ParagraphsSummaryFormatter
LibraryItemSummaryFormatter.php in paragraphs/modules/paragraphs_library/src/Plugin/Field/FieldFormatter/LibraryItemSummaryFormatter.php

File

paragraphs/src/Plugin/Field/FieldFormatter/ParagraphsSummaryFormatter.php, line 21

Namespace

Drupal\paragraphs\Plugin\Field\FieldFormatter
View source
class ParagraphsSummaryFormatter extends EntityReferenceFormatterBase {

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($this
      ->getEntitiesToView($items, $langcode) as $delta => $entity) {
      if ($entity
        ->id()) {
        $elements[$delta] = [
          '#type' => 'container',
          '#attributes' => [
            'class' => [
              'paragraph-formatter',
            ],
          ],
        ];
        $elements[$delta]['info'] = [
          '#type' => 'container',
          '#attributes' => [
            'class' => [
              'paragraph-info',
            ],
          ],
        ];
        $elements[$delta]['info'] += $entity
          ->getIcons();
        $elements[$delta]['summary'] = [
          '#type' => 'container',
          '#attributes' => [
            'class' => [
              'paragraph-summary',
            ],
          ],
        ];
        $elements[$delta]['summary']['description'] = [
          '#theme' => 'paragraphs_summary',
          '#summary' => $entity
            ->getSummaryItems(),
        ];
      }
    }
    if ($elements) {
      $elements['#attached']['library'][] = 'paragraphs/drupal.paragraphs.formatter';
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    $target_type = $field_definition
      ->getSetting('target_type');
    $paragraph_type = \Drupal::entityTypeManager()
      ->getDefinition($target_type);
    if ($paragraph_type) {
      return $paragraph_type
        ->entityClassImplements(ParagraphInterface::class);
    }
    return FALSE;
  }

}

Members