A widget for the sidebar.
- Author
- Jan-Hendrik Willms tleil.nosp@m.ax+s.nosp@m.tudip.nosp@m.@gma.nosp@m.il.co.nosp@m.m GPL 2 or later
- Since
- 3.1
- See also
- Sidebar
◆ __construct()
◆ getExtra()
◆ getId()
Returns the ID of this widget, if it is set.
- Returns
- string The ID of the widget or an empty string, if it is not set.
◆ getTitle()
Returns the title of the widget
- Returns
- string The title of the widget of false if no title has been set
◆ removeAdditionalAttribute()
removeAdditionalAttribute |
( |
string |
$key | ) |
|
◆ removeExtra()
◆ removeTitle()
Removes the title of the widget.
◆ render()
render |
( |
|
$variables = [] | ) |
|
Renders the widget. The widget will only be rendered if it contains at least one element.
- Returns
- string The THML code of the rendered sidebar widget
◆ setAdditionalAttribute()
setAdditionalAttribute |
( |
string |
$key, |
|
|
|
$value |
|
) |
| |
◆ setAdditionalAttributes()
setAdditionalAttributes |
( |
array |
$attributes | ) |
|
◆ setExtra()
◆ setId()
Sets the ID of the HTML element that represents the widget.
- Parameters
-
string | $id | The element-ID to be used for the widget. |
◆ setTitle()
Sets the title of the widget.
- Parameters
-
string | $title | The title of the widget |
◆ $additional_attributes
$additional_attributes = [] |
|
protected |
The documentation for this class was generated from the following file: