SilverCart\Model\Widgets\SubNavigationWidget
Provides a navigation of the current section and their children.
- Author: Sebastian Diel <sdiel@pixeltricks.de>
- Copyright: 2017 pixeltricks GmbH
- License: see license file in modules root directory
Synopsis
class SubNavigationWidget
extends Widget
{
- // members
- protected $pageHierarchy = NULL;
- protected SiteTree $startPage = NULL;
- protected SiteTree $levelsToShow = NULL;
- private static array $db = ;
- private static array $has_many = ;
- private static array $casting = ;
- private static string $table_name = 'SilvercartSubNavigationWidget';
- // 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 void __construct()
- public string getFrontTitle()
- public array fieldLabels()
- public array excludeFromScaffolding()
- public FieldList getCMSFields()
- public SiteTree getStartPage()
- public string getNavigation()
- public SiteTree findStartPage()
- public int getLevelsToShow()
- public DBHTMLText renderNavigation()
- public string NavigationCacheKey()
- // Inherited methods from Widget
- public array fieldLabels()
- public FieldList getCMSFields()
- public string getTitle()
- public bool DoUseWidgetContainer()
- public WidgetSet WidgetSet()
- public static void registerFilterPlugin()
Hierarchy
Extends
Members
private
- $casting
—
array
Casted attributes. - $db
—
array
Attributes. - $has_many
—
array
Has-many relationships. - $table_name
—
string
DB table name
protected
- $levelsToShow
—
SilverCart\Model\Widgets\SiteTree
Cache for $this->getLevelsToShow() - $pageHierarchy
—
array
Contains the page hierarchy. - $startPage
—
SilverCart\Model\Widgets\SiteTree
Cache for $this->getStartPage()
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
- __construct() — Load the page hierarchy.
- excludeFromScaffolding() — evade scaffolding performance friendly
- fieldLabels() — Field labels for display in tables.
- findStartPage() — Tries to find the start page by bubbling up from the current page and comparing the given startAtLevel with it's parents.
- getCMSFields() — Returns the input fields for this widget.
- getFrontTitle() — retirieves the attribute FreeText from related language class depending on the set locale
- getLevelsToShow() — Returns the number of levels to show.
- getStartPage() — Returns start page for the submenu hierarchy.
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.