You are here

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

class OrbitFormatter in ZURB Orbit 8

Plugin implementation of the 'Orbit' formatter.

Plugin annotation


@FieldFormatter(
  id = "orbit",
  label = @Translation("Zurb Orbit slider"),
  field_types = {
    "image"
  }
)

Hierarchy

Expanded class hierarchy of OrbitFormatter

File

src/Plugin/Field/FieldFormatter/OrbitFormatter.php, line 22

Namespace

Drupal\field_orbit\Plugin\Field\FieldFormatter
View source 
class OrbitFormatter extends ImageFormatter {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'animInFromRight' => 'slide-in-right',
      'animOutToRight' => 'slide-out-right',
      'animInFromLeft' => 'slide-in-left',
      'animOutToLeft' => 'slide-out-left',
      'caption' => '',
      'caption_link' => '',
      'autoPlay' => TRUE,
      'timerDelay' => 5000,
      'infiniteWrap' => TRUE,
      'swipe' => TRUE,
      'pauseOnHover' => TRUE,
      'accessible' => TRUE,
      'bullets' => TRUE,
      'navButtons' => TRUE,
      'containerClass' => 'orbit-container',
      'slideClass' => 'orbit-slide',
      'boxOfBullets' => 'orbit-bullets',
      'nextClass' => 'orbit-next',
      'prevClass' => 'orbit-previous',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {

    // Get image_style and image_link form elements from parent method.
    $element = parent::settingsForm($form, $form_state);
    $link_types = [
      'content' => $this
        ->t('Content'),
      'file' => $this
        ->t('File'),
    ];
    $captions = [
      'title' => $this
        ->t('Title text'),
      'alt' => $this
        ->t('Alt text'),
    ];
    $element['caption'] = [
      '#title' => $this
        ->t('Caption'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('caption'),
      '#empty_option' => $this
        ->t('Nothing'),
      '#options' => $captions,
    ];
    $element['caption_link'] = [
      '#title' => $this
        ->t('Link caption to'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('caption_link'),
      '#empty_option' => $this
        ->t('Nothing'),
      '#options' => $link_types,
      '#states' => [
        'invisible' => [
          ':input[name$="[settings_edit_form][settings][caption]"]' => [
            'value' => '',
          ],
        ],
      ],
    ];
    $element['animInFromRight'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('animInFromRight'),
      '#default_value' => $this
        ->getSetting('animInFromRight'),
      '#options' => $this
        ->getAnimationInOptions(),
    ];
    $element['animOutToRight'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('animOutToRight'),
      '#default_value' => $this
        ->getSetting('animOutToRight'),
      '#options' => $this
        ->getAnimationOutOptions(),
    ];
    $element['animInFromLeft'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('animInFromLeft'),
      '#default_value' => $this
        ->getSetting('animInFromLeft'),
      '#options' => $this
        ->getAnimationInOptions(),
    ];
    $element['animOutToLeft'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('animOutToLeft'),
      '#default_value' => $this
        ->getSetting('animOutToLeft'),
      '#options' => $this
        ->getAnimationOutOptions(),
    ];
    $element['autoPlay'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Autoplay'),
      '#default_value' => $this
        ->getSetting('autoPlay'),
      '#description' => $this
        ->t('Allows Orbit to automatically animate on page load.'),
    ];
    $element['timerDelay'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Timer speed'),
      '#element_validate' => [
        'element_validate_integer_positive',
      ],
      '#default_value' => $this
        ->getSetting('timerDelay'),
      '#description' => $this
        ->t('Amount of time, in ms, between slide transitions'),
    ];
    $element['infiniteWrap'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Infinite Wrap'),
      '#default_value' => $this
        ->getSetting('infiniteWrap'),
      '#description' => $this
        ->t('Allows Orbit to infinitely loop through the slides.'),
    ];
    $element['swipe'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Swipe'),
      '#default_value' => $this
        ->getSetting('swipe'),
      '#description' => $this
        ->t('Allows the Orbit slides to bind to swipe events for mobile.'),
    ];
    $element['pauseOnHover'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Pause on hover'),
      '#default_value' => $this
        ->getSetting('pauseOnHover'),
      '#description' => $this
        ->t('Pause slideshow when you hover on the slide.'),
    ];
    $element['accessible'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Keyboard events'),
      '#default_value' => $this
        ->getSetting('accessible'),
      '#description' => $this
        ->t('Allows Orbit to bind keyboard events to the slider.'),
    ];
    $element['bullets'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Bullets'),
      '#default_value' => $this
        ->getSetting('bullets'),
      '#description' => $this
        ->t('Show bullets.'),
    ];
    $element['navButtons'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Nav buttons'),
      '#default_value' => $this
        ->getSetting('navButtons'),
      '#description' => $this
        ->t('Show navigations buttons.'),
    ];
    $element['containerClass'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Container Class'),
      '#default_value' => $this
        ->getSetting('containerClass'),
      '#description' => $this
        ->t('Class applied to the container of Orbit'),
    ];
    $element['slideClass'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('slide class'),
      '#default_value' => $this
        ->getSetting('slideClass'),
      '#description' => $this
        ->t('Class applied to individual slides.'),
    ];
    $element['boxOfBullets'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Bullets class'),
      '#default_value' => $this
        ->getSetting('boxOfBullets'),
      '#description' => $this
        ->t('Class applied to the bullet container.'),
    ];
    $element['nextClass'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Next class'),
      '#default_value' => $this
        ->getSetting('nextClass'),
      '#description' => $this
        ->t('Class applied to the `next` navigation buton.'),
    ];
    $element['prevClass'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Prev class'),
      '#default_value' => $this
        ->getSetting('prevClass'),
      '#description' => $this
        ->t('Class applied to the `previous` navigation button.'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {

    // Get summary of image_style and image_link from parent method.
    $summary = parent::settingsSummary();
    $caption_types = [
      'title' => $this
        ->t('Title text'),
      'alt' => $this
        ->t('Alt text'),
    ];
    $link_types = [
      'content' => $this
        ->t('Content'),
      'file' => $this
        ->t('File'),
    ];

    // Display this setting only if there's a caption.
    $caption_types_settings = $this
      ->getSetting('caption');
    if (isset($caption_types[$caption_types_settings])) {
      $caption_message = $this
        ->t('Caption: @caption', [
        '@caption' => $caption_types[$caption_types_settings],
      ]);
      $link_types_settings = $this
        ->getSetting('caption_link');
      if (isset($link_types[$link_types_settings])) {
        $caption_message .= ' (' . $this
          ->t('Link to: @link', [
          '@link' => $link_types[$link_types_settings],
        ]) . ')';
      }
      $summary[] = $caption_message;
    }
    $summary[] = $this
      ->t('animInFromLeft: @effect', [
      '@effect' => $this
        ->getSetting('animInFromLeft'),
    ]);
    $summary[] = $this
      ->t('animInFromRight: @effect', [
      '@effect' => $this
        ->getSetting('animInFromRight'),
    ]);
    $summary[] = $this
      ->t('animOutToLeft: @effect', [
      '@effect' => $this
        ->getSetting('animOutToLeft'),
    ]);
    $summary[] = $this
      ->t('animOutToRight: @effect', [
      '@effect' => $this
        ->getSetting('animOutToRight'),
    ]);
    $summary[] = $this
      ->t('Autoplay: @autoplay', [
      '@autoplay' => $this
        ->getSetting('infiniteWrap') ? $this
        ->t('yes') : $this
        ->t('no'),
    ]);
    $summary[] = $this
      ->t('Timer delay: @speedms', [
      '@speed' => $this
        ->getSetting('timerDelay'),
    ]);
    $summary[] = $this
      ->t('Infinite wrap: @wrap', [
      '@wrap' => $this
        ->getSetting('infiniteWrap') ? $this
        ->t('yes') : $this
        ->t('no'),
    ]);
    $summary[] = $this
      ->t('Swipe enabled: @swipe', [
      '@swipe' => $this
        ->getSetting('swipe') ? $this
        ->t('yes') : $this
        ->t('no'),
    ]);
    $summary[] = $this
      ->t('Pause on hover: @pause', [
      '@pause' => $this
        ->getSetting('pauseOnHover') ? $this
        ->t('yes') : $this
        ->t('no'),
    ]);
    $summary[] = $this
      ->t('Keyboard navigation: @accessible', [
      '@accessible' => $this
        ->getSetting('accessible') ? $this
        ->t('yes') : $this
        ->t('no'),
    ]);
    $summary[] = $this
      ->t('bullets: @bullets', [
      '@bullets' => $this
        ->getSetting('bullets') ? $this
        ->t('yes') : $this
        ->t('no'),
    ]);
    $summary[] = $this
      ->t('Navigation buttons: @nav', [
      '@nav' => $this
        ->getSetting('navButtons') ? $this
        ->t('yes') : $this
        ->t('no'),
    ]);
    $summary[] = $this
      ->t('Container class: @class', [
      '@class' => $this
        ->getSetting('containerClass'),
    ]);
    $summary[] = $this
      ->t('Slide class: @class', [
      '@class' => $this
        ->getSetting('slideClass'),
    ]);
    $summary[] = $this
      ->t('Bullets class: @class', [
      '@class' => $this
        ->getSetting('boxOfBullets'),
    ]);
    $summary[] = $this
      ->t('Next class: @class', [
      '@class' => $this
        ->getSetting('nextClass'),
    ]);
    $summary[] = $this
      ->t('Previous class: @class', [
      '@class' => $this
        ->getSetting('nextClass'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {

    // Get image html from parent method.
    $images = parent::viewElements($items, $langcode);
    static $orbit_count;
    $orbit_count = is_int($orbit_count) ? $orbit_count + 1 : 1;
    $files = $this
      ->getEntitiesToView($items, $langcode);
    $elements = [];
    $entity = [];
    $links = [
      'image_link' => 'path',
      'caption_link' => 'caption_path',
    ];

    // Loop through required links (because image and
    // caption can have different links).
    foreach ($items 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 = $item
                ->getEntity();
              if (!$entity
                ->isNew()) {
                $uri = $entity
                  ->urlInfo();
                $uri = !empty($uri) ? $uri : '';
                $item
                  ->set($path, $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[$file_delta]
                  ->set($path, $uri);
              }
              break;
          }
        }
      }
    }
    $defaults = $this
      ->defaultSettings();
    if (count($items)) {

      // 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,
        '#options' => $options,
        '#entity' => $entity,
        '#image' => $images,
        '#orbit_id' => $orbit_count,
      ];
    }
    return $elements;
  }

  /**
   * Array of animations out options.
   *
   * @return array
   *   Array of animations options.
   */
  protected function getAnimationOutOptions() {
    return [
      "Slide" => [
        "slide-out-down" => $this
          ->t("slide-out-down"),
        "slide-out-left" => $this
          ->t("slide-out-left"),
        "slide-out-up" => $this
          ->t("slide-out-up"),
        "slide-out-right" => $this
          ->t("slide-out-right"),
      ],
      "Fade" => [
        "fade-out" => $this
          ->t("fade-out"),
      ],
      "Hinge" => [
        "hinge-out-from-top" => $this
          ->t("hinge-out-from-top"),
        "hinge-out-from-right" => $this
          ->t("hinge-out-from-right"),
        "hinge-out-from-bottom" => $this
          ->t("hinge-out-from-bottom"),
        "hinge-out-from-left" => $this
          ->t("hinge-out-from-left"),
        "hinge-out-from-middle-x" => $this
          ->t("hinge-out-from-middle-x"),
        "hinge-out-from-middle-y" => $this
          ->t("hinge-out-from-middle-y"),
      ],
      "Scale" => [
        "scale-out-up" => $this
          ->t("scale-out-up"),
        "scale-out-down" => $this
          ->t("scale-out-down"),
      ],
      "Spin" => [
        "spin-out" => $this
          ->t("spin-out"),
        "spin-out-ccw" => $this
          ->t("spin-out-ccw"),
      ],
    ];
  }

  /**
   * Array of animation in options.
   *
   * @return array
   *   Array of animation options.
   */
  protected function getAnimationInOptions() {
    return [
      "Slide" => [
        "slide-in-down" => $this
          ->t("slide-in-down"),
        "slide-in-left" => $this
          ->t("slide-in-left"),
        "slide-in-up" => $this
          ->t("slide-in-up"),
        "slide-in-right" => $this
          ->t("slide-in-right"),
      ],
      "Fade" => [
        "fade-in" => $this
          ->t("fade-in"),
      ],
      "Hinge" => [
        "hinge-in-from-top" => $this
          ->t("hinge-in-from-top"),
        "hinge-in-from-right" => $this
          ->t("hinge-in-from-right"),
        "hinge-in-from-bottom" => $this
          ->t("hinge-in-from-bottom"),
        "hinge-in-from-left" => $this
          ->t("hinge-in-from-left"),
        "hinge-in-from-middle-x" => $this
          ->t("hinge-in-from-middle-x"),
        "hinge-in-from-middle-y" => $this
          ->t("hinge-in-from-middle-y"),
      ],
      "Scale" => [
        "scale-in-up" => $this
          ->t("scale-in-up"),
        "scale-in-down" => $this
          ->t("scale-in-down"),
      ],
      "Spin" => [
        "spin-in" => $this
          ->t("spin-in"),
        "spin-in-ccw" => $this
          ->t("spin-in-ccw"),
      ],
    ];
  }

}

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
FileFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase::needsEntityLoad 1
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.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
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::create public static function Creates an instance of the plugin. Overrides FormatterBase::create 1
ImageFormatter::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase::onDependencyRemoval
ImageFormatter::__construct public function Constructs an ImageFormatter object. Overrides FormatterBase::__construct 1
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
OrbitFormatter::viewElements public function Builds a renderable array for a field value. Overrides ImageFormatter::viewElements 1
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.