You are here

Home » API reference » Flex Slider 8.2 » FlexsliderEntityFormatter.php

class FlexsliderEntityFormatter in Flex Slider 8.2

Plugin implementation of the 'flexslider_entity' formatter.

Plugin annotation


@FieldFormatter(
  id = "flexslider_entity",
  label = @Translation("FlexSlider (Entity view)"),
  field_types = {
    "entity_reference",
    "entity_reference_revisions"
  }
)

Hierarchy

Expanded class hierarchy of FlexsliderEntityFormatter

File

flexslider_fields/src/Plugin/Field/FieldFormatter/FlexsliderEntityFormatter.php, line 24

Namespace

Drupal\flexslider_fields\Plugin\Field\FieldFormatter
View source 
class FlexsliderEntityFormatter extends EntityReferenceEntityFormatter {
  use FlexsliderFormatterTrait;

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

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    return array_merge(parent::settingsSummary(), $this
      ->buildSettingsSummary());
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    return parent::settingsForm($form, $form_state) + $this
      ->buildSettingsForm();
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $entities = parent::viewElements($items, $langcode);

    // Bail out if there are no entities to render.
    if (empty($entities)) {
      return [];
    }
    $formatter_settings = $this
      ->getSettings();

    // Get cache tags for the option set.
    if ($optionset = Flexslider::load($formatter_settings['optionset'])) {
      $cache_tags = $optionset
        ->getCacheTags();
    }
    else {
      $cache_tags = [];
    }
    $items = [];
    foreach ($entities as $delta => &$entity) {

      // Merge in the cache tags.
      if ($cache_tags) {
        $entity['#cache']['tags'] = Cache::mergeTags($entity['#cache']['tags'], $cache_tags);
      }

      // Prepare the slide item render array.
      $item = [];
      $item['slide'] = $entity;
      $items[$delta] = $item;
    }
    return [
      '#theme' => 'flexslider',
      '#flexslider' => [
        'settings' => $formatter_settings,
        'items' => $items,
      ],
      // @todo we probably want a twig template for this.
      '#prefix' => '<div class="flexslider-field-wrapper">',
      '#suffix' => '</div>',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {

    // @todo This could be shared with the other formatters.
    // This formatter only applies to multi-valued entity reference fields.
    return parent::isApplicable($field_definition) && $field_definition
      ->getFieldStorageDefinition()
      ->isMultiple();
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return parent::calculateDependencies() + $this
      ->getOptionsetDependencies();
  }

  /**
   * {@inheritdoc}
   */
  public function onDependencyRemoval(array $dependencies) {
    $changed = parent::onDependencyRemoval($dependencies);
    if ($this
      ->optionsetDependenciesDeleted($dependencies)) {
      $changed = TRUE;
    }
    return $changed;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityReferenceEntityFormatter::$entityDisplayRepository protected property The entity display repository.
EntityReferenceEntityFormatter::$entityTypeManager protected property The entity type manager.
EntityReferenceEntityFormatter::$loggerFactory protected property The logger factory.
EntityReferenceEntityFormatter::$recursiveRenderDepth protected static property An array of counters for the recursive rendering protection.
EntityReferenceEntityFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
EntityReferenceEntityFormatter::RECURSIVE_RENDER_LIMIT constant The number of times this formatter allows rendering the same entity.
EntityReferenceEntityFormatter::__construct public function Constructs a EntityReferenceEntityFormatter instance. Overrides FormatterBase::__construct
EntityReferenceFormatterBase::checkAccess protected function Checks access to the given entity. 3
EntityReferenceFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. 1
EntityReferenceFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. 1
EntityReferenceFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view public function Overrides FormatterBase::view
FlexsliderEntityFormatter::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
FlexsliderEntityFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides EntityReferenceEntityFormatter::defaultSettings
FlexsliderEntityFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides EntityReferenceEntityFormatter::isApplicable
FlexsliderEntityFormatter::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase::onDependencyRemoval
FlexsliderEntityFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides EntityReferenceEntityFormatter::settingsForm
FlexsliderEntityFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides EntityReferenceEntityFormatter::settingsSummary
FlexsliderEntityFormatter::viewElements public function Builds a renderable array for a field value. Overrides EntityReferenceEntityFormatter::viewElements
FlexsliderFormatterTrait::buildSettingsForm protected function Builds the FlexSlider settings form.
FlexsliderFormatterTrait::buildSettingsSummary protected function Builds the FlexSlider settings summary.
FlexsliderFormatterTrait::getDefaultSettings protected static function Returns the FlexSlider specific default settings.
FlexsliderFormatterTrait::getOptionsetDependencies protected function Return the currently configured option set as a dependency array.
FlexsliderFormatterTrait::loadOptionset protected function Loads the selected option set.
FlexsliderFormatterTrait::optionsetDependenciesDeleted protected function If a dependency is going to be deleted, set the option set to default.
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.