htmlImage
extends htmlElement
in package
Prints the HTML code for an image.
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
- $accessibilityLabel : string|null
- accessibility label
- $alt : mixed
- alt text
- $crop : mixed
- enable cropping
- $dataAttributes : mixed
- data attributes
- $height : mixed
- height
- $helpContent : htmlElement
- $helpTitle : string
- $lightbox : mixed
- enable lightbox
- $onClick : mixed
- onClick event
- $path : mixed
- path to image
- $title : mixed
- title
- $width : mixed
- width
- __construct() : mixed
- Constructor.
- addDataAttribute() : mixed
- Adds a data attribute.
- enableCropping() : mixed
- Enables cropping feature.
- enableLightbox() : mixed
- Enables lightbox feature.
- 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.
- setHelpData() : mixed
- Activates the help popup on hover.
- setOnClick() : void
- Sets the onClick event code.
- setTableCellCSSClasses() : mixed
- Adds CSS classes to the surrounding table cell for this element.
- 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
= []
$accessibilityLabel
accessibility label
private
string|null
$accessibilityLabel
= \null
$alt
alt text
private
mixed
$alt
$crop
enable cropping
private
mixed
$crop
= \false
$dataAttributes
data attributes
private
mixed
$dataAttributes
= []
$height
height
private
mixed
$height
$helpContent
private
htmlElement
$helpContent
help popup content
$helpTitle
private
string
$helpTitle
help popup title
$lightbox
enable lightbox
private
mixed
$lightbox
= \false
$onClick
onClick event
private
mixed
$onClick
$path
path to image
private
mixed
$path
$title
title
private
mixed
$title
$width
width
private
mixed
$width
Methods
__construct()
Constructor.
public
__construct(string $path[, int $width = null ][, int $height = null ][, string $alt = ' ' ][, mixed $title = null ][, string $onClick = null ]) : mixed
Parameters
- $path : string
-
image location
- $width : int = null
-
image width (optional, default original size)
- $height : int = null
-
image height (optional, default original size)
- $alt : string = ' '
-
alt text (optional)
- $title : mixed = null
- $onClick : string = null
-
onClick code (optional)
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 —enableCropping()
Enables cropping feature.
public
enableCropping() : mixed
This will display a cropping box on the image. The cropping data can be found in POST data (croppingDataX, croppingDataY, croppingDataWidth, croppingDataHeight).
Return values
mixed —enableLightbox()
Enables lightbox feature.
public
enableLightbox() : mixed
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 —setHelpData()
Activates the help popup on hover.
public
setHelpData(string $title, htmlElement $content) : mixed
Parameters
- $title : string
-
title
- $content : htmlElement
-
help content
Return values
mixed —setOnClick()
Sets the onClick event code.
public
setOnClick(string $code) : void
Parameters
- $code : string
-
JS code
Return values
void —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 —getDataAttributesAsString()
Returns the data attributes as rendered string.
protected
getDataAttributesAsString() : string
Return values
string —data attributes