abstract class GridStackFileFormatterBase in GridStack 8.2

Base class for gridstack image and file ER formatters.

Hierarchy

• class \Drupal\gridstack\Plugin\Field\FieldFormatter\GridStackFileFormatterBase extends \Drupal\blazy\Plugin\Field\FieldFormatter\BlazyFileFormatterBase uses GridStackFormatterTrait, GridStackFormatterViewTrait

File

src/Plugin/Field/FieldFormatter/GridStackFileFormatterBase.php, line 14

Namespace

Drupal\gridstack\Plugin\Field\FieldFormatter

abstract class GridStackFileFormatterBase extends BlazyFileFormatterBase {
  use GridStackFormatterTrait;
  use GridStackFormatterViewTrait;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    return self::injectServices($instance, $container, 'image');
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return GridStackDefault::imageSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $entities = $this
      ->getEntitiesToView($items, $langcode);

    // Early opt-out if the field is empty.
    if (empty($entities)) {
      return [];
    }
    return $this
      ->commonViewElements($items, $langcode, $entities);
  }

  /**
   * Build the gridstack carousel elements.
   */
  public function buildElements(array &$build, $files) {
    $settings =& $build['settings'];
    $item_id = $settings['item_id'];
    foreach ($files as $delta => $file) {
      $settings['delta'] = $delta;
      $settings['type'] = 'image';

      /** @var Drupal\image\Plugin\Field\FieldType\ImageItem $item */
      $item = $file->_referringItem;
      $settings['file_tags'] = $file
        ->getCacheTags();
      $settings['uri'] = $file
        ->getFileUri();
      $element = [
        'item' => $item,
        'settings' => $settings,
      ];

      // If imported Drupal\blazy\Dejavu\BlazyVideoTrait.
      $this
        ->buildElement($element, $file);

      // Image with responsive image, lazyLoad, and lightbox supports.
      $element[$item_id] = $this->formatter
        ->getBlazy($element);
      if (!empty($settings['caption'])) {
        foreach ($settings['caption'] as $caption) {
          $element['caption'][$caption] = empty($element['item']->{$caption}) ? [] : [
            '#markup' => Xss::filterAdmin($element['item']->{$caption}),
          ];
        }
      }

      // Build individual gridstack item.
      $build['items'][$delta] = $element;
      unset($element);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getScopedFormElements() {
    return [
      'background' => TRUE,
      'no_ratio' => TRUE,
      'responsive_image' => TRUE,
    ] + $this
      ->getCommonScopedFormElements() + parent::getScopedFormElements();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
GridStackFileFormatterBase::buildElements	public	function	Build the gridstack carousel elements.
GridStackFileFormatterBase::create	public static	function		1
GridStackFileFormatterBase::defaultSettings	public static	function
GridStackFileFormatterBase::getScopedFormElements	public	function		1
GridStackFileFormatterBase::viewElements	public	function
GridStackFormatterTrait::$formatter	protected	property	The gridstack field formatter manager.
GridStackFormatterTrait::$loggerFactory	protected	property	The logger factory.
GridStackFormatterTrait::$manager	protected	property	The gridstack field formatter manager.
GridStackFormatterTrait::admin	public	function	Returns the gridstack admin service shortcut.
GridStackFormatterTrait::blazyManager	public	function	Overrides the blazy manager.
GridStackFormatterTrait::buildSettings	public	function	Builds the settings.
GridStackFormatterTrait::formatter	public	function	Returns the gridstack field formatter service.
GridStackFormatterTrait::getCommonFieldDefinition	public	function	Defines the common scope for both front and admin.
GridStackFormatterTrait::getCommonScopedFormElements	public	function	Defines the common scope for the form elements.
GridStackFormatterTrait::injectServices	protected static	function	Injects DI services.
GridStackFormatterTrait::isApplicable	public static	function		4
GridStackFormatterTrait::manager	public	function	Returns the gridstack service.
GridStackFormatterTrait::settingsSummary	public	function
GridStackFormatterViewTrait::commonViewElements	public	function	Returns similar view elements.