class Owl in Multipurpose Corporate Profile 8

Style plugin to render each item into owl carousel.

Plugin annotation


@ViewsStyle(
  id = "owl",
  title = @Translation("Owl Carousel"),
  help = @Translation("Displays rows as Owl Carousel."),
  theme = "owl_views",
  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\owl\Plugin\views\style\Owl

Expanded class hierarchy of Owl

File

modules/contrib/owl/src/Plugin/views/style/Owl.php, line 25: Contains \Drupal\owl\Plugin\views\style\Owl.

Namespace

Drupal\owl\Plugin\views\style

View source

class Owl extends StylePluginBase {

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

  /**
   * Does the style plugin support custom css class for the rows.
   *
   * @var bool
   */
  protected $usesRowClass = TRUE;

  /**
   * Set default options
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $settings = _owl_default_settings();
    foreach ($settings as $k => $v) {
      $options[$k] = array(
        'default' => $v,
      );
    }
    return $options;
  }

  /**
   * Render the given style.
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['items'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Items'),
      '#description' => $this
        ->t('Maximum amount of items displayed at a time with the widest browser width.'),
      '#default_value' => $this->options['items'],
    );
    $form['itemsDesktop'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Items Desktop'),
      '#description' => $this
        ->t('This allows you to preset the number of slides visible with a particular browser width. The format is [x,y] whereby x=browser width and y=number of slides displayed. For example [1199,4] means that if(window<=1199){ show 4 slides per page}'),
      '#default_value' => $this->options['itemsDesktop'],
    );
    $form['itemsDesktopSmall'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Items Desktop Small'),
      '#description' => $this
        ->t('Example: [979,3]'),
      '#default_value' => $this->options['itemsDesktopSmall'],
    );
    $form['itemsTablet'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Items Tablet'),
      '#description' => $this
        ->t('Example: [768,2]'),
      '#default_value' => $this->options['itemsTablet'],
    );
    $form['itemsMobile'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Items Mobile'),
      '#description' => $this
        ->t('Example: [479,1]'),
      '#default_value' => $this->options['itemsMobile'],
    );
    $form['singleItem'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Single Item'),
      '#default_value' => $this->options['singleItem'],
      '#description' => $this
        ->t('Display only one item.'),
    );

    //itemsScaleUp
    $form['itemsScaleUp'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Items ScaleUp'),
      '#default_value' => $this->options['itemsScaleUp'],
      '#description' => $this
        ->t('Option to not stretch items when it is less than the supplied items.'),
    );

    //slideSpeed
    $form['slideSpeed'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Slide Speed'),
      '#default_value' => $this->options['slideSpeed'],
      '#description' => $this
        ->t('Slide speed in milliseconds.'),
    );

    //paginationSpeed
    $form['paginationSpeed'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Pagination Speed'),
      '#default_value' => $this->options['paginationSpeed'],
      '#description' => $this
        ->t('Pagination speed in milliseconds.'),
    );

    //rewindSpeed
    $form['rewindSpeed'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Rewind Speed'),
      '#default_value' => $this->options['rewindSpeed'],
      '#description' => $this
        ->t('Rewind speed in milliseconds.'),
    );

    //autoPlay
    $form['autoPlay'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('AutoPlay'),
      '#default_value' => $this->options['autoPlay'],
    );

    //stopOnHover
    $form['stopOnHover'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Stop On Hover'),
      '#default_value' => $this->options['stopOnHover'],
      '#description' => $this
        ->t('Stop autoplay on mouse hover.'),
    );

    //navigation
    $form['navigation'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Navigation'),
      '#default_value' => $this->options['navigation'],
      '#description' => $this
        ->t('Display "next" and "prev" buttons.'),
    );

    //prevText
    $form['prevText'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Prev Text'),
      '#default_value' => $this->options['prevText'],
      '#description' => $this
        ->t('Text for navigation prev button'),
    );

    //nextText
    $form['nextText'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Next Text'),
      '#default_value' => $this->options['nextText'],
      '#description' => $this
        ->t('Text for navigation next button'),
    );

    //rewindNav
    $form['rewindNav'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Rewind Nav'),
      '#default_value' => $this->options['rewindNav'],
      '#description' => $this
        ->t('Slide to first item.'),
    );

    //scrollPerPage
    $form['scrollPerPage'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Scroll Per Page'),
      '#default_value' => $this->options['scrollPerPage'],
      '#description' => $this
        ->t('Scroll per page not per item. This affect next/prev buttons and mouse/touch dragging.'),
    );

    //pagination
    $form['pagination'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('pagination'),
      '#default_value' => $this->options['pagination'],
      '#description' => $this
        ->t('Show pagination.'),
    );

    //paginationNumbers
    $form['paginationNumbers'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Pagination Numbers'),
      '#default_value' => $this->options['paginationNumbers'],
      '#description' => $this
        ->t('Show numbers inside pagination buttons.'),
    );

    //responsive
    $form['responsive'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Responsive'),
      '#default_value' => $this->options['responsive'],
      '#description' => $this
        ->t('Uncheck to use Owl Carousel on desktop-only.'),
    );

    //responsiveRefreshRate
    $form['responsiveRefreshRate'] = array(
      '#type' => 'number',
      '#title' => $this
        ->t('Responsive Refresh Rate'),
      '#default_value' => $this->options['responsiveRefreshRate'],
      '#description' => $this
        ->t('Check window width changes every 200ms for responsive actions.'),
    );

    //mouseDrag
    $form['mouseDrag'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Mouse Drag'),
      '#default_value' => $this->options['mouseDrag'],
      '#description' => $this
        ->t('Turn off/on mouse events.'),
    );

    //touchDrag
    $form['touchDrag'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Touch Drag'),
      '#default_value' => $this->options['touchDrag'],
      '#description' => $this
        ->t('Turn off/on touch events.'),
    );

    //transitionStyle
    $form['transitionStyle'] = array(
      '#type' => 'select',
      '#options' => array(
        'fade' => $this
          ->t('Fade'),
        'backSlide' => $this
          ->t('Back Slide'),
        'goDown' => $this
          ->t('Go Down'),
        'scaleUp' => $this
          ->t('ScaleUp'),
      ),
      '#title' => $this
        ->t('Transition Style'),
      '#default_value' => $this->options['transitionStyle'],
      '#description' => $this
        ->t('Add CSS3 transition style. Works only with one item on screen.'),
    );
  }

}

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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
Owl::$usesRowClass	protected	property	Does the style plugin support custom css class for the rows. Overrides StylePluginBase::$usesRowClass
Owl::$usesRowPlugin	protected	property	Does the style plugin allows to use style plugins. Overrides StylePluginBase::$usesRowPlugin
Owl::buildOptionsForm	public	function	Render the given style. Overrides StylePluginBase::buildOptionsForm
Owl::defineOptions	protected	function	Set default options Overrides StylePluginBase::defineOptions
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::$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::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 Owl in Multipurpose Corporate Profile 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation