You are here

Home » API reference » jCarousel 8.5 » jcarousel.php

class jcarousel in jCarousel 8.5

Same name and namespace in other branches
  1. 8.4 src/Plugin/views/style/jcarousel.php \Drupal\jcarousel\Plugin\views\style\jcarousel

Style plugin to render each item in a grid cell.

Plugin annotation


@ViewsStyle(
  id = "jcarousel",
  title = @Translation("jCarousel"),
  help = @Translation("Displays rows in a jCarousel."),
  theme = "views_view_jcarousel",
  display_types = {"normal"}
)

Hierarchy

Expanded class hierarchy of jcarousel

5 string references to 'jcarousel'
drush_jcarousel_lib_plugin in drush/jcarousel.drush.inc
Command to download the jCarousel plugin.
jcarousel::validateOptionsForm in src/Plugin/views/style/jcarousel.php
Validate the options form.
jcarousel_library_info_alter in ./jcarousel.module
Implements hook_library_info_alter().
jcarousel_requirements in ./jcarousel.install
Implements hook_requirements().
_jcarousel_generate_attributes in ./jcarousel.module
Helper to build attributes array for carousel items.

File

src/Plugin/views/style/jcarousel.php, line 28
Contains \Drupal\jcarousel\Plugin\views\style\jcarousel.

Namespace

Drupal\jcarousel\Plugin\views\style
View source 
class jcarousel extends StylePluginBase {

  /**
   * Does the style plugin allows to use style plugins.
   *
   * @var bool
   */
  protected $usesRowPlugin = TRUE;

  /**
   * jCarousel Skin Manager.
   *
   * @var \Drupal\jcarousel\jCarouselSkinsManager
   */
  protected $skinsManager;

  /**
   * Constructs a PluginBase object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\jcarousel\jCarouselSkinsManager $skins_manager
   *   Jcarousel Skin manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, jCarouselSkinsManager $skins_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->skinsManager = $skins_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('jcarousel.skins.manager'));
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['wrap'] = [
      'default' => NULL,
    ];
    $options['skin'] = [
      'default' => 'default',
    ];
    $options['visible'] = [
      'default' => NULL,
    ];
    $options['responsive'] = [
      'default' => 0,
    ];
    $options['scroll'] = [
      'default' => '',
    ];
    $options['auto'] = [
      'default' => 0,
    ];
    $options['autoPause'] = [
      'default' => '1',
    ];
    $options['animation'] = [
      'default' => '',
    ];
    $options['start'] = [
      'default' => '1',
    ];
    $options['easing'] = [
      'default' => NULL,
    ];
    $options['vertical'] = [
      'default' => FALSE,
    ];
    $options['navigation'] = [
      'default' => '',
    ];
    $options['swipe'] = [
      'default' => TRUE,
    ];
    $options['draggable'] = [
      'default' => TRUE,
    ];
    $options['method'] = [
      'default' => 'scroll',
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);

    // Build the list of skins as options.
    $skins = $this->skinsManager
      ->getDefinitions();
    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));
    $form['description'] = [
      '#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>',
    ];
    $form['wrap'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Wrap content'),
      '#default_value' => $this->options['wrap'],
      '#description' => $this
        ->t('Specifies whether to wrap at the first/last item (or both) and jump back to the start/end.'),
      '#options' => [
        0 => $this
          ->t('Disabled'),
        'circular' => $this
          ->t('Circular'),
        'both' => $this
          ->t('Both'),
        'last' => $this
          ->t('Last'),
        'first' => $this
          ->t('First'),
      ],
    ];
    $form['skin'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Skin'),
      '#default_value' => $this->options['skin'],
      '#options' => $skins,
      '#description' => $this
        ->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.'),
    ];
    $form['responsive'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Responsive (number of items)'),
      '#default_value' => $this->options['responsive'],
      '#description' => $this
        ->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>',
    ];
    $form['visible'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Number of visible items'),
      '#options' => $auto_range,
      '#default_value' => $this->options['visible'],
      '#description' => $this
        ->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>',
    ];
    $form['scroll'] = [
      '#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->options['scroll'],
    ];
    $form['auto'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Auto-scroll after'),
      '#size' => 4,
      '#maxlength' => 4,
      '#default_value' => $this->options['auto'],
      '#field_suffix' => ' ' . $this
        ->t('seconds'),
      '#description' => $this
        ->t('Specifies how many seconds to periodically auto-scroll the content. If set to 0 (default) then autoscrolling is turned off.'),
    ];
    $form['navigation'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Enable navigation'),
      '#options' => [
        '' => $this
          ->t('None'),
        'before' => $this
          ->t('Before'),
        'after' => $this
          ->t('After'),
      ],
      '#default_value' => $this->options['navigation'],
      '#description' => $this
        ->t('Enable a clickable navigation list to jump straight to a given page.'),
    ];
    $form['advanced'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Advanced'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
      '#parents' => [
        'style_options',
      ],
    ];
    $form['advanced']['animation'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Animation speed'),
      '#size' => 10,
      '#maxlength' => 10,
      '#default_value' => $this->options['animation'],
      '#description' => $this
        ->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>).'),
    ];
    $form['advanced']['easing'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Easing effect'),
      '#size' => 10,
      '#maxlength' => 128,
      '#default_value' => $this->options['easing'],
      '#description' => $this
        ->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>.'),
    ];
    $form['advanced']['start'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Start position'),
      '#description' => $this
        ->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->options['start'],
    ];
    $form['advanced']['autoPause'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Pause auto-scroll on hover'),
      '#description' => $this
        ->t('If auto-scrolling, pause the carousel when the user hovers the mouse over an item.'),
      '#default_value' => $this->options['autoPause'],
    ];
    $form['advanced']['vertical'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Vertical'),
      '#description' => $this
        ->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->options['vertical'],
    ];
    $form['advanced']['swipe'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable jcarouselSwipe plugin'),
      '#description' => $this
        ->t('Adds support user-friendly swipe gestures.'),
      '#default_value' => $this->options['swipe'],
    ];
    $form['advanced']['draggable'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('On/off dragging items on swipe'),
      '#default_value' => $this->options['draggable'],
    ];
    $form['advanced']['method'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Swipe method'),
      '#options' => [
        'scroll' => $this
          ->t('Scroll'),
        'scrollIntoView' => $this
          ->t('ScrollIntoView'),
      ],
      '#default_value' => $this->options['method'],
      '#description' => $this
        ->t('What method should used to switch slides.'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function validateOptionsForm(&$form, FormStateInterface $form_state) {
    $errors = parent::validateOptionsForm($form, $form_state);
    $display = $this->view
      ->getDisplay();
    $pager = $display
      ->getPlugin('pager');
    if ($pager
      ->usePager() && !in_array($pager
      ->getPluginId(), [
      'none',
      'jcarousel',
    ])) {
    }
  }

  /**
   * {@inheritdoc}
   */
  public function preRender($result) {
    parent::preRender($result);
    $skin = !empty($this->options['skin']) ? $this->options['skin'] : 'default';
    $this->view->element['#attached']['library'][] = 'jcarousel/jcarousel';
    $this->view->element['#attached']['library'][] = 'jcarousel/jcarousel.swipe';
    $this->view->element['#attached']['library'][] = 'jcarousel/drupal.jcarousel';
    $this->view->element['#attached']['library'][] = 'jcarousel/skin.' . $skin;
  }

}

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
jcarousel::$skinsManager protected property jCarousel Skin Manager.
jcarousel::$usesRowPlugin protected property Does the style plugin allows to use style plugins. Overrides StylePluginBase::$usesRowPlugin
jcarousel::buildOptionsForm public function Provide a form to edit options for this plugin. Overrides StylePluginBase::buildOptionsForm
jcarousel::create public static function Creates an instance of the plugin. Overrides PluginBase::create
jcarousel::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides StylePluginBase::defineOptions
jcarousel::preRender public function Allow the style to do stuff before each row is rendered. Overrides StylePluginBase::preRender
jcarousel::validateOptionsForm public function Validate the options form. Overrides StylePluginBase::validateOptionsForm
jcarousel::__construct public function Constructs a PluginBase object. Overrides PluginBase::__construct
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::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.
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::$usesFields protected property Does the style plugin for itself support to add fields to its output. 3
StylePluginBase::$usesGrouping protected property Does the style plugin support grouping of rows. 3
StylePluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions
StylePluginBase::$usesRowClass protected property Does the style plugin support custom css class for the rows. 3
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::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::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.