You are here

SlickParagraphsVanillaFormatter.php in Slick Paragraphs 8

File

src/Plugin/Field/FieldFormatter/SlickParagraphsVanillaFormatter.php
View source
<?php

namespace Drupal\slick_paragraphs\Plugin\Field\FieldFormatter;

use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\slick\Plugin\Field\FieldFormatter\SlickEntityFormatterBase;

/**
 * Plugin implementation of the 'Slick Paragraphs Vanilla' formatter.
 *
 * @FieldFormatter(
 *   id = "slick_paragraphs_vanilla",
 *   label = @Translation("Slick Paragraphs Vanilla"),
 *   description = @Translation("Display the vanilla paragraph as a Slick carousel."),
 *   field_types = {
 *     "entity_reference_revisions"
 *   },
 *   quickedit = {
 *     "editor" = "disabled"
 *   }
 * )
 */
class SlickParagraphsVanillaFormatter extends SlickEntityFormatterBase {

  /**
   * {@inheritdoc}
   */
  public function prepareView(array $entities_items) {

    // Entity revision loading currently has no static/persistent cache and no
    // multiload. As entity reference checks _loaded, while we don't want to
    // indicate a loaded entity, when there is none, as it could cause errors,
    // we actually load the entity and set the flag.
    foreach ($entities_items as $items) {
      foreach ($items as $item) {
        if ($item->entity) {
          $item->_loaded = TRUE;
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    $storage = $field_definition
      ->getFieldStorageDefinition();
    return $storage
      ->isMultiple() && $storage
      ->getSetting('target_type') === 'paragraph';
  }

}

Classes

Namesort descending Description
SlickParagraphsVanillaFormatter Plugin implementation of the 'Slick Paragraphs Vanilla' formatter.