You are here

abstract class SlickEntityFormatterBase in Slick Carousel 7.3

Same name and namespace in other branches
  1. 8.2 src/Plugin/Field/FieldFormatter/SlickEntityFormatterBase.php \Drupal\slick\Plugin\Field\FieldFormatter\SlickEntityFormatterBase
  2. 8 src/Plugin/Field/FieldFormatter/SlickEntityFormatterBase.php \Drupal\slick\Plugin\Field\FieldFormatter\SlickEntityFormatterBase

Base class for slick entity reference formatters without field details.

Hierarchy

Expanded class hierarchy of SlickEntityFormatterBase

File

src/Plugin/Field/FieldFormatter/SlickEntityFormatterBase.php, line 13

Namespace

Drupal\slick\Plugin\Field\FieldFormatter
View source
abstract class SlickEntityFormatterBase extends BlazyEntityBase {
  use SlickFormatterTrait;

  /**
   * Constructs a SlickEntityFormatter instance.
   */
  public function __construct($plugin_id, $field, $instance, SlickFormatterInterface $formatter, SlickManagerInterface $manager) {
    parent::__construct($plugin_id, $field, $instance);
    $this->formatter = $formatter;
    $this->manager = $manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return SlickDefault::baseSettings() + [
      'view_mode' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildSettings() {
    $settings = parent::buildSettings();

    // Asks for Blazy to deal with iFrames, and mobile-optimized lazy loading.
    $settings['blazy'] = TRUE;
    $settings['vanilla'] = TRUE;
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function getScopedFormElements() {
    return [
      'no_layouts' => TRUE,
    ] + parent::getScopedFormElements();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlazyEntityBase::$blazyEntity protected property The blazy entity instance.
BlazyEntityBase::blazyEntity public function Returns the blazy entity object.
BlazyEntityBase::buildElement public function Build individual item contents. Overrides BlazyFormatterBase::buildElement 1
BlazyEntityBase::buildElements public function Returns media contents.
BlazyEntityBase::getEntitiesToView protected function Converts $items array to object for easy D8 -> D7 backports. Overrides BlazyFormatterBase::getEntitiesToView
BlazyEntityBase::settingsForm public function Implements hook_field_formatter_settings_form(). Overrides BlazyFormatterBase::settingsForm 1
BlazyFormatterBase::getRequiredForms public function Returns required form elements for the current formatter. Overrides FormatterBase::getRequiredForms 2
BlazyFormatterTrait::$formatter protected property The blazy-related formatter service.
BlazyFormatterTrait::$manager protected property The blazy field formatter manager.
BlazyFormatterTrait::formatter public function Returns the blazy-related formatter.
BlazyFormatterTrait::manager public function Returns the blazy service.
BlazyFormatterTrait::settingsSummary public function
FormatterBase::$admin protected property The blazy-related admin formatter service.
FormatterBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$fieldDisplay protected property The field display.
FormatterBase::$fieldInstance protected property The field instance.
FormatterBase::$htmlSettings protected property The form settings.
FormatterBase::$isMultiple protected property True if the field cardinality equals -1.
FormatterBase::$knownEntities protected property The known hard-coded entities.
FormatterBase::$langcode protected property The langcode.
FormatterBase::$pluginId protected property The blazy formatter plugin id.
FormatterBase::$settings protected property The formatter settings.
FormatterBase::$viewMode protected property The view mode.
FormatterBase::buildSettingsForm public function Implements hook_field_formatter_settings_form().
FormatterBase::buildSettingsSummary public function
FormatterBase::getHtmlSettings public function Gets html settings.
FormatterBase::getPluginId public function Gets formatter plugin id.
FormatterBase::getSetting public function
FormatterBase::getSettings public function Gets formatter settings.
FormatterBase::mergeDefaults protected function Merges default settings values into $settings.
FormatterBase::setHtmlSettings public function Sets html settings.
FormatterBase::setSetting public function
FormatterBase::setSettings public function Sets formatter settings.
FormatterBase::setupFieldVariables protected function Setup common variables across different hooks.
FormatterBase::view public function Implements hook_field_formatter_view().
SlickEntityFormatterBase::buildSettings public function Builds the settings. Overrides FormatterBase::buildSettings
SlickEntityFormatterBase::defaultSettings public static function Returns default settings. Overrides BlazyFormatterBase::defaultSettings
SlickEntityFormatterBase::getScopedFormElements public function Defines the scope for the form elements. Overrides BlazyEntityBase::getScopedFormElements
SlickEntityFormatterBase::__construct public function Constructs a SlickEntityFormatter instance. Overrides FormatterBase::__construct
SlickFormatterTrait::admin public function Returns the slick admin service.
SlickFormatterTrait::viewElements public function 1