This class is responsible for displaying new clipboards (the ones that use the Clipboard SORM class) in the sidebar.
- Author
- Moritz Strohm stroh.nosp@m.m@da.nosp@m.ta-qu.nosp@m.est..nosp@m.de GNU General Public License v2 or later.
- Since
- 4.5
__construct |
( |
|
$allowed_item_classes = [] | ) |
|
This widget can be initialised with the class names of allowed classes to limit the displayed items in a clipboard to items of specific classes.
& addLink |
( |
|
$label, |
|
|
|
$url, |
|
|
|
$icon = null , |
|
|
|
$attributes = array() , |
|
|
|
$index = null |
|
) |
| |
Adds a link to the widget
- Parameters
-
String | $label | Label/content of the link |
String | $url | URL/Location of the link |
Icon | $icon | instance of class Icon for the link |
bool | $active | Pass true if the link is currently active, defaults to false |
render |
( |
|
$variables = [] | ) |
|
setApplyButtonTitle |
( |
|
$title = '' | ) |
|
updateSessionVariables |
( |
| ) |
|
Updates session variables if a special POST request is made.
This attribute contains a string that shall be the title of the button for applying the selected clipbard to the main area the widget is showing when in read only mode.
clipboard_widget_id is required in the case that multiple clipboard widgets exist on one page. The JavaScript code can then distinguish each clipboard widget by its unique ID.
This attribute holds the ID of the clipboard which is stored in the session as currently selected clipboard.
The documentation for this class was generated from the following file: