htmlLink
extends htmlElement
in package
Generates a link.
The link can include an optional image in front of the link text.
Table of Contents
- ALIGN_BOTTOM = 3
- align to bottom
- ALIGN_CENTER = 4
- align to center
- ALIGN_LEFT = 1
- align to left
- ALIGN_RIGHT = 2
- align to right
- ALIGN_TOP = 0
- align to top
- $alignment : mixed
- alignment when inside a table
- $colspan : mixed
- colspan if inside a table
- $rowspan : mixed
- rowspan if inside a table
- $cssClasses : mixed
- CSS classes
- $tableCellCssClasses : mixed
- table cell CSS classes
- $target : mixed
- link target
- $accessibilityLabel : string|null
- accessibility label
- $dataAttributes : mixed
- data attributes
- $id : mixed
- link id
- $image : mixed
- optional image
- $onClick : mixed
- onClick event
- $onMouseOver : mixed
- onMouseOver event
- $targetWindow : mixed
- target window
- $text : mixed
- link text
- $title : mixed
- title
- __construct() : mixed
- Constructor.
- addDataAttribute() : mixed
- Adds a data attribute.
- generateHTML() : array<string|int, mixed>
- Prints the HTML code for this element.
- getAccessibilityMarkup() : string
- Returns the markup for the accessibility data.
- getAlignmentString() : string
- Returns the HTML attributes for the alignment.
- getColspanString() : string
- Returns the HTML attribute for the colspan.
- getCSSClasses() : array<string|int, mixed>
- Returns the CSS classes of this element.
- getRowspanString() : string
- Returns the HTML attribute for the rowspan.
- getTableCellCSSClasses() : array<string|int, mixed>
- Returns the CSS classes of the surrounding table cell for this element.
- setAccessibilityLabel() : void
- Sets the accessibility label.
- setCSSClasses() : mixed
- Adds CSS classes to this element.
- setId() : mixed
- Sets the element id.
- setOnClick() : mixed
- Sets the onClick event.
- setOnMouseOver() : mixed
- Sets the onMouseOver event.
- setTableCellCSSClasses() : mixed
- Adds CSS classes to the surrounding table cell for this element.
- setTargetWindow() : mixed
- Sets the target window (e.g. _blank).
- setTitle() : mixed
- Sets the link title.
- getAlt() : string
- Returns the value for the alt attribute.
- getContent() : string
- Returns the value for the link content.
- getDataAttributesAsString() : string
- Returns the data attributes as rendered string.
Constants
ALIGN_BOTTOM
align to bottom
public
mixed
ALIGN_BOTTOM
= 3
ALIGN_CENTER
align to center
public
mixed
ALIGN_CENTER
= 4
ALIGN_LEFT
align to left
public
mixed
ALIGN_LEFT
= 1
ALIGN_RIGHT
align to right
public
mixed
ALIGN_RIGHT
= 2
ALIGN_TOP
align to top
public
mixed
ALIGN_TOP
= 0
Properties
$alignment
alignment when inside a table
public
mixed
$alignment
$colspan
colspan if inside a table
public
mixed
$colspan
$rowspan
rowspan if inside a table
public
mixed
$rowspan
$cssClasses
CSS classes
protected
mixed
$cssClasses
= []
$tableCellCssClasses
table cell CSS classes
protected
mixed
$tableCellCssClasses
= []
$target
link target
protected
mixed
$target
$accessibilityLabel
accessibility label
private
string|null
$accessibilityLabel
= \null
$dataAttributes
data attributes
private
mixed
$dataAttributes
= []
$id
link id
private
mixed
$id
$image
optional image
private
mixed
$image
$onClick
onClick event
private
mixed
$onClick
$onMouseOver
onMouseOver event
private
mixed
$onMouseOver
$targetWindow
target window
private
mixed
$targetWindow
$text
link text
private
mixed
$text
$title
title
private
mixed
$title
Methods
__construct()
Constructor.
public
__construct(string $text, string $target[, string $image = null ]) : mixed
Parameters
- $text : string
-
label
- $target : string
-
target URL
- $image : string = null
-
URL of optional image
Return values
mixed —addDataAttribute()
Adds a data attribute.
public
addDataAttribute(string $key, string $value) : mixed
Parameters
- $key : string
-
attribute name (without "data-")
- $value : string
-
attribute value
Return values
mixed —generateHTML()
Prints the HTML code for this element.
public
generateHTML(string $module, array<string|int, mixed> $input, array<string|int, mixed> $values, bool $restricted, string $scope) : array<string|int, mixed>
Parameters
- $module : string
-
Name of account module
- $input : array<string|int, mixed>
-
List of meta-HTML elements
- $values : array<string|int, mixed>
-
List of values which override the defaults in $input (name => value)
- $restricted : bool
-
If true then no buttons will be displayed
- $scope : string
-
Account type
Return values
array<string|int, mixed> —List of input field names and their type (name => type)
getAccessibilityMarkup()
Returns the markup for the accessibility data.
public
getAccessibilityMarkup() : string
Return values
string —markup to be included in HTML tag (starting with space)
getAlignmentString()
Returns the HTML attributes for the alignment.
public
getAlignmentString() : string
Return values
string —alignment HTML attributes (e.g. align="right" valign="top")
getColspanString()
Returns the HTML attribute for the colspan.
public
getColspanString() : string
Return values
string —colspan HTML attribute (e.g. colspan=3)
getCSSClasses()
Returns the CSS classes of this element.
public
getCSSClasses() : array<string|int, mixed>
Return values
array<string|int, mixed> —$classes CSS class names
getRowspanString()
Returns the HTML attribute for the rowspan.
public
getRowspanString() : string
Return values
string —rowspan HTML attribute (e.g. rowspan=3)
getTableCellCSSClasses()
Returns the CSS classes of the surrounding table cell for this element.
public
getTableCellCSSClasses() : array<string|int, mixed>
Return values
array<string|int, mixed> —CSS classes
setAccessibilityLabel()
Sets the accessibility label.
public
setAccessibilityLabel(string|null $accessibilityLabel) : void
Parameters
- $accessibilityLabel : string|null
-
label
Return values
void —setCSSClasses()
Adds CSS classes to this element.
public
setCSSClasses(array<string|int, mixed> $classes) : mixed
Parameters
- $classes : array<string|int, mixed>
-
CSS class names
Return values
mixed —setId()
Sets the element id.
public
setId(string $id) : mixed
Parameters
- $id : string
-
unique id
Return values
mixed —setOnClick()
Sets the onClick event.
public
setOnClick(string $event) : mixed
Parameters
- $event : string
-
JavaScript code
Return values
mixed —setOnMouseOver()
Sets the onMouseOver event.
public
setOnMouseOver(string $event) : mixed
Parameters
- $event : string
-
JavaScript code
Return values
mixed —setTableCellCSSClasses()
Adds CSS classes to the surrounding table cell for this element.
public
setTableCellCSSClasses(array<string|int, mixed> $classes) : mixed
Parameters
- $classes : array<string|int, mixed>
-
CSS class names
Return values
mixed —setTargetWindow()
Sets the target window (e.g. _blank).
public
setTargetWindow(string $window) : mixed
Parameters
- $window : string
-
target window (e.g. _blank)
Return values
mixed —setTitle()
Sets the link title.
public
setTitle(string $title) : mixed
Parameters
- $title : string
-
title
Return values
mixed —getAlt()
Returns the value for the alt attribute.
protected
getAlt() : string
Return values
string —alt value
getContent()
Returns the value for the link content.
protected
getContent() : string
Return values
string —content
getDataAttributesAsString()
Returns the data attributes as rendered string.
protected
getDataAttributesAsString() : string
Return values
string —data attributes