You are here

Home » API reference » ZURB Orbit 8 » OrbitMediaFormatter.php

class OrbitMediaFormatter in ZURB Orbit 8

Plugin implementation of the 'Orbit' formatter.

Plugin annotation


@FieldFormatter(
  id = "orbit_media",
  label = @Translation("Zurb Orbit Slider"),
  field_types = {
    "entity_reference"
  }
)

Hierarchy

Expanded class hierarchy of OrbitMediaFormatter

File

src/Plugin/Field/FieldFormatter/OrbitMediaFormatter.php, line 26

Namespace

Drupal\field_orbit\Plugin\Field\FieldFormatter
View source 
class OrbitMediaFormatter extends OrbitFormatter {

  /**
   * The typed data manager.
   *
   * @var \Drupal\Core\TypedData\TypedDataManagerInterface
   */
  protected $typedDataManager;

  /**
   * OrbitMediaFormatter constructor.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings settings.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   * @param \Drupal\Core\Entity\EntityStorageInterface $image_style_storage
   *   The image style storage.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, $settings, $label, $view_mode, $third_party_settings, AccountInterface $current_user, EntityStorageInterface $image_style_storage, TypedDataManagerInterface $typed_data_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $current_user, $image_style_storage);
    $this->typedDataManager = $typed_data_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('current_user'), $container
      ->get('entity.manager')
      ->getStorage('image_style'), $container
      ->get('typed_data_manager'));
  }

  /**
   * {@inheritdoc}
   *
   * This has to be overridden because FileFormatterBase expects $item to be
   * of type \Drupal\file\Plugin\Field\FieldType\FileItem and calls
   * isDisplayed() which is not in FieldItemInterface.
   */
  protected function needsEntityLoad(EntityReferenceItem $item) {
    return !$item
      ->hasNewEntity();
  }

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

    // This formatter is only available for entity types that reference
    // media items.
    return $field_definition
      ->getFieldStorageDefinition()
      ->getSetting('target_type') == 'media';
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $images = [];
    $media_items = $this
      ->getEntitiesToView($items, $langcode);

    // Early opt-out if the field is empty.
    if (empty($media_items)) {
      return $elements;
    }

    // Initialize the list definition type to mock image field values.
    $list_definition = ListDataDefinition::create('field_item:image');

    /** @var \Drupal\Core\Field\FieldItemListInterface $items_list */
    $items_list = $this->typedDataManager
      ->create($list_definition);
    foreach ($media_items as $key => $item) {

      // Currently only image media bundles are supported.
      if ($item
        ->get('field_media_image')
        ->isEmpty()) {
        continue;
      }
      $image_item = $item
        ->get('field_media_image')
        ->first();

      // Add the file entity to the items list.
      $items_list
        ->appendItem($image_item
        ->getValue());

      // Store other values used by the template.
      $files[$key] = $image_item->entity;
      $images[$key] = [
        '#theme' => 'image_formatter',
        '#item' => $image_item,
        '#item_attributes' => [],
        '#image_style' => $this
          ->getSetting('image_style'),
        '#url' => Url::fromUri(file_create_url($image_item->entity
          ->get('uri')->value)),
      ];
    }
    static $orbit_count;
    $orbit_count = is_int($orbit_count) ? $orbit_count + 1 : 1;
    $entity = [];
    $item_settings = [];
    $links = [
      'image_link' => 'path',
      'caption_link' => 'caption_path',
    ];

    // Loop through required links (because image and
    // caption can have different links).
    foreach ($items_list as $delta => $item) {

      // Set Image caption.
      if ($this
        ->getSetting('caption') != '') {
        $caption_settings = $this
          ->getSetting('caption');
        if ($caption_settings == 'title') {
          $item_settings[$delta]['caption'] = $item
            ->getValue()['title'];
        }
        elseif ($caption_settings == 'alt') {
          $item_settings[$delta]['caption'] = $item
            ->getValue()['alt'];
        }
        $item
          ->set('caption', $item_settings[$delta]['caption']);
      }

      // Set Image and Caption Link.
      foreach ($links as $setting => $path) {
        if ($this
          ->getSetting($setting) != '') {
          switch ($this
            ->getSetting($setting)) {
            case 'content':
              $entity = $items[$delta]
                ->getEntity();
              if (!$entity
                ->isNew()) {
                $uri = $entity
                  ->urlInfo();
                $uri = !empty($uri) ? $uri : '';
                $item
                  ->set($path, $uri);
                $images[$delta]['#url'] = $uri;
              }
              break;
            case 'file':
              foreach ($files as $file_delta => $file) {
                $image_uri = $file
                  ->getFileUri();
                $uri = Url::fromUri(file_create_url($image_uri));
                $uri = !empty($uri) ? $uri : '';
                $items_list[$file_delta]
                  ->set($path, $uri);
              }
              break;
          }
        }
      }
    }
    $defaults = $this
      ->defaultSettings();
    if (count($items_list)) {

      // Only include non-default values to minimize html output.
      $options = [];
      foreach ($defaults as $key => $setting) {

        // Don't pass these to orbit.
        if ($key == 'caption_link' || $key == 'caption' || $key == 'image_style') {
          continue;
        }
        if ($this
          ->getSetting($key) != $setting) {
          $options[$key] = $this
            ->getSetting($key);
        }
      }
      $elements[] = [
        '#theme' => 'field_orbit',
        '#items' => $items_list,
        '#options' => $options,
        '#entity' => $entity,
        '#image' => $images,
        '#orbit_id' => $orbit_count,
      ];
    }
    return $elements;
  }

}

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
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
FileFormatterBase::checkAccess protected function Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess
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.
ImageFormatter::$currentUser protected property The current user.
ImageFormatter::$imageStyleStorage protected property The image style entity storage.
ImageFormatter::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
ImageFormatter::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase::onDependencyRemoval
ImageFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. Overrides EntityReferenceFormatterBase::getEntitiesToView
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
OrbitFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides ImageFormatter::defaultSettings
OrbitFormatter::getAnimationInOptions protected function Array of animation in options.
OrbitFormatter::getAnimationOutOptions protected function Array of animations out options.
OrbitFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides ImageFormatter::settingsForm
OrbitFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides ImageFormatter::settingsSummary
OrbitMediaFormatter::$typedDataManager protected property The typed data manager.
OrbitMediaFormatter::create public static function Creates an instance of the plugin. Overrides ImageFormatter::create
OrbitMediaFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
OrbitMediaFormatter::needsEntityLoad protected function This has to be overridden because FileFormatterBase expects $item to be of type \Drupal\file\Plugin\Field\FieldType\FileItem and calls isDisplayed() which is not in FieldItemInterface. Overrides FileFormatterBase::needsEntityLoad
OrbitMediaFormatter::viewElements public function Builds a renderable array for a field value. Overrides OrbitFormatter::viewElements
OrbitMediaFormatter::__construct public function OrbitMediaFormatter constructor. Overrides ImageFormatter::__construct
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.