abstract class SlickFileFormatterBase in Slick Carousel 8.2

Base class for slick image and file ER formatters.

Hierarchy

• class \Drupal\slick\Plugin\Field\FieldFormatter\SlickFileFormatterBase extends \Drupal\blazy\Plugin\Field\FieldFormatter\BlazyFileFormatterBase uses SlickFormatterTrait, SlickFormatterViewTrait

File

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

Namespace

Drupal\slick\Plugin\Field\FieldFormatter

abstract class SlickFileFormatterBase extends BlazyFileFormatterBase {
  use SlickFormatterTrait;
  use SlickFormatterViewTrait;

  /**
   * {@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 SlickDefault::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 slick carousel elements.
   */
  public function buildElements(array &$build, $files) {
    $settings =& $build['settings'];
    $item_id = $settings['item_id'];
    $tn_caption = empty($settings['thumbnail_caption']) ? NULL : $settings['thumbnail_caption'];
    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,
      ];

      // @todo remove, no longer file entity/VEF/M for pure Media.
      $this
        ->buildElement($element, $file);
      $settings = $element['settings'];

      // 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 slick item.
      $build['items'][$delta] = $element;

      // Build individual slick thumbnail.
      if (!empty($settings['nav'])) {
        $thumb = [
          'settings' => $settings,
        ];

        // Thumbnail usages: asNavFor pagers, dot, arrows, photobox thumbnails.
        $thumb[$item_id] = empty($settings['thumbnail_style']) ? [] : $this->formatter
          ->getThumbnail($settings, $element['item']);
        $thumb['caption'] = empty($element['item']->{$tn_caption}) ? [] : [
          '#markup' => Xss::filterAdmin($element['item']->{$tn_caption}),
        ];
        $build['thumb']['items'][$delta] = $thumb;
        unset($thumb);
      }
      unset($element);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getScopedFormElements() {
    $captions = [
      'title' => $this
        ->t('Title'),
      'alt' => $this
        ->t('Alt'),
    ];
    return [
      'namespace' => 'slick',
      'nav' => TRUE,
      'thumb_captions' => $captions,
      'thumb_positions' => TRUE,
    ] + parent::getScopedFormElements();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SlickFileFormatterBase::buildElements	public	function	Build the slick carousel elements.
SlickFileFormatterBase::create	public static	function		1
SlickFileFormatterBase::defaultSettings	public static	function
SlickFileFormatterBase::getScopedFormElements	public	function		1
SlickFileFormatterBase::viewElements	public	function
SlickFormatterTrait::$imageFactory	protected	property	The image factory service.
SlickFormatterTrait::$manager	protected	property	The slick field formatter manager.
SlickFormatterTrait::admin	public	function	Returns the slick admin service shortcut.
SlickFormatterTrait::buildSettings	public	function	Builds the settings.	1
SlickFormatterTrait::formatter	public	function	Returns the slick field formatter service.
SlickFormatterTrait::getCommonFieldDefinition	public	function	Defines the common scope for both front and admin.
SlickFormatterTrait::getCommonScopedFormElements	public	function	Defines the common scope for the form elements.
SlickFormatterTrait::imageFactory	public	function	Returns the image factory.
SlickFormatterTrait::injectServices	protected static	function	Injects DI services.
SlickFormatterTrait::isApplicable	public static	function		2
SlickFormatterTrait::manager	public	function	Returns the slick service.
SlickFormatterTrait::settingsSummary	public	function
SlickFormatterViewTrait::commonViewElements	public	function	Returns similar view elements.