abstract class SlickEntityReferenceFormatterBase in Slick Carousel 8.2

Base class for slick entity reference formatters with field details.

Hierarchy

• class \Drupal\slick\Plugin\Field\FieldFormatter\SlickEntityReferenceFormatterBase extends \Drupal\blazy\Dejavu\BlazyEntityReferenceBase implements ContainerFactoryPluginInterface uses SlickFormatterTrait

See also

\Drupal\slick_media\Plugin\Field\FieldFormatter

\Drupal\slick_paragraphs\Plugin\Field\FieldFormatter

File

src/Plugin/Field/FieldFormatter/SlickEntityReferenceFormatterBase.php, line 16

Namespace

Drupal\slick\Plugin\Field\FieldFormatter

abstract class SlickEntityReferenceFormatterBase extends BlazyEntityReferenceBase implements ContainerFactoryPluginInterface {
  use SlickFormatterTrait {
    buildSettings as traitBuildSettings;
  }

  /**
   * The logger factory.
   *
   * @var \Drupal\Core\Logger\LoggerChannelFactoryInterface
   */
  protected $loggerFactory;

  /**
   * {@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, 'entity');
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return SlickDefault::extendedSettings() + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function buildElementThumbnail(array &$build, $element, $entity, $delta) {

    // @todo move it to Slick as too specific for Slick which has thumbnail.
    // The settings in $element has updated metadata extracted from media.
    $settings = $element['settings'];
    $item_id = $settings['item_id'];
    if (!empty($settings['nav'])) {

      // Thumbnail usages: asNavFor pagers, dot, arrows, photobox thumbnails.
      $element[$item_id] = empty($settings['thumbnail_style']) ? [] : $this
        ->formatter()
        ->getThumbnail($settings, $element['item']);
      $element['caption'] = empty($settings['thumbnail_caption']) ? [] : $this
        ->blazyEntity()
        ->getFieldRenderable($entity, $settings['thumbnail_caption'], $settings['view_mode']);
      $build['thumb']['items'][$delta] = $element;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getScopedFormElements() {
    $admin = $this
      ->admin();
    $target_type = $this
      ->getFieldSetting('target_type');
    $views_ui = $this
      ->getFieldSetting('handler') == 'default';
    $bundles = $views_ui ? [] : $this
      ->getFieldSetting('handler_settings')['target_bundles'];
    $texts = [
      'text',
      'text_long',
      'string',
      'string_long',
      'link',
    ];
    $texts = $admin
      ->getFieldOptions($bundles, $texts, $target_type);
    return [
      'thumb_captions' => $texts,
      'thumb_positions' => TRUE,
      'nav' => TRUE,
    ] + $this
      ->getCommonScopedFormElements() + parent::getScopedFormElements();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SlickEntityReferenceFormatterBase::$loggerFactory	protected	property	The logger factory.
SlickEntityReferenceFormatterBase::buildElementThumbnail	public	function
SlickEntityReferenceFormatterBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SlickEntityReferenceFormatterBase::defaultSettings	public static	function
SlickEntityReferenceFormatterBase::getScopedFormElements	public	function		1
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. Aliased as: traitBuildSettings	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