Documentation

rex_form_checkbox_element extends rex_form_options_element
in package

Table of Contents

Properties

$attributes  : array<string, int|string>
$defaultSaveValue  : string|int|null
$fieldName  : string
$footer  : string
$header  : string
$label  : string
$labelOnTop  : bool
$notice  : string
$prefix  : string
$separateEnding  : bool
$suffix  : string
$table  : rex_form_base|null
$tag  : string
$validator  : rex_validator
$value  : string|int|null

Methods

__construct()  : mixed
addArrayOptions()  : void
addDBSqlOptions()  : void
addOption()  : void
addOptions()  : void
addSqlOptions()  : void
disableSpellcheckAndAutoCorrect()  : void
formatElement()  : string
get()  : string
getAttribute()  : int|string|T
getAttributes()  : array<string, int|string>
getFieldName()  : string
getFooter()  : string
getHeader()  : string
getLabel()  : string
getNotice()  : string
getOptions()  : array<string|int, mixed>
getPrefix()  : string
getSaveValue()  : string|int|null
getSuffix()  : string
getTag()  : string
getValidator()  : rex_validator
getValue()  : string|int|null
hasAttribute()  : bool
hasSeparateEnding()  : bool
isLabelOnTop()  : bool
isReadOnly()  : bool
setAttribute()  : void
setAttributes()  : void
setDefaultSaveValue()  : void
setFieldName()  : void
setFooter()  : void
setHeader()  : void
setLabel()  : void
setLabelOnTop()  : void
setNotice()  : void
setPrefix()  : void
setSuffix()  : void
setValue()  : void
show()  : void
_get()  : string
formatClass()  : string
formatLabel()  : mixed
formatNotice()  : string
getFragment()  : string
wrapContent()  : string

Properties

$attributes

protected array<string, int|string> $attributes

$defaultSaveValue

protected string|int|null $defaultSaveValue = ''

$fieldName

protected string $fieldName = ''

$labelOnTop

protected bool $labelOnTop

$separateEnding

protected bool $separateEnding

$value

protected string|int|null $value

Methods

__construct()

public __construct([string $tag = '' ][, rex_form_base|null $form = null ][, array<string, int|string> $attributes = [] ]) : mixed
Parameters
$tag : string = ''
$form : rex_form_base|null = null
$attributes : array<string, int|string> = []

addArrayOptions()

public addArrayOptions(array<string|int, string> $options[, bool $useKeys = true ]) : void
Parameters
$options : array<string|int, string>
$useKeys : bool = true

addDBSqlOptions()

public addDBSqlOptions(string $query) : void
Parameters
$query : string

addOption()

public addOption(string $name, string|int $value) : void
Parameters
$name : string
$value : string|int

addOptions()

public addOptions(array<string|int, string|array{0: string, 1?: string|int}> $options[, bool $useOnlyValues = false ]) : void
Parameters
$options : array<string|int, string|array{0: string, 1?: string|int}>
$useOnlyValues : bool = false

addSqlOptions()

public addSqlOptions(string $query) : void
Parameters
$query : string

disableSpellcheckAndAutoCorrect()

public disableSpellcheckAndAutoCorrect() : void

formatElement()

public formatElement() : string
Return values
string

get()

public get() : string
Return values
string

getAttribute()

public getAttribute(string $name[, T $default = null ]) : int|string|T
Parameters
$name : string
$default : T = null
Tags
template

T

Return values
int|string|T

getAttributes()

public getAttributes() : array<string, int|string>
Return values
array<string, int|string>

getFieldName()

public getFieldName() : string
Return values
string

getFooter()

public getFooter() : string
Return values
string

getHeader()

public getHeader() : string
Return values
string

getLabel()

public getLabel() : string
Return values
string

getNotice()

public getNotice() : string
Return values
string

getOptions()

public getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPrefix()

public getPrefix() : string
Return values
string

getSaveValue()

public getSaveValue() : string|int|null
Return values
string|int|null

getSuffix()

public getSuffix() : string
Return values
string

getTag()

public getTag() : string
Return values
string

getValue()

public getValue() : string|int|null
Return values
string|int|null

hasAttribute()

public hasAttribute(string $name) : bool
Parameters
$name : string
Return values
bool

hasSeparateEnding()

public hasSeparateEnding() : bool
Return values
bool

isLabelOnTop()

public isLabelOnTop() : bool
Return values
bool

isReadOnly()

public isReadOnly() : bool
Return values
bool

setAttribute()

public setAttribute(string $name, int|string $value) : void
Parameters
$name : string
$value : int|string

setAttributes()

public setAttributes(array<string, int|string> $attributes) : void
Parameters
$attributes : array<string, int|string>

setDefaultSaveValue()

public setDefaultSaveValue(string|int|null $value) : void
Parameters
$value : string|int|null

setFieldName()

public setFieldName(string $name) : void
Parameters
$name : string

setFooter()

public setFooter(string $footer) : void
Parameters
$footer : string

setHeader()

public setHeader(string $header) : void
Parameters
$header : string

setLabel()

public setLabel(string $label) : void
Parameters
$label : string

setLabelOnTop()

public setLabelOnTop([bool $onTop = true ]) : void
Parameters
$onTop : bool = true

setNotice()

public setNotice(string $notice) : void
Parameters
$notice : string

setPrefix()

public setPrefix(string $prefix) : void
Parameters
$prefix : string

setSuffix()

public setSuffix(string $suffix) : void
Parameters
$suffix : string

setValue()

public setValue(string|array<int, string>|int|null $value) : void
Parameters
$value : string|array<int, string>|int|null

_get()

protected _get() : string
Return values
string

formatClass()

protected formatClass() : string
Return values
string

formatLabel()

protected formatLabel() : mixed

formatNotice()

protected formatNotice() : string
Return values
string

getFragment()

protected getFragment() : string
Return values
string

wrapContent()

protected wrapContent(string $content) : string
Parameters
$content : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results