SilverCart\Model\Widgets\Widget
Provides some basic functionality for all SilverCart widgets.
- Author: Sebastian Diel <sdiel@pixeltricks.de>
- Copyright: 2017 pixeltricks GmbH
- License: see license file in modules root directory
Synopsis
class Widget
extends WidgetSetWidget
{
- // members
- public bool $useWidgetContainer = true;
- public static bool $use_product_pages_for_slider = false;
- public static bool $use_anything_slider = false;
- public static array $registeredFilterPlugins = ;
- // methods
- public array fieldLabels()
- public FieldList getCMSFields()
- public string getTitle()
- public bool DoUseWidgetContainer()
- public WidgetSet WidgetSet()
- public static void registerFilterPlugin()
Hierarchy
Extends
- WidgetSets\Model\WidgetSetWidget
Members
public
- $registeredFilterPlugins
—
array
Contains a list of all registered filter plugins. - $useWidgetContainer
—
SilverCart\Model\Widgets\bool
Set whether to use the widget container divs or not. - $use_anything_slider
—
SilverCart\Model\Widgets\bool
Set this to false to disable anything slider. - $use_product_pages_for_slider
—
SilverCart\Model\Widgets\bool
Set this to false to use single elements for product slider
Methods
public
- DoUseWidgetContainer() — Indicate whether to use the widget container divs or not.
- WidgetSet() — Returns the related WidgetSet.
- fieldLabels() — Field labels for display in tables.
- getCMSFields() — Returns the input fields for this widget.
- getTitle() — Returns the title of this widget.
- registerFilterPlugin() — Registers an object as a filter plugin. Before getting the result set the method 'filter' is called on the plugin. It has to return an array with filters to deploy on the query.