RssWidget implements WidgetInterface, RequestAwareWidgetInterface

Concrete RSS widget implementation

The widget will show a certain number of items of the given RSS feed. The feed will be set by the feedUrl option. You can add a button to the widget by defining a button provider.

The following options are available during registration:

  • feedUrl string Defines the URL or file providing the RSS Feed. This is read by the widget in order to fetch entries to show.
  • limit int default: 5 Defines how many RSS items should be shown.
  • lifetime int default: 43200 Defines how long to wait, in seconds, until fetching RSS Feed again
Tags
see
ButtonProviderInterface

Table of Contents

Interfaces

WidgetInterface
The WidgetInterface is the base interface for all kind of widgets.
RequestAwareWidgetInterface
Interface for widgets that need the ServerRequestInterface Request.

Properties

$view  : StandaloneView|null

Methods

__construct()  : mixed
getOptions()  : array<string|int, mixed>
This method returns the options of the widget as set in the registration.
renderWidgetContent()  : string
This method returns the content of a widget. The returned markup will be delivered by an AJAX call and will not be escaped.
setRequest()  : void
getRssItems()  : array<string|int, mixed>

Properties

Methods

__construct()

public __construct(WidgetConfigurationInterface $configuration, FrontendInterface $cache, BackendViewFactory $backendViewFactory[, StandaloneView|null $view = null ][, ButtonProviderInterface|null $buttonProvider = null ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$configuration : WidgetConfigurationInterface
$cache : FrontendInterface
$backendViewFactory : BackendViewFactory
$view : StandaloneView|null = null
$buttonProvider : ButtonProviderInterface|null = null
$options : array<string|int, mixed> = []

getOptions()

This method returns the options of the widget as set in the registration.

public getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

renderWidgetContent()

This method returns the content of a widget. The returned markup will be delivered by an AJAX call and will not be escaped.

public renderWidgetContent() : string

Be aware of XSS and ensure that the content is well encoded.

Return values
string

setRequest()

public setRequest(ServerRequestInterface $request) : void
Parameters
$request : ServerRequestInterface

getRssItems()

protected getRssItems() : array<string|int, mixed>
Return values
array<string|int, mixed>

        
On this page

Search results