SearchSuggestionBaseWidget

Namespace

Ceres\Widgets\Header\Search

Extends
Implements
Constants
Type Name Value Description

array

TOOLBAR_LAYOUT

['','bold,italic,underline,strike

h1,h2,h3

align

translation','bold,italic,underline,strike

headline

link

align,ul,ol

color,background

translation']

Properties
Type Name Description

string

$template

The template to be used for this widget

string

$widgetKey

The key of the widget

string

$widgetLabel

The label of the widget

string

$previewImageUrl

The url of the preview image

int

$position

The position of the widget

string

$suggestionType

The type of the suggestion widget

string

$headline

The headline of the suggestion widget

bool

$hasCountOption

Indicate if the suggestion widget has the option to show counts behind the suggestions

bool

$hasImagesOption

Indicate if the suggestion widget has the option to show images for the suggestions

bool

$hasAdditionalInformationOption

Indicate if the suggestion widget has the option to show additional information for the suggestions

Methods
public getData():array

Get basic information about the widget. Possible fields are - identifier - label - previewImageURL - type - categories - position

public getSettings():array

Return the structure of the settings for the widget

public getTemplateData($widgetSettings, $isPreview):array

Get additional data to be passed to the template while rendering.

Parameters

Type

Name

Description

array

$widgetSettings

The settings provided by the widget.

bool

$isPreview

A flag provided to determine if the widget is currently shown in preview.