class FieldSlideshow in Field Slideshow 8

Same name and namespace in other branches

8.3 src/Plugin/Field/FieldFormatter/FieldSlideshow.php \Drupal\field_slideshow\Plugin\Field\FieldFormatter\FieldSlideshow
8.2 src/Plugin/Field/FieldFormatter/FieldSlideshow.php \Drupal\field_slideshow\Plugin\Field\FieldFormatter\FieldSlideshow

Plugin implementation of the 'slideshow' formatter.

Plugin annotation


@FieldFormatter(
  id = "slideshow",
  label = @Translation("Slideshow"),
  field_types = {
    "image"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
    class \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
    class \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase
    class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatterBase
    class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter implements ContainerFactoryPluginInterface
    class \Drupal\field_slideshow\Plugin\Field\FieldFormatter\FieldSlideshow

Expanded class hierarchy of FieldSlideshow

File

src/Plugin/Field/FieldFormatter/FieldSlideshow.php, line 25: Contains \Drupal\field_slideshow\Plugin\Field\FieldFormatter\Slideshow.

Namespace

Drupal\field_slideshow\Plugin\Field\FieldFormatter

View source

class FieldSlideshow extends ImageFormatter {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return array(
      'image_style' => '',
      'image_link' => '',
      'slideshow_colorbox_image_style' => '',
      'slideshow_colorbox_slideshow' => '',
      'slideshow_colorbox_slideshow_speed' => '4000',
      'slideshow_colorbox_transition' => 'elastic',
      'slideshow_colorbox_speed' => '350',
      'slideshow_caption' => '',
      'slideshow_caption_link' => '',
      'slideshow_fx' => 'fade',
      'slideshow_speed' => '1000',
      'slideshow_timeout' => '4000',
      'slideshow_order' => '',
      'slideshow_controls' => 0,
      'slideshow_controls_pause' => 0,
      'slideshow_controls_position' => 'after',
      'slideshow_pause' => 0,
      'slideshow_start_on_hover' => 0,
      'slideshow_pager' => '',
      'slideshow_pager_position' => 'after',
      'slideshow_pager_image_style' => '',
    ) + 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 = array(
      'content' => t('Content'),
      'file' => t('File'),
    );
    $captions = array(
      'title' => t('Title text'),
      'alt' => t('Alt text'),
    );
    if (\Drupal::moduleHandler()
      ->moduleExists('colorbox')) {
      $element['image_link']['#options']['colorbox'] = 'Colorbox';
      $element['slideshow_colorbox_image_style'] = array(
        '#title' => t('Colorbox image style'),
        '#type' => 'select',
        '#default_value' => $this
          ->getSetting('slideshow_colorbox_image_style'),
        '#empty_option' => t('None (original image)'),
        '#options' => image_style_options(FALSE),
        '#states' => array(
          'visible' => array(
            ':input[name$="[settings_edit_form][settings][image_link]"]' => array(
              'value' => 'colorbox',
            ),
          ),
        ),
      );
      $colorbox_slideshow = array(
        'automatic' => t('Automatic'),
        'manual' => t('Manual'),
      );
      $element['slideshow_colorbox_slideshow'] = array(
        '#title' => t('Colorbox slideshow'),
        '#type' => 'select',
        '#default_value' => $this
          ->getSetting('slideshow_colorbox_slideshow'),
        '#empty_option' => t('No slideshow'),
        '#options' => $colorbox_slideshow,
        '#states' => array(
          'visible' => array(
            ':input[name$="[settings_edit_form][settings][image_link]"]' => array(
              'value' => 'colorbox',
            ),
          ),
        ),
      );
      $element['slideshow_colorbox_slideshow_speed'] = array(
        '#title' => t('Colorbox slideshow speed'),
        '#type' => 'textfield',
        '#size' => 5,
        '#default_value' => $this
          ->getSetting('slideshow_colorbox_slideshow_speed'),
        '#description' => t('Time between transitions (ms).'),
        '#states' => array(
          'invisible' => array(
            ':input[name$="[settings_edit_form][settings][slideshow_colorbox_slideshow]"]' => array(
              'value' => '',
            ),
          ),
        ),
      );
      $colorbox_transitions = array(
        'none' => t('None'),
        'elastic' => t('Elastic'),
        'fade' => t('Fade'),
      );
      $element['slideshow_colorbox_transition'] = array(
        '#title' => t('Colorbox transition'),
        '#type' => 'select',
        '#default_value' => $this
          ->getSetting('slideshow_colorbox_transition'),
        '#options' => $colorbox_transitions,
        '#states' => array(
          'visible' => array(
            ':input[name$="[settings_edit_form][settings][image_link]"]' => array(
              'value' => 'colorbox',
            ),
          ),
        ),
      );
      $element['slideshow_colorbox_speed'] = array(
        '#title' => t('Colorbox transition speed'),
        '#type' => 'textfield',
        '#size' => 5,
        '#default_value' => $this
          ->getSetting('slideshow_colorbox_speed'),
        '#description' => t('Duration of transition (ms).'),
        '#states' => array(
          'visible' => array(
            ':input[name$="[settings_edit_form][settings][image_link]"]' => array(
              'value' => 'colorbox',
            ),
          ),
        ),
      );
    }
    $element['slideshow_caption'] = array(
      '#title' => t('Caption'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('slideshow_caption'),
      '#empty_option' => t('Nothing'),
      '#options' => $captions,
    );
    $element['slideshow_caption_link'] = array(
      '#title' => t('Caption link'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('slideshow_caption_link'),
      '#empty_option' => t('Nothing'),
      '#options' => $link_types,
      '#states' => array(
        'invisible' => array(
          ':input[name$="[settings_edit_form][settings][slideshow_caption]"]' => array(
            'value' => '',
          ),
        ),
      ),
    );
    $element['slideshow_fx'] = array(
      '#title' => t('Transition effect'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('slideshow_fx'),
      '#options' => array(
        'blindX' => t('blindX'),
        'blindY' => t('blindY'),
        'blindZ' => t('blindZ'),
        'cover' => t('cover'),
        'curtainX' => t('curtainX'),
        'curtainY' => t('curtainY'),
        'fade' => t('fade'),
        'fadeZoom' => t('fadeZoom'),
        'growX' => t('growX'),
        'growY' => t('growY'),
        'scrollUp' => t('scrollUp'),
        'scrollDown' => t('scrollDown'),
        'scrollLeft' => t('scrollLeft'),
        'scrollRight' => t('scrollRight'),
        'scrollHorz' => t('scrollHorz'),
        'scrollVert' => t('scrollVert'),
        'shuffle' => t('shuffle'),
        'slideX' => t('slideX'),
        'slideY' => t('slideY'),
        'toss' => t('toss'),
        'turnUp' => t('turnUp'),
        'turnDown' => t('turnDown'),
        'turnLeft' => t('turnLeft'),
        'turnRight' => t('turnRight'),
        'uncover' => t('uncover'),
        'wipe' => t('wipe'),
        'zoom' => t('zoom'),
      ),
    );
    $element['slideshow_speed'] = array(
      '#title' => t('Transition speed'),
      '#type' => 'textfield',
      '#size' => 5,
      '#default_value' => $this
        ->getSetting('slideshow_speed'),
      '#description' => t('Duration of transition (ms).'),
      '#required' => TRUE,
    );
    $element['slideshow_timeout'] = array(
      '#title' => t('Timeout'),
      '#type' => 'textfield',
      '#size' => 5,
      '#default_value' => $this
        ->getSetting('slideshow_timeout'),
      '#description' => t('Time between transitions (ms). Enter 0 to disable automatic transitions (then, enable pager and/or controls).'),
      '#required' => TRUE,
    );
    $element['slideshow_order'] = array(
      '#title' => t('Order'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('slideshow_order'),
      '#empty_option' => t('Normal'),
      '#options' => array(
        'reverse' => t('Reverse'),
        'random' => t('Random'),
      ),
    );
    $element['slideshow_controls'] = array(
      '#title' => t('Create prev/next controls'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('slideshow_controls'),
    );
    $element['slideshow_controls_pause'] = array(
      '#title' => t('Create play/pause button'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('slideshow_controls_pause'),
      '#states' => array(
        'visible' => array(
          ':input[name$="[settings_edit_form][settings][slideshow_controls]"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    $element['slideshow_controls_position'] = array(
      '#title' => t('Prev/next controls position'),
      '#type' => 'select',
      '#options' => array(
        'before' => 'Before',
        'after' => 'After',
      ),
      '#default_value' => $this
        ->getSetting('slideshow_controls_position'),
      '#states' => array(
        'visible' => array(
          ':input[name$="[settings_edit_form][settings][slideshow_controls]"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
    );
    $element['slideshow_pause'] = array(
      '#title' => t('Pause on hover'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('slideshow_pause'),
    );
    $element['slideshow_start_on_hover'] = array(
      '#title' => t('Activate on hover'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('slideshow_start_on_hover'),
    );
    $element['slideshow_pager'] = array(
      '#title' => t('Pager'),
      '#type' => 'select',
      '#options' => array(
        'number' => 'Slide number',
        'image' => 'Image',
      ),
      '#empty_option' => t('None'),
      '#default_value' => $this
        ->getSetting('slideshow_pager'),
    );
    $element['slideshow_pager_position'] = array(
      '#title' => t('Pager position'),
      '#type' => 'select',
      '#options' => array(
        'before' => 'Before',
        'after' => 'After',
      ),
      '#default_value' => $this
        ->getSetting('slideshow_pager_position'),
      '#states' => array(
        'invisible' => array(
          ':input[name$="[settings_edit_form][settings][slideshow_pager]"]' => array(
            'value' => '',
          ),
        ),
      ),
    );
    $element['slideshow_pager_image_style'] = array(
      '#title' => t('Pager image style'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('slideshow_pager_image_style'),
      '#empty_option' => t('None (original image)'),
      '#options' => image_style_options(FALSE),
      '#states' => array(
        'visible' => array(
          ':input[name$="[settings_edit_form][settings][slideshow_pager]"]' => array(
            'value' => 'image',
          ),
        ),
      ),
    );
    return $element;
  }

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

    // get summary of image_style and image_link from parent method.
    $summary = parent::settingsSummary();
    $image_styles = image_style_options(FALSE);

    // Unset possible 'No defined styles' option.
    unset($image_styles['']);

    // Styles could be lost because of enabled/disabled modules that defines
    // their styles in code.
    $image_style_setting = $this
      ->getSetting('image_style');

    //Colorbox
    $image_link_setting = $this
      ->getSetting('image_link');
    if (isset($image_link_setting) && $image_link_setting == 'colorbox') {
      $link_type_message = t('Link to: @link', array(
        '@link' => $this
          ->getSetting('image_link'),
      ));
      $link_type_message .= ' (';
      $colorbox_img_style_settings = $this
        ->getSetting('slideshow_colorbox_image_style');
      if (!empty($colorbox_img_style_settings)) {
        $link_type_message .= t('Image style: @style', array(
          '@style' => $image_styles[$this
            ->getSetting('slideshow_colorbox_image_style')],
        ));
      }
      else {
        $link_type_message .= t('Original image');
      }
      $colorbox_slideshow_settings = $this
        ->getSetting('slideshow_colorbox_slideshow');
      if (isset($colorbox_slideshow_settings)) {
        $colorbox_slideshow = array(
          'automatic' => t('Automatic'),
          'manual' => t('Manual'),
        );
        if (isset($colorbox_slideshow[$this
          ->getSetting('slideshow_colorbox_slideshow')])) {
          $link_type_message .= ', with Slideshow (' . $colorbox_slideshow[$this
            ->getSetting('slideshow_colorbox_slideshow')] . ' - Speed: ' . $this
            ->getSetting('slideshow_colorbox_slideshow_speed') . ')';
        }
      }
      $link_type_message .= ')';
      $summary[] = $link_type_message;
    }
    $caption_types = array(
      'title' => t('Title text'),
      'alt' => t('Alt text'),
    );

    // Display this setting only if there's a caption.
    $caption_types_settings = $this
      ->getSetting('slideshow_caption');
    if (isset($caption_types[$caption_types_settings])) {
      $caption_message = t('Caption: @caption', array(
        '@caption' => $caption_types[$caption_types_settings],
      ));
      $link_types_settings = $this
        ->getSetting('slideshow_caption_link');
      if (isset($link_types[$link_types_settings])) {
        $caption_message .= ' (' . t('Link to: @link', array(
          '@link' => $link_types[$link_types_settings],
        )) . ')';
      }
      $summary[] = $caption_message;
    }
    $summary[] = t('Transition effect: @effect', array(
      '@effect' => $this
        ->getSetting('slideshow_fx'),
    ));
    $summary[] = t('Speed: @speed', array(
      '@speed' => $this
        ->getSetting('slideshow_speed'),
    ));
    $summary[] = t('Timeout: @timeout', array(
      '@timeout' => $this
        ->getSetting('slideshow_timeout'),
    ));
    $orders = array(
      'reverse' => t('Reverse order'),
      'random' => t('Random order'),
    );
    $orders_settings = $this
      ->getSetting('slideshow_order');
    if (isset($orders[$orders_settings])) {
      $summary[] = $orders[$orders_settings];
    }
    $pause_button_text = "";
    $slideshow_controls_pause = $this
      ->getSetting('slideshow_controls_pause');
    $slideshow_controls = $this
      ->getSetting('slideshow_controls');
    $slideshow_pause = $this
      ->getSetting('slideshow_pause');
    $slideshow_start_on_hover = $this
      ->getSetting('slideshow_start_on_hover');
    if (isset($slideshow_controls_pause) && $slideshow_controls_pause) {
      $pause_button_text = " " . t("(with play/pause)");
    }
    if (isset($slideshow_controls) && $slideshow_controls) {
      $summary[] = t('Create prev/next controls') . $pause_button_text;
    }
    if (isset($slideshow_pause) && $slideshow_pause) {
      $summary[] = t('Pause on hover');
    }
    if (isset($slideshow_start_on_hover) && $slideshow_start_on_hover) {
      $summary[] = t('Activate on hover');
    }
    switch ($this
      ->getSetting('slideshow_pager')) {
      case 'number':
        $summary[] = t('Pager') . ': ' . t('Slide number');
        break;
      case 'image':
        $pager_image_message = t('Pager') . ': ' . t('Image') . ' (';
        if (isset($image_styles[$this
          ->getSetting('slideshow_pager_image_style')])) {
          $pager_image_message .= t('Image style: @style', array(
            '@style' => $image_styles[$this
              ->getSetting('slideshow_pager_image_style')],
          ));
        }
        else {
          $pager_image_message .= t('Original image');
        }
        $pager_image_message .= ')';
        $summary[] = $pager_image_message;
        break;
    }
    return $summary;
  }

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

    // get image html from parent method.
    $images = parent::viewElements($items, $langcode);
    static $slideshow_count;
    $slideshow_count = is_int($slideshow_count) ? $slideshow_count + 1 : 1;
    $files = $this
      ->getEntitiesToView($items, $langcode);

    // Check plugins
    if (\Drupal::moduleHandler()
      ->moduleExists('libraries')) {
      if (!file_exists(DRUPAL_ROOT . '/libraries/jquery.cycle/jquery.cycle.all.min.js') && !file_exists(DRUPAL_ROOT . '/libraries/jquery.cycle/jquery.cycle.all.js')) {
        $url = Url::fromRoute('system.status');
        drupal_set_message(t('JQuery Cycle must be installed in order to run the slideshow. Please go to !page for instructions.', array(
          '!page' => \Drupal::l(t('Status Report'), $url),
        )), 'warning', FALSE);
      }
    }
    else {
      $url = Url::fromUri('http://drupal.org/project/libraries');
      drupal_set_message(t('Please install the !module module in order to use Field Slideshow.', array(
        '!module' => \Drupal::l('Libraries API', $url),
      )), 'warning', FALSE);
    }
    $elements = array();
    $entity = array();
    $links = array(
      'image_link' => 'path',
      'slideshow_caption_link' => 'caption_path',
    );

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

      // Set Image caption
      if ($this
        ->getSetting('slideshow_caption') != '') {
        $caption_settings = $this
          ->getSetting('slideshow_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;
            case 'colorbox':
              $attrib = array();

              // check if we need a thumbnail and change the link
              $entity = $item
                ->getEntity();
              foreach ($files as $file_delta => $file) {
                $image_uri = $file
                  ->getFileUri();
                $uri = Url::fromUri(file_create_url($image_uri));
                $uri = !empty($uri) ? $uri : '';
                if ($this
                  ->getSetting('slideshow_colorbox_image_style') != '') {
                  $uri = ImageStyle::load($this
                    ->getSetting('slideshow_colorbox_image_style'))
                    ->buildUrl($image_uri);
                  $attrib['uri'] = $uri;
                }
                else {
                  $attrib['uri'] = $uri
                    ->getUri();
                }

                //add correct attributes
                $attrib['attributes'] = array(
                  'class' => array(
                    'colorbox',
                  ),
                  'rel' => 'field-slideshow[' . 'nid' . '-' . $entity
                    ->id() . ']',
                );
                if ($this
                  ->getSetting('slideshow_caption') != '' && isset($items[$file_delta]
                  ->getValue()['caption'])) {
                  $attrib['attributes']['title'] = $items[$file_delta]
                    ->getValue()['caption'];
                }
                $colorbox_slideshow = $this
                  ->getSetting('slideshow_colorbox_slideshow');
                if (!empty($colorbox_slideshow)) {
                  $attrib['attributes']['class'] = array(
                    'colorbox',
                  );
                  $attrib['uri'] .= strpos($attrib['uri'], '?') === FALSE ? '?' : '&';
                  $attrib['uri'] .= 'slideshow=true&slideshowAuto=' . ($this
                    ->getSetting('slideshow_colorbox_slideshow') == 'automatic' ? 'true' : 'false') . '&slideshowSpeed=' . $this
                    ->getSetting('slideshow_colorbox_slideshow_speed') . '&speed=' . $this
                    ->getSetting('slideshow_colorbox_speed') . '&transition=' . $this
                    ->getSetting('slideshow_colorbox_transition');
                }
                $items[$file_delta]
                  ->set($path, $attrib);
              }
              break;
          }
        }
      }
    }
    $pager = array(
      '#theme' => 'field_slideshow_pager',
      '#items' => $items,
      '#pager' => $this
        ->getSetting('slideshow_pager'),
      '#pager_image_style' => $this
        ->getSetting('slideshow_pager_image_style'),
      '#slideshow_id' => $slideshow_count,
    );
    $controls = array(
      '#theme' => 'field_slideshow_controls',
      '#slideshow_id' => $slideshow_count,
      '#controls_pause' => $this
        ->getSetting('slideshow_controls_pause'),
    );
    $elements[] = array(
      '#theme' => 'field_slideshow',
      '#items' => $items,
      '#image_style' => $this
        ->getSetting('image_style'),
      '#image' => $images,
      '#order' => $this
        ->getSetting('slideshow_order'),
      '#controls' => $this
        ->getSetting('slideshow_controls') == 1 ? $controls : array(),
      '#controls_position' => $this
        ->getSetting('slideshow_controls_position'),
      '#pager' => $this
        ->getSetting('slideshow_pager') !== '' ? $pager : array(),
      '#pager_position' => $this
        ->getSetting('slideshow_pager_position'),
      '#entity' => $entity,
      '#slideshow_id' => $slideshow_count,
      '#js_variables' => array(
        'fx' => $this
          ->getSetting('slideshow_fx'),
        'speed' => $this
          ->getSetting('slideshow_speed'),
        'timeout' => $this
          ->getSetting('slideshow_timeout'),
        'pause' => $this
          ->getSetting('slideshow_pause'),
        'start_on_hover' => $this
          ->getSetting('slideshow_start_on_hover'),
        // Need to access the following variables in js too
        'pager' => $this
          ->getSetting('slideshow_pager'),
        'controls' => $this
          ->getSetting('slideshow_controls') === 1 ? $controls : array(),
      ),
    );
    return $elements;
  }

}

Members

Name	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
FieldSlideshow::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides ImageFormatter::defaultSettings
FieldSlideshow::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides ImageFormatter::settingsForm
FieldSlideshow::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides ImageFormatter::settingsSummary
FieldSlideshow::viewElements	public	function	Builds a renderable array for a field value. Overrides ImageFormatter::viewElements
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.
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.

You are here

class FieldSlideshow in Field Slideshow 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation