HeadlineWidget
extends AbstractWidget
in package
Class HeadlineWidget
Table of Contents
- $fieldsets : array<string|int, FieldSet>
- $font : FontGroupOption
- $headingType : DropdownSelectOption
- $id : TextBox
- ID
- $jsonObject : stdClass
- $static_id : string
- $text : TextBox
- __construct() : mixed
- AbstractWidget constructor.
- createFromJsonObject() : ContentGeneratorInterface
- htmlContent() : string
- produces the widget HTML output
- jsonSerialize() : mixed
- Specify data which should be serialized to JSON
- persist() : void
- previewContent() : string
- update() : void
- createOptionsArray() : array<string|int, mixed>
- list all the options of a widget as $option->
- createWidgetObject() : static
- htmlTemplate() : string
- initializePropertiesFromFieldset() : void
- validateJsonObject() : bool
- Used to provide specific validation criteria for passed object before creation
Properties
$fieldsets
protected
array<string|int, FieldSet>
$fieldsets
= []
$font
protected
FontGroupOption
$font
$headingType
protected
DropdownSelectOption
$headingType
$id
ID
protected
TextBox
$id
$jsonObject
protected
stdClass
$jsonObject
$static_id
protected
string
$static_id
$text
protected
TextBox
$text
Methods
__construct()
AbstractWidget constructor.
public
__construct(string $static_id, array<string|int, FieldSet> $fieldsets, stdClass $jsonObject) : mixed
Parameters
- $static_id : string
- $fieldsets : array<string|int, FieldSet>
- $jsonObject : stdClass
Tags
Return values
mixed —createFromJsonObject()
public
static createFromJsonObject(stdClass $jsonObject) : ContentGeneratorInterface
Parameters
- $jsonObject : stdClass
Tags
Return values
ContentGeneratorInterface —htmlContent()
produces the widget HTML output
public
htmlContent(Language|null $currentLanguage[, CssGenerator|null $cssGenerator = null ]) : string
Parameters
- $currentLanguage : Language|null
- $cssGenerator : CssGenerator|null = null
Return values
string —jsonSerialize()
Specify data which should be serialized to JSON
public
jsonSerialize() : mixed
Tags
Return values
mixed —data which can be serialized by json_encode, which is a value of any type other than a resource.
persist()
public
persist() : void
Return values
void —previewContent()
public
previewContent(Language|null $currentLanguage) : string
Parameters
- $currentLanguage : Language|null
Return values
string —update()
public
update() : void
Return values
void —createOptionsArray()
list all the options of a widget as $option->
protected
static createOptionsArray(stdClass $widget) : array<string|int, mixed>
Parameters
- $widget : stdClass
Return values
array<string|int, mixed> —createWidgetObject()
protected
static createWidgetObject(stdClass $jsonObject[, array<string|int, mixed> $fieldSets = [] ]) : static
Parameters
- $jsonObject : stdClass
- $fieldSets : array<string|int, mixed> = []
Tags
Return values
static —htmlTemplate()
protected
htmlTemplate() : string
Return values
string —initializePropertiesFromFieldset()
protected
initializePropertiesFromFieldset() : void
Tags
Return values
void —validateJsonObject()
Used to provide specific validation criteria for passed object before creation
protected
static validateJsonObject(stdClass $jsonObject) : bool
Parameters
- $jsonObject : stdClass