ShareWidget Class Reference

Inheritance diagram for ShareWidget:

Public Member Functions
	__construct ()
&	addCopyableLink ($label, $url, $icon=null, $attributes=[], $index=null)
Public Member Functions inherited from LinksWidget
	__construct ()
&	addLink ($label, $url, $icon=null, $attributes=[], $index=null)
	addLinkFromHTML ($html, Icon $icon=null)
Public Member Functions inherited from ListWidget
	__construct ()
	addCSSClass ($css_class)
	removeCSSClass ($css_class)
	addSeparator ($attributes=[])
	render ($variables=[])
Public Member Functions inherited from SidebarWidget
	__construct ()
	setId (string $id)
	getId ()
	setTitle ($title)
	getTitle ()
	removeTitle ()
	setExtra ($extra)
	getExtra ()
	removeExtra ()
	setAdditionalAttribute (string $key, $value)
	setAdditionalAttributes (array $attributes)
	removeAdditionalAttribute (string $key)
	render ($variables=[])
Public Member Functions inherited from Widget
	addElement (WidgetElement $element, $index=null)
	insertElement (WidgetElement $element, $before_index, $index=null)
	getElement ($index)
	getElements ()
	removeElement ($index)
	hasElements ()
	hasElement ($index)
	forceRendering ($state=true)
	addLayoutCSSClass ($css_class)
	removeLayoutCSSClass ($css_class)
	render ($variables=[])
	__isset ($offset)
	__get ($offset)
	__set ($offset, $value)
	__unset ($offset)

Data Fields
const	INDEX = 'actions'

Additional Inherited Members
Protected Member Functions inherited from Widget
	guessIndex (WidgetElement $element)
Protected Attributes inherited from ListWidget
	$css_classes = []
Protected Attributes inherited from SidebarWidget
	$additional_attributes = []
Protected Attributes inherited from Widget
	$elements = []
	$template = 'widgets/widget'
	$template_variables = []
	$layout = 'widgets/widget-layout'
	$forced_rendering = false
	$layout_css_classes = []

Detailed Description

Special widget for sharing links

This widget provides functionality to display links and copy the url to the user's clipboard when clicked.

Author

Jan-Hendrik Willms tleil.nosp@m.ax+s.nosp@m.tudip.nosp@m.@gma.nosp@m.il.co.nosp@m.m GPL2 or any later version

Constructor & Destructor Documentation

__construct()

__construct

(

)

Member Function Documentation

addCopyableLink()

& addCopyableLink	(		$label,
			$url,
			$icon = null,
			$attributes = [],
			$index = null
	)

Adds a copyable 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

Field Documentation

INDEX

const INDEX = 'actions'

---

The documentation for this class was generated from the following file:

• lib/classes/sidebar/ShareWidget.php