PopupWizardLinkOptions
in package
Table of Contents
Properties
- $attributes : array<string|int, mixed>
- *@var array Additional Link attributes as key value pairs. Will override title and style option. href is not allowed and will be removed from list.
- $icon : string
- $linkText : string
- $popupTitle : string
- $route : string
- $style : string
- $title : string
- $urlOnly : bool
- $width : int
Methods
- __construct() : mixed
- setAttributes() : PopupWizardLinkOptions
- Set additional link attributes as key value pairs. Will override title and style option. href and onclick are not allowed and will be removed from list.
- setIcon() : PopupWizardLinkOptions
- Add an additional attribute to the link.
- setLinkText() : PopupWizardLinkOptions
- Override the default link text. Will be displayed after the link icon.
- setPopupTitle() : PopupWizardLinkOptions
- Set the title of the popup.
- setRoute() : PopupWizardLinkOptions
- Set the route to generate the link.
- setStyle() : PopupWizardLinkOptions
- Override the default css style properties.
- setTitle() : PopupWizardLinkOptions
- Set the title of the link.
- setUrlOnly() : PopupWizardLinkOptions
- If only the url should be returned instead of a complete link element.
- setWidth() : PopupWizardLinkOptions
- Set the width of the popup.
Properties
$attributes
*@var array Additional Link attributes as key value pairs. Will override title and style option. href is not allowed and will be removed from list.
public
array<string|int, mixed>
$attributes
= []
$icon
public
string
$icon
= 'alias.svg'
Link icon to show as link text. Overrides default icon.
$linkText
public
string
$linkText
= ''
A linkTitle to show as link text. Will be displayed after the link icon. Default empty.
$popupTitle
public
string
$popupTitle
= ''
The title of the popup
$route
public
string
$route
= 'contao_backend'
The route to generate the link
$style
public
string
$style
= 'display: inline-block;'
Override the default css style properties
$title
public
string
$title
= ''
The title of the link
$urlOnly
public
bool
$urlOnly
= false
If only the url should be returned instead of a complete link element
$width
public
int
$width
= 991
The width of the popup
Methods
__construct()
public
__construct() : mixed
setAttributes()
Set additional link attributes as key value pairs. Will override title and style option. href and onclick are not allowed and will be removed from list.
public
setAttributes(array<string|int, mixed> $attributes) : PopupWizardLinkOptions
Parameters
- $attributes : array<string|int, mixed>
Return values
PopupWizardLinkOptionssetIcon()
Add an additional attribute to the link.
public
setIcon(string $icon) : PopupWizardLinkOptions
Parameters
- $icon : string
Return values
PopupWizardLinkOptionssetLinkText()
Override the default link text. Will be displayed after the link icon.
public
setLinkText(string $linkText) : PopupWizardLinkOptions
Parameters
- $linkText : string
Return values
PopupWizardLinkOptionssetPopupTitle()
Set the title of the popup.
public
setPopupTitle(string $string) : PopupWizardLinkOptions
Parameters
- $string : string
Return values
PopupWizardLinkOptionssetRoute()
Set the route to generate the link.
public
setRoute(string $route) : PopupWizardLinkOptions
Parameters
- $route : string
Return values
PopupWizardLinkOptionssetStyle()
Override the default css style properties.
public
setStyle(string $style) : PopupWizardLinkOptions
Parameters
- $style : string
Return values
PopupWizardLinkOptionssetTitle()
Set the title of the link.
public
setTitle(string $title) : PopupWizardLinkOptions
Parameters
- $title : string
Return values
PopupWizardLinkOptionssetUrlOnly()
If only the url should be returned instead of a complete link element.
public
setUrlOnly(bool $urlOnly) : PopupWizardLinkOptions
Parameters
- $urlOnly : bool
Return values
PopupWizardLinkOptionssetWidth()
Set the width of the popup.
public
setWidth(int $width) : PopupWizardLinkOptions
Parameters
- $width : int