OpenEstate-PHP-Export 2.0.0-SNAPSHOT API
\
Gettext
Extractors
Generators
Languages
Exporter
Utils
OpenEstate
PhpExport
Action
Filter
Html
Order
Provider
Session
Theme
View
PHPMailer
PHPMailer
TrueBV
Exception

\OpenEstate\PhpExport\HtmlCheckbox

A HTML element for checkboxes.

Summary

Methods
Properties
Constants
__construct()
__destruct()
isBody()
isHeader()
generate()
newBox()
$name
$onChange
$onFocus
$onBlur
$id
$class
$title
$label
$value
$autofocus
$checked
$defaultChecked
$disabled
No constants found
getAttributes()
generateAttributes()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$name

$name : string

Name of the input field.

Type

string

$onChange

$onChange : string

Executed Javascript, if the value was changed.

Type

string

$onFocus

$onFocus : string

Executed Javascript, if the input element gains the focus.

Type

string

$onBlur

$onBlur : string

Executed Javascript, if the input element loses the focus.

Type

string

$id

$id : string

Specifies a unique id for an element.

Type

string

$class

$class : string

Specifies one or more class names for an element (refers to a class in a style sheet).

Type

string

$title

$title : string

Specifies extra information about an element.

Type

string

$label

$label : string

Label, that is shown together with the checkbox.

Type

string

$value

$value : string

Value of the form field.

Type

string

$autofocus

$autofocus : boolean

Enable autofocus for the form field.

Type

boolean

$checked

$checked : boolean

Set checkbox checked.

Type

boolean

$defaultChecked

$defaultChecked : boolean

Set checkbox checked by default.

Type

boolean

$disabled

$disabled : boolean

Set form field disabled.

Type

boolean

Methods

__construct()

__construct(string  $name, string|null  $id = null, string|null  $class = null, string|null  $title = null, string|null  $value = '1', boolean|null  $checked = false, string|null  $label = null)

Checkbox constructor.

Parameters

string $name

name of the input field
string|null $id

id attribute
string|null $class

class attribute
string|null $title

title attribute
string|null $value

value of the input field
boolean|null $checked

set checkbox checked
string|null $label

label, that is shown together with the checkbox

__destruct()

__destruct()

AbstractHtmlElement destructor.

isBody()

isBody() : boolean

Determine, if the element is placed within the HTML body.

Returns

boolean —

true, if it is a HTML body element

isHeader()

isHeader() : boolean

Determine, if the element is placed within the HTML header.

Returns

boolean —

true, if it is a HTML header element

generate()

generate()

newBox()

newBox(string  $name, string  $id, string  $class, string  $value, boolean|null  $checked = false, string|null  $label = null, string|null  $title = null) : \OpenEstate\PhpExport\Html\Checkbox

Create a checkbox.

Parameters

string $name

name of the input field
string $id

id attribute
string $class

class attribute
string $value

value of the form field
boolean|null $checked

set checkbox checked
string|null $label

label, that is shown together with the checkbox
string|null $title

title attribute

Returns

\OpenEstate\PhpExport\Html\Checkbox —

created checkbox element

getAttributes()

getAttributes()

generateAttributes()

generateAttributes() : string

Generate attributes of the HTML element.

Returns

string —

generated attributes in HTML syntax