SilverCart\Model\Widgets\SearchCloudWidget
Provides a search tag cloud as a widget.
- Author: Sebastian Diel <sdiel@pixeltricks.de>
- Copyright: 2017 pixeltricks GmbH
- License: see license file in modules root directory
Synopsis
class SearchCloudWidget
extends Widget
{
- // members
- private static array $db = ;
- private static array $defaults = ;
- private static string $table_name = 'SilvercartSearchCloudWidget';
- // Inherited members from Widget
- public bool $useWidgetContainer;
- public static bool $use_product_pages_for_slider;
- public static bool $use_anything_slider;
- public static array $registeredFilterPlugins;
- // methods
- public array fieldLabels()
- public ArrayList getTagsForCloud()
- protected array getFontSizeRanges()
- // Inherited methods from Widget
- public array fieldLabels()
- public FieldList getCMSFields()
- public string getTitle()
- public bool DoUseWidgetContainer()
- public WidgetSet WidgetSet()
- public static void registerFilterPlugin()
- // Inherited methods from ExtensibleDataObject
- protected void beforeRequireDefaultRecords()
- protected void beforeUpdateCMSActions()
- protected void beforeUpdateFieldLabels()
- protected void beforeUpdateProvidePermissions()
- public array defaultFieldLabels()
- public static void reset_field_labels()
- protected array scaffoldFieldLabels()
Hierarchy
Members
private
- $db
—
array
attributes - $defaults
—
array
default values for attributes - $table_name
—
string
DB table name
protected
- $defaultFieldLabels
—
array
Default field labels.
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
protected
- getFontSizeRanges() — Returns the font size ranges to use in the tag cloud.
public
- fieldLabels() — Field labels for display in tables.
- getTagsForCloud() — Returns the most searched queries as a DataList
Inherited from SilverCart\Model\Widgets\Widget
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.
Inherited from SilverCart\ORM\ExtensibleDataObject
protected
- beforeRequireDefaultRecords() — Allows user code to hook into DataObject::requireDefaultRecords() prior to requireDefaultRecords being called on extensions.
- beforeUpdateCMSActions() — Allows user code to hook into DataObject::getCMSActions prior to updateCMSActions being called on extensions.
- beforeUpdateFieldLabels() — Allows user code to hook into DataObject::fieldLabels() prior to updateFieldLabels being called on extensions.
- beforeUpdateProvidePermissions() — Allows user code to hook into DataObject::updateProvidePermissions() prior to providePermissions being called on extensions.
- scaffoldFieldLabels() — Returns the default field labels for this DataObject.
public
- defaultFieldLabels() — Returns the default field labels.
- reset_field_labels() — Resets the field label cache.