class DrupalSlider in Drupal Slider 8

Same name and namespace in other branches

8.2 src/Plugin/views/style/DrupalSlider.php \Drupal\drupal_slider\Plugin\views\style\DrupalSlider

Views_style_plugins for drupal_slider.

Plugin annotation


@ViewsStyle(
  id = "drupal_slider",
  title = @Translation("Drupal Slider"),
  help = @Translation("Displays a view as a Slider, using the Drupal Slider + Slider Pro jQuery plugin."),
  theme = "drupal_slider_views_style",
  theme_file = "drupal_slider_views.theme.inc",
  display_types = {"normal"}
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, TrustedCallbackInterface, ViewsPluginInterface
    class \Drupal\views\Plugin\views\style\StylePluginBase
    class \Drupal\drupal_slider\Plugin\views\style\DrupalSlider

Expanded class hierarchy of DrupalSlider

File

src/Plugin/views/style/DrupalSlider.php, line 20

Namespace

Drupal\drupal_slider\Plugin\views\style

View source

class DrupalSlider extends StylePluginBase {

  /**
   * {@inheritdoc}
   */
  protected $usesRowPlugin = TRUE;

  /**
   * {@inheritdoc}
   */
  protected $usesRowClass = FALSE;

  /**
   * {@inheritdoc}
   */
  protected $usesGrouping = FALSE;

  /**
   * {@inheritdoc}
   */
  protected $usesFields = TRUE;

  /**
   * Function defineOptions.
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['general'] = [
      'contains' => [],
    ];
    $options['general']['contains']['width'] = [
      'default' => 950,
    ];
    $options['general']['contains']['height'] = [
      'default' => 300,
    ];
    $options['general']['contains']['arrows'] = [
      'default' => 1,
    ];
    $options['general']['contains']['buttons'] = [
      'default' => 1,
    ];
    $options['general']['contains']['autoplay'] = [
      'default' => 1,
    ];
    $options['general']['contains']['autoplayDelay'] = [
      'default' => 5000,
    ];
    $options['general']['contains']['shuffle'] = [
      'default' => 0,
    ];
    $options['general']['contains']['fade'] = [
      'default' => 0,
    ];
    $options['general']['contains']['carousel'] = [
      'default' => 0,
    ];
    $options['general']['contains']['full_screen'] = [
      'default' => 0,
    ];
    $options['general']['contains']['loop'] = [
      'default' => 1,
    ];
    $options['general']['contains']['orientation'] = [
      'default' => 0,
    ];
    $options['general']['contains']['thumbnails_position'] = [
      'default' => 'bottom',
    ];
    return $options;
  }

  /**
   * Function buildOptionsForm.
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $fields = $this
      ->getAvailableFields();
    if (empty($fields)) {
      drupal_set_message($this
        ->t('To configure Drupal Slider you have to add at least one field'), 'error');
      return $form;
    }
    $form['general'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('General Settings'),
      '#open' => TRUE,
    ];
    $form['general']['width'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Width'),
      '#description' => $this
        ->t('The width of the slider. Eg 200px or 50%.'),
      '#default_value' => $this->options['general']['width'],
    ];
    $form['general']['height'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Height'),
      '#default_value' => $this->options['general']['height'],
      '#description' => $this
        ->t('The height of the slider. Eg 200px. Dont use %.'),
    ];
    $form['general']['arrows'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Arrows'),
      '#default_value' => $this->options['general']['arrows'],
      '#description' => $this
        ->t('Navigation arrows on slides.'),
    ];
    $form['general']['buttons'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Buttons'),
      '#default_value' => $this->options['general']['buttons'],
      '#description' => $this
        ->t('Shows current slide position'),
    ];
    $form['general']['autoplay'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Autoplay'),
      '#default_value' => $this->options['general']['autoplay'],
      '#description' => $this
        ->t('Autoplay the slides.'),
    ];
    $form['general']['autoplayDelay'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Autoplay delay'),
      '#default_value' => $this->options['general']['autoplayDelay'],
      '#description' => $this
        ->t('Sets the delay/interval (in milliseconds) at which the autoplay will run.'),
    ];
    $form['general']['shuffle'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Shuffle the slides'),
      '#default_value' => $this->options['general']['shuffle'],
      '#description' => $this
        ->t('Shuffles the slides.'),
    ];
    $form['general']['fade'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Fade effect'),
      '#default_value' => $this->options['general']['fade'],
      '#description' => $this
        ->t('Fade effect on transition.'),
    ];
    $form['general']['carousel'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show carousel instead of slider'),
      '#default_value' => $this->options['general']['carousel'],
      '#description' => $this
        ->t('By checking this it will turn into carousel. The image width should be less than window size.'),
    ];
    $form['general']['full_screen'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Full screen'),
      '#default_value' => $this->options['general']['full_screen'],
      '#description' => $this
        ->t('Add full screen button to the slider'),
    ];
    $form['general']['loop'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Loops slides'),
      '#default_value' => $this->options['general']['full_screen'],
      '#description' => $this
        ->t('slider will repeat the slides.'),
    ];
    $form['general']['orientation'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Vertical orientation'),
      '#default_value' => $this->options['general']['orientation'],
      '#description' => $this
        ->t('Indicates whether the slides will be arranged horizontally or vertically.'),
    ];
    $form['general']['thumbnails_position'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Thumbnails Position'),
      '#options' => [
        'bottom' => 'Bottom',
        'top' => 'Top',
        'left' => 'Left',
        'right' => 'Right',
      ],
      '#default_value' => $this->options['general']['thumbnails_position'],
    ];
  }

  /**
   * Returns option list of fields available on view.
   */
  protected function getAvailableFields() {
    $view = $this->view;
    return $view->display_handler
      ->getFieldLabels();
  }

}

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
DrupalSlider::$usesFields	protected	property	Does the style plugin for itself support to add fields to its output. Overrides StylePluginBase::$usesFields
DrupalSlider::$usesGrouping	protected	property	Does the style plugin support grouping of rows. Overrides StylePluginBase::$usesGrouping
DrupalSlider::$usesRowClass	protected	property	Does the style plugin support custom css class for the rows. Overrides StylePluginBase::$usesRowClass
DrupalSlider::$usesRowPlugin	protected	property	Whether or not this style uses a row plugin. Overrides StylePluginBase::$usesRowPlugin
DrupalSlider::buildOptionsForm	public	function	Function buildOptionsForm. Overrides StylePluginBase::buildOptionsForm
DrupalSlider::defineOptions	protected	function	Function defineOptions. Overrides StylePluginBase::defineOptions
DrupalSlider::getAvailableFields	protected	function	Returns option list of fields available on view.
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::$definition	public	property	Plugins's definition
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$renderer	protected	property	Stores the render API renderer.	3
PluginBase::$view	public	property	The top object of a view.	1
PluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	14
PluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	62
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::doFilterByDefinedOptions	protected	function	Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions	public	function	Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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::getProvider	public	function	Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer	protected	function	Returns the render API renderer.	1
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY		constant	Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED		constant	Include negotiated languages when listing languages.
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::listLanguages	protected	function	Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle	public	function	Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup	public static	function	Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData	public static	function	Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions	public static	function	Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults	protected	function	Fills up the options of the plugin with defaults.
PluginBase::submitOptionsForm	public	function	Handle any special handling on the validate form. Overrides ViewsPluginInterface::submitOptionsForm	16
PluginBase::summaryTitle	public	function	Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle	6
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions	1
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions	public	function	Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions	8
PluginBase::viewsTokenReplace	protected	function	Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.	1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT		constant	Query string to indicate the site default language.
PluginBase::__construct	public	function	Constructs a PluginBase object. Overrides PluginBase::__construct
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.
StylePluginBase::$defaultFieldLabels	protected	property	Should field labels be enabled by default.	1
StylePluginBase::$groupingTheme	protected	property	The theme function used to render the grouping set.
StylePluginBase::$rendered_fields	protected	property	Stores the rendered field values, keyed by the row index and field name.
StylePluginBase::$rowTokens	protected	property	Store all available tokens row rows.
StylePluginBase::$usesOptions	protected	property	Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions
StylePluginBase::buildSort	public	function	Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query.	1
StylePluginBase::buildSortPost	public	function	Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view.	1
StylePluginBase::defaultFieldLabels	public	function	Return TRUE if this style enables field labels by default.	1
StylePluginBase::destroy	public	function	Clears a plugin. Overrides PluginBase::destroy
StylePluginBase::elementPreRenderRow	public	function	#pre_render callback for view row field rendering.
StylePluginBase::evenEmpty	public	function	Should the output of the style plugin be rendered even if it's a empty view.	2
StylePluginBase::getField	public	function	Gets a rendered field.
StylePluginBase::getFieldValue	public	function	Get the raw field value.
StylePluginBase::getRowClass	public	function	Return the token replaced row class for the specified row.
StylePluginBase::init	public	function	Overrides \Drupal\views\Plugin\views\PluginBase::init(). Overrides PluginBase::init
StylePluginBase::preRender	public	function	Allow the style to do stuff before each row is rendered.
StylePluginBase::query	public	function	Add anything to the query that we might need to. Overrides PluginBase::query	1
StylePluginBase::render	public	function	Render the display in this style.	7
StylePluginBase::renderFields	protected	function	Renders all of the fields for a given style and store them on the object.
StylePluginBase::renderGrouping	public	function	Group records as needed for rendering.
StylePluginBase::renderGroupingSets	public	function	Render the grouping sets.
StylePluginBase::renderRowGroup	protected	function	Renders a group of rows of the grouped view.
StylePluginBase::tokenizeValue	public	function	Take a value and apply token replacement logic to it.
StylePluginBase::trustedCallbacks	public static	function	Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
StylePluginBase::usesFields	public	function	Return TRUE if this style also uses fields.	3
StylePluginBase::usesGrouping	public	function	Returns the usesGrouping property.	3
StylePluginBase::usesRowClass	public	function	Returns the usesRowClass property.	3
StylePluginBase::usesRowPlugin	public	function	Returns the usesRowPlugin property.	10
StylePluginBase::usesTokens	public	function	Return TRUE if this style uses tokens.
StylePluginBase::validate	public	function	Validate that the plugin is correct and can be saved. Overrides PluginBase::validate
StylePluginBase::validateOptionsForm	public	function	Validate the options form. Overrides PluginBase::validateOptionsForm
StylePluginBase::wizardForm	public	function	Provide a form in the views wizard if this style is selected.
StylePluginBase::wizardSubmit	public	function	Alter the options of a display before they are added to the view.	1
TrustedCallbackInterface::THROW_EXCEPTION		constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION		constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING		constant	Untrusted callbacks trigger E_USER_WARNING errors.

You are here

class DrupalSlider in Drupal Slider 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation