You are here

class SlickDefault in Slick Carousel 7.3

Same name and namespace in other branches
  1. 8.2 src/SlickDefault.php \Drupal\slick\SlickDefault
  2. 8 src/SlickDefault.php \Drupal\slick\SlickDefault

Defines shared plugin default settings for field formatter and Views style.

Hierarchy

Expanded class hierarchy of SlickDefault

See also

FormatterBase::defaultSettings()

StylePluginBase::defineOptions()

12 files declare their use of SlickDefault
slick.global.inc in includes/slick.global.inc
This file is not used by Slick 3.x.
slick.install in ./slick.install
Installation actions for Slick.
slick.theme.inc in templates/slick.theme.inc
Hooks and preprocess functions for the Slick module.
slick.update.inc in includes/slick.update.inc
Provides common update utility for Slick Fields and Slick Views 3.x.
SlickEntityFormatterBase.php in src/Plugin/Field/FieldFormatter/SlickEntityFormatterBase.php

... See full list

File

src/SlickDefault.php, line 14

Namespace

Drupal\slick
View source
class SlickDefault extends BlazyDefault {

  /**
   * Defines constant for the supported fields.
   */
  const FIELDS = [
    'file',
    'image',
    'field_collection',
    'paragraphs',
    'text',
  ];

  /**
   * {@inheritdoc}
   */
  public static function baseSettings() {
    return [
      'optionset' => 'default',
      'override' => FALSE,
      'overridables' => [],
      'skin' => '',
      'skin_arrows' => '',
      'skin_dots' => '',
    ] + parent::baseSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function gridSettings() {
    return [
      'preserve_keys' => FALSE,
      'visible_items' => 0,
    ] + parent::gridSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function imageSettings() {
    return [
      'layout' => '',
      'optionset_thumbnail' => '',
      'skin_thumbnail' => '',
      'thumbnail_caption' => '',
      'thumbnail_effect' => '',
      'thumbnail_position' => '',
    ] + self::baseSettings() + parent::imageSettings() + self::gridSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function extendedSettings() {
    return [
      'thumbnail' => '',
    ] + self::imageSettings() + parent::extendedSettings();
  }

  /**
   * Returns HTML or layout related settings to shut up notices.
   */
  public static function htmlSettings() {
    return [
      'display' => 'main',
      'grid' => 0,
      'id' => '',
      'lazy' => '',
      'namespace' => 'slick',
      'nav' => FALSE,
      'navpos' => FALSE,
      'thumbnail_uri' => '',
      'unslick' => FALSE,
      'vanilla' => FALSE,
      'vertical' => FALSE,
      'vertical_tn' => FALSE,
      'view_name' => '',
    ] + self::imageSettings();
  }

  /**
   * Defines JS options required by theme_slick(), used with optimized option.
   */
  public static function jsSettings() {
    return [
      'asNavFor' => '',
      'prevArrow' => 'Previous',
      'nextArrow' => 'Next',
      'downArrowTarget' => '',
      'downArrowOffset' => '',
      'lazyLoad' => 'ondemand',
      'rows' => 1,
      'slidesPerRow' => 1,
      'slide' => '',
      'slidesToShow' => 1,
      'vertical' => FALSE,
    ];
  }

  /**
   * Returns slick theme properties.
   */
  public static function themeProperties() {
    return [
      'attached',
      'attributes',
      'items',
      'options',
      'optionset',
      'settings',
    ];
  }

  /**
   * Returns default settings for typecasting.
   */
  public static function formSettings() {
    return [
      'module_css' => TRUE,
      'slick_css' => TRUE,
      'deprecated' => TRUE,
      'deprecated_formatter' => TRUE,
    ];
  }

  /**
   * Update deprecated settings prefixed with `slide_` to be without one.
   */
  public static function deprecatedSettings() {
    return [
      'caption',
      'class',
      'image',
      'layout',
      'overlay',
      'link',
      'thumbnail',
      'title',
    ];
  }

  /**
   * Dummy method to remove.
   *
   * @todo temp fix for Slick failing test missing Blazy class.
   *
   * @see https://dispatcher.drupalci.org/job/drupal_d7/121280/artifact/jenkins-drupal_d7-121280/artifacts/run_tests_d7/
   */
  public static function dummy() {
    return Blazy::PAGES;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlazyDefault::$breakpoints private static property The supported $breakpoints.
BlazyDefault::anywhereSettings public static function Returns settings provided by various UI.
BlazyDefault::baseImageSettings public static function Returns image-related field formatter and Views settings.
BlazyDefault::cherrySettings public static function Returns cherry-picked settings for field formatters and Views fields.
BlazyDefault::entitySettings public static function Returns sensible default options common for entities lacking of UI.
BlazyDefault::getConstantBreakpoints public static function Returns Blazy specific breakpoints.
BlazyDefault::itemSettings public static function Returns sensible default html settings to shutup notices when lacking.
BlazyDefault::lazySettings public static function Returns sensible default options common for Views lacking of UI.
BlazyDefault::PAGES constant Defines constant pages related to Blazy filter at D7.
BlazyDefault::TAGS constant Defines constant for the supported text tags.
BlazyDefault::TEXTS constant Defines constant for the supported text fields.
BlazyDefault::themeAttributes public static function Returns blazy theme attributes.
BlazyDefault::uiSettings public static function Returns shared global form settings which should be consumed at formatters.
BlazyDefault::viewsSettings public static function Returns Views specific settings.
SlickDefault::baseSettings public static function Returns basic plugin settings: text, image, file, entities with grids. Overrides BlazyDefault::baseSettings
SlickDefault::deprecatedSettings public static function Update deprecated settings prefixed with `slide_` to be without one.
SlickDefault::dummy public static function Dummy method to remove.
SlickDefault::extendedSettings public static function Returns fieldable entity formatter and Views settings. Overrides BlazyDefault::extendedSettings
SlickDefault::FIELDS constant Defines constant for the supported fields.
SlickDefault::formSettings public static function Returns default settings for typecasting. Overrides BlazyDefault::formSettings
SlickDefault::gridSettings public static function Returns optional grid field formatter and Views settings. Overrides BlazyDefault::gridSettings
SlickDefault::htmlSettings public static function Returns HTML or layout related settings to shut up notices. Overrides BlazyDefault::htmlSettings
SlickDefault::imageSettings public static function Returns image-related field formatter and Views settings. Overrides BlazyDefault::imageSettings
SlickDefault::jsSettings public static function Defines JS options required by theme_slick(), used with optimized option.
SlickDefault::themeProperties public static function Returns slick theme properties. Overrides BlazyDefault::themeProperties