You are here

public function WidgetPluginBase::isPropertyRequired in Facets 8

Checks is a specific property is required for this widget.

This works for base properties (show_only_one_result, only_visible_when_facet_source_is_visible) or one the processors.

Parameters

string $name: The name of the property. Something like 'hide_non_narrowing_result_processor' or 'show_only_one_result'.

string $type: The type of the property. Either 'processors' or 'settings'. Another value will not be picked up by the widgets.

Return value

bool True when the property is required, false by default.

Overrides WidgetPluginInterface::isPropertyRequired

2 methods override WidgetPluginBase::isPropertyRequired()
CustomWidget::isPropertyRequired in tests/facets_custom_widget/src/Plugin/facets/widget/CustomWidget.php
Checks is a specific property is required for this widget.
SliderWidget::isPropertyRequired in modules/facets_range_widget/src/Plugin/facets/widget/SliderWidget.php
Checks is a specific property is required for this widget.

File

src/Widget/WidgetPluginBase.php, line 258

Class

WidgetPluginBase
A base class for widgets that implements most of the boilerplate.

Namespace

Drupal\facets\Widget

Code

public function isPropertyRequired($name, $type) {
  return FALSE;
}