public function JCarouselFormatter::settingsForm in jCarousel 8.4

Same name and namespace in other branches

1. 8.5 src/Plugin/Field/FieldFormatter/JCarouselFormatter.php \Drupal\jcarousel\Plugin\Field\FieldFormatter\JCarouselFormatter::settingsForm()

Returns a form to configure settings for the formatter.

Invoked from \Drupal\field_ui\Form\EntityDisplayFormBase to allow administrators to configure the formatter. The field_ui module takes care of handling submitted form values.

Parameters

array $form: The form where the settings form is being included in.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form elements for the formatter settings.

Overrides ImageFormatter::settingsForm

File

src/Plugin/Field/FieldFormatter/JCarouselFormatter.php, line 70

Contains \Drupal\jcarousel\Plugin\Field\FieldFormatter\JCarouselFormatter.

Class

JCarouselFormatter

Plugin implementation of the 'jCarousel' formatter.

Namespace

Drupal\jcarousel\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $element = parent::settingsForm($form, $form_state);

  // Build the list of skins as options.
  $skins = $this
    ->getSkins();
  foreach ($skins as $key => $skin) {
    $skins[$key] = $skin['label'];
  }
  $skins[''] = $this
    ->t('None');

  // Number of options to provide in count-based options.
  $start_range = range(-10, 10);
  $range = array_combine($start_range, $start_range);

  // Remove '0'.
  unset($range[0]);
  $auto_range = [
    '' => t('Auto'),
  ] + array_combine(range(1, 10), range(1, 10));
  $element['description'] = array(
    '#type' => 'markup',
    '#value' => '<div class="messages">' . t('The jCarousel style is affected by several other settings within the display. Enable the "Use AJAX" option on your display to have items loaded dynamically. The "Items to display" option will determine how many items are preloaded into the carousel on each AJAX request. Non-AJAX carousels will contain the total number of items set in the "Items to display" option. Carousels may not be used with the "Use pager" option.') . '</div>',
  );
  $element['wrap'] = array(
    '#type' => 'select',
    '#title' => t('Wrap content'),
    '#default_value' => $this
      ->getSetting('wrap'),
    '#description' => t('Specifies whether to wrap at the first/last item (or both) and jump back to the start/end.'),
    '#options' => array(
      0 => t('Disabled'),
      'circular' => t('Circular'),
      'both' => t('Both'),
      'last' => t('Last'),
      'first' => t('First'),
    ),
  );
  $element['skin'] = array(
    '#type' => 'select',
    '#title' => t('Skin'),
    '#default_value' => $this
      ->getSetting('skin'),
    '#options' => $skins,
    '#description' => t('Skins may be provided by other modules. Set to "None" if your theme includes carousel theming directly in style.css or another stylesheet. "None" does not include any built-in navigation, arrows, or positioning at all.'),
  );
  $element['responsive'] = array(
    '#type' => 'checkbox',
    '#title' => t('Responsive (number of items)'),
    '#default_value' => $this
      ->getSetting('responsive'),
    '#description' => t('Select this option to have the carousel automatically adjust the number of visible items and the number of items to scroll at a time based on the available width.') . ' <strong>' . t('Changing this option will override the "Visible" and "Scroll" options and set carousel orientation to "horizontal".') . '</strong>',
  );
  $element['visible'] = array(
    '#type' => 'select',
    '#title' => t('Number of visible items'),
    '#options' => $auto_range,
    '#default_value' => $this
      ->getSetting('visible'),
    '#description' => t('Set an exact number of items to show at a time. It is recommended to leave set this to "auto", in which the number of items will be determined automatically by the space available to the carousel.') . ' <strong>' . t('Changing this option will override "width" properties set in your CSS.') . '</strong>',
  );
  $element['scroll'] = array(
    '#type' => 'select',
    '#title' => t('Scroll'),
    '#description' => t('The number of items to scroll at a time. The "auto" setting scrolls all the visible items.'),
    '#options' => $auto_range,
    '#default_value' => $this
      ->getSetting('scroll'),
  );
  $element['auto'] = array(
    '#type' => 'textfield',
    '#title' => t('Auto-scroll after'),
    '#size' => 4,
    '#maxlength' => 4,
    '#default_value' => $this
      ->getSetting('auto'),
    '#field_suffix' => ' ' . t('seconds'),
    '#description' => t('Specifies how many seconds to periodically auto-scroll the content. If set to 0 (default) then autoscrolling is turned off.'),
  );
  $element['navigation'] = array(
    '#type' => 'select',
    '#title' => t('Enable navigation'),
    '#options' => array(
      '' => t('None'),
      'before' => t('Before'),
      'after' => t('After'),
    ),
    '#default_value' => $this
      ->getSetting('navigation'),
    '#description' => t('Enable a clickable navigation list to jump straight to a given page.'),
  );
  $element['advanced'] = array(
    '#type' => 'fieldset',
    '#title' => t('Advanced'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#parents' => array(
      'style_options',
    ),
  );
  $element['advanced']['animation'] = array(
    '#type' => 'textfield',
    '#title' => t('Animation speed'),
    '#size' => 10,
    '#maxlength' => 10,
    '#default_value' => $this
      ->getSetting('animation'),
    '#description' => t('The speed of the scroll animation as string in jQuery terms ("slow"  or "fast") or milliseconds as integer (See <a href="http://api.jquery.com/animate/">jQuery Documentation</a>).'),
  );
  $element['advanced']['easing'] = array(
    '#type' => 'textfield',
    '#title' => t('Easing effect'),
    '#size' => 10,
    '#maxlength' => 128,
    '#default_value' => $this
      ->getSetting('easing'),
    '#description' => t('The name of the easing effect that you want to use such as "swing" (the default) or "linear". See list of options in the <a href="http://api.jquery.com/animate/">jQuery Documentation</a>.'),
  );
  $element['advanced']['start'] = array(
    '#type' => 'select',
    '#title' => t('Start position'),
    '#description' => t('The item that will be shown as the first item in the list upon loading. Useful for starting a list in the middle of a set. A negative value allows choosing an item in the end, e.g. -1 is the last item.'),
    '#options' => $range,
    '#default_value' => $this
      ->getSetting('start'),
  );
  $element['advanced']['autoPause'] = array(
    '#type' => 'checkbox',
    '#title' => t('Pause auto-scroll on hover'),
    '#description' => t('If auto-scrolling, pause the carousel when the user hovers the mouse over an item.'),
    '#default_value' => $this
      ->getSetting('autoPause'),
  );
  $element['advanced']['vertical'] = array(
    '#type' => 'checkbox',
    '#title' => t('Vertical'),
    '#description' => t('Specifies wether the carousel appears in horizontal or vertical orientation. Changes the carousel from a left/right style to a up/down style carousel. Defaults to horizontal.'),
    '#default_value' => $this
      ->getSetting('vertical'),
  );
  $link_types = array(
    'content' => t('Content'),
    'file' => t('File'),
  );
  $element['image_link'] = array(
    '#title' => t('Link image to'),
    '#type' => 'select',
    '#default_value' => $this
      ->getSetting('image_link'),
    '#empty_option' => t('Nothing'),
    '#options' => $link_types,
  );
  return $element;
}