LDAP Account Manager

htmlButton extends htmlElement
in package

Simple button.

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
$isImageButton  : mixed
image button or text button
$name  : mixed
button name
$tableCellCssClasses  : mixed
table cell CSS classes
$value  : mixed
button text or image
$accessibilityLabel  : string|null
accessibility label
$dataAttributes  : mixed
data attributes
$isEnabled  : mixed
enabled or disabled
$noFormValidation  : mixed
disable form validation
$onClick  : mixed
onclick event
$title  : mixed
title
$type  : mixed
button type (default: "submit" if no onClick and "button" with onClick)
__construct()  : mixed
Constructor.
addDataAttribute()  : mixed
Adds a data attribute.
disableFormValidation()  : void
Disables form validation (e.g. for cancel buttons).
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.
setIsEnabled()  : mixed
Specifies if this component is enabled and accepts user modification.
setOnClick()  : mixed
Sets the onclick event code.
setTableCellCSSClasses()  : mixed
Adds CSS classes to the surrounding table cell for this element.
setTitle()  : mixed
Sets the button title (tooltip).
setType()  : mixed
Allows to override the default button type ("submit" if no onClick and "button" with onClick).
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 = []

$isImageButton

image button or text button

protected mixed $isImageButton

$name

button name

protected mixed $name

$tableCellCssClasses

table cell CSS classes

protected mixed $tableCellCssClasses = []

$value

button text or image

protected mixed $value

$accessibilityLabel

accessibility label

private string|null $accessibilityLabel = \null

$dataAttributes

data attributes

private mixed $dataAttributes = []

$isEnabled

enabled or disabled

private mixed $isEnabled = \true

$noFormValidation

disable form validation

private mixed $noFormValidation = \false

$onClick

onclick event

private mixed $onClick

$title

title

private mixed $title

$type

button type (default: "submit" if no onClick and "button" with onClick)

private mixed $type

Methods

__construct()

Constructor.

public __construct(string $name, string $value[, string $isImageButton = false ]) : mixed
Parameters
$name : string

button name

$value : string

button text or image (16x16px, relative to graphics folder)

$isImageButton : string = false

image or text button (default text)

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

disableFormValidation()

Disables form validation (e.g. for cancel buttons).

public disableFormValidation() : void
Return values
void

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

setIsEnabled()

Specifies if this component is enabled and accepts user modification.

public setIsEnabled(bool $isEnabled) : mixed
Parameters
$isEnabled : bool

enabled if true

Return values
mixed

setOnClick()

Sets the onclick event code.

public setOnClick(string $onClick) : mixed

This makes this button a simple button that does not submit a form.

Parameters
$onClick : string

JS 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

setTitle()

Sets the button title (tooltip).

public setTitle(string $title) : mixed
Parameters
$title : string

title

Return values
mixed

setType()

Allows to override the default button type ("submit" if no onClick and "button" with onClick).

public setType(mixed $type) : mixed
Parameters
$type : mixed
Return values
mixed

getDataAttributesAsString()

Returns the data attributes as rendered string.

protected getDataAttributesAsString() : string
Return values
string

data attributes

Search results