phpDocumentor

AbstractWidget
in package
implements ContentGeneratorInterface, PersistableContentInterface, UpdatableContentZoneContentInterface

Class AbstractWidget

Interfaces, Classes and Traits

ContentGeneratorInterface
Interface ContentGeneratorInterface
PersistableContentInterface
Class PersistableContentInterface
UpdatableContentZoneContentInterface
Class UpdatableContentZoneContentInterface

Table of Contents

$fieldsets  : array<string|int, FieldSet>
$id  : TextBox
ID
$jsonObject  : stdClass
$static_id  : string
__construct()  : mixed
AbstractWidget constructor.
createFromJsonObject()  : ContentGeneratorInterface
htmlContent()  : string
persist()  : void
previewContent()  : string
update()  : void
createOptionsArray()  : array<string|int, mixed>
list all the options of a widget as $option->
createWidgetObject()  : static
initializePropertiesFromFieldset()  : void
validateJsonObject()  : bool
Used to provide specific validation criteria for passed object before creation

Properties

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
throws
Exception
Return values
mixed

htmlContent()

public abstract htmlContent(Language|null $currentLanguage) : string
Parameters
$currentLanguage : Language|null
Return values
string

previewContent()

public previewContent(Language|null $currentLanguage) : string
Parameters
$currentLanguage : Language|null
Return values
string

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
throws
Exception
Return values
static

initializePropertiesFromFieldset()

protected initializePropertiesFromFieldset() : void
Tags
throws
Exception
Return values
void

validateJsonObject()

Used to provide specific validation criteria for passed object before creation

protected static validateJsonObject(stdClass $jsonObject) : bool
Parameters
$jsonObject : stdClass
Tags
throws
Exception
Return values
bool

Search results