SettingsWidget
extends CWidget
in package
Table of Contents
Properties
- $action : mixed
- $additionalHtml : string
- $buttons : array<string|int, mixed>
- $controlWidth : mixed
- $fieldHtmlOptions : mixed
- $form : bool
- Set to false to render elements in an existing form.
- $formHtmlOptions : mixed
- $labelWidth : mixed
- $method : mixed
- $prefix : mixed
- $settings : mixed
- $title : mixed
- $counter : mixed
Methods
- beginForm() : mixed
- endForm() : void
- fixMetaData() : mixed
- Fix metaData for a setting : set default etc.
- htmlOptions() : mixed
- init() : mixed
- renderBoolean() : string
- Render Boolean.
- renderCheckbox() : mixed
- renderDate() : mixed
- Date type
- renderEmail() : mixed
- renderFloat() : mixed
- renderHelp() : string
- render help/desscription according to type and $metaData['help']
- renderHtml() : mixed
- renderInfo() : mixed
- renderInt() : string
- renderJson() : mixed
- renderLabel() : mixed
- render label according to type and $metaData['label']
- renderLink() : mixed
- renderList() : mixed
- renderLogo() : mixed
- renderPassword() : mixed
- renderRadio() : mixed
- renderRelevance() : mixed
- renderSelect() : mixed
- renderSetting() : string|void
- renderString() : string
- renderText() : mixed
- run() : mixed
- renderAdditionalHtml() : void
- Echo save/close buttons.
- renderButton() : string
- Render a button
- renderButtons() : mixed
- renderSettings() : void
Properties
$action
public
mixed
$action
$additionalHtml
public
string
$additionalHtml
= ""
- Raw HTML to output last
$buttons
public
array<string|int, mixed>
$buttons
= array()
Buttons for the form.
$controlWidth
public
mixed
$controlWidth
= 6
$fieldHtmlOptions
public
mixed
$fieldHtmlOptions
= array()
$form
Set to false to render elements in an existing form.
public
bool
$form
= \true
$formHtmlOptions
public
mixed
$formHtmlOptions
= array()
$labelWidth
public
mixed
$labelWidth
= 6
$method
public
mixed
$method
= 'post'
$prefix
public
mixed
$prefix
$settings
public
mixed
$settings
= array()
$title
public
mixed
$title
$counter
protected
static mixed
$counter
= 0
Methods
beginForm()
public
beginForm() : mixed
endForm()
public
endForm() : void
fixMetaData()
Fix metaData for a setting : set default etc.
public
fixMetaData(mixed $name, mixed $metaData) : mixed
Parameters
- $name : mixed
- $metaData : mixed
htmlOptions()
public
htmlOptions(array<string|int, mixed> $metaData[, mixed $form = null ][, array<string|int, mixed> $aDefault = array() ][, array<string|int, mixed> $aForced = array() ]) : mixed
Parameters
- $metaData : array<string|int, mixed>
- $form : mixed = null
- $aDefault : array<string|int, mixed> = array()
- $aForced : array<string|int, mixed> = array()
init()
public
init() : mixed
renderBoolean()
Render Boolean.
public
renderBoolean(string $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : string
Parameters
- $name : string
- $metaData : array<string|int, mixed>
- $form : mixed = null
Tags
Return values
stringrenderCheckbox()
public
renderCheckbox(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : mixed
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
renderDate()
Date type
public
renderDate(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : mixed
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
renderEmail()
public
renderEmail(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : mixed
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
renderFloat()
public
renderFloat(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : mixed
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
renderHelp()
render help/desscription according to type and $metaData['help']
public
renderHelp(mixed $name, mixed $metaData) : string
Parameters
- $name : mixed
- $metaData : mixed
Tags
Return values
stringrenderHtml()
public
renderHtml(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : mixed
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
renderInfo()
public
renderInfo(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : mixed
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
Tags
renderInt()
public
renderInt(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : string
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
Return values
stringrenderJson()
public
renderJson(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : mixed
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
renderLabel()
render label according to type and $metaData['label']
public
renderLabel(mixed $name, mixed $metaData) : mixed
Parameters
- $name : mixed
- $metaData : mixed
renderLink()
public
renderLink(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : mixed
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
renderList()
public
renderList(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : mixed
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
Tags
renderLogo()
public
renderLogo(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : mixed
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
Tags
renderPassword()
public
renderPassword(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : mixed
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
renderRadio()
public
renderRadio(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : mixed
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
renderRelevance()
public
renderRelevance(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : mixed
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
renderSelect()
public
renderSelect(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : mixed
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
renderSetting()
public
renderSetting(string $name, array<string|int, mixed> $metaData[, array<string|int, mixed> $form = null ][, bool $return = false ][, string $wrapper = 'div' ]) : string|void
Parameters
- $name : string
- $metaData : array<string|int, mixed>
- $form : array<string|int, mixed> = null
- $return : bool = false
- $wrapper : string = 'div'
Tags
Return values
string|voidrenderString()
public
renderString(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : string
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
Return values
stringrenderText()
public
renderText(mixed $name, array<string|int, mixed> $metaData[, mixed $form = null ]) : mixed
Parameters
- $name : mixed
- $metaData : array<string|int, mixed>
- $form : mixed = null
run()
public
run() : mixed
renderAdditionalHtml()
Echo save/close buttons.
protected
renderAdditionalHtml() : void
renderButton()
Render a button
protected
renderButton(string $label, string|array<string|int, mixed> $metaData) : string
Parameters
- $label : string
- $metaData : string|array<string|int, mixed>
Return values
stringrenderButtons()
protected
renderButtons() : mixed
renderSettings()
protected
renderSettings() : void