FacturaScripts

WidgetRadio extends WidgetRadio
in package

Class created by Core/Internal/PluginsDeploy

Table of Contents

Properties

$autocomplete  : bool
$class  : string
$fieldclick  : string
$fieldname  : string
$icon  : string
$id  : string
Identifies the object with a defined name in the view
$name  : string
Name defined in the view as key
$onclick  : string
$options  : array<string|int, mixed>
$readonly  : string
$required  : bool
$tabindex  : int
$values  : array<string|int, mixed>
$codeModel  : CodeModel
$fieldcode  : string
$fieldtitle  : string
$images  : bool
$imagesPath  : string
$source  : string
$translate  : bool
$uniqueId  : int
$value  : mixed
$valueOnClick  : mixed

Methods

__construct()  : mixed
edit()  : string
getColorFromOption()  : string
Calculate color from option configuration
getDataSource()  : array<string|int, mixed>
Obtains the configuration of the datasource used in obtaining data
getImagePath()  : string
getLevel()  : int
getToken()  : string
getType()  : string
Devuelve el tipo de widget.
gridFormat()  : array<string|int, mixed>
inputHidden()  : string
plainText()  : string
processFormData()  : void
setCustomValue()  : mixed
Asigna un valor fijo personalizado al widget.
setLevel()  : mixed
setToken()  : mixed
setValuesFromArray()  : void
Loads the value list from a given array.
setValuesFromArrayKeys()  : void
setValuesFromCodeModel()  : void
Loads the value list from an array with value and title (description)
setValuesFromRange()  : void
showTableTotals()  : bool
tableCell()  : string
applyOperatorFromOption()  : bool
assets()  : void
Adds assets to the asset manager.
clearImagesPath()  : void
colorToClass()  : string
combineClasses()  : string
css()  : string
Returns equivalent css class to $class. To extend in plugins.
escapeHtml()  : string
Normaliza entidades HTML existentes y escapa el valor para insertarlo en contexto HTML.
getUniqueId()  : int
inputHtml()  : string
inputHtmlExtraParams()  : string
inputHtmlImages()  : string
loadOptions()  : void
onclickHtml()  : string
readonly()  : bool
setSourceData()  : void
Set datasource data and Load data from Model into values array.
setValue()  : mixed
show()  : string
tableCellClass()  : string

Properties

$autocomplete

public bool $autocomplete

Indica si el navegador puede autocompletar el campo.

$fieldclick

public string $fieldclick

Campo alternativo usado para generar enlaces.

$fieldname

public string $fieldname

Nombre del campo del modelo asociado al widget.

$icon

public string $icon

Clase CSS del icono mostrado junto al widget.

$id

Identifies the object with a defined name in the view

public string $id

$name

Name defined in the view as key

public string $name

$onclick

public string $onclick

Controlador o URL usado al hacer clic en el valor.

$options

public array<string|int, mixed> $options = []

Opciones configuradas para el widget.

$readonly

public string $readonly

Modo de solo lectura del widget.

$required

public bool $required

Indica si el campo es obligatorio.

$tabindex

public int $tabindex

Orden de tabulación del campo.

$values

public array<string|int, mixed> $values = []

$value

protected mixed $value

Valor actual del widget.

$valueOnClick

protected mixed $valueOnClick = null

Valor alternativo usado en el enlace del widget.

Methods

__construct()

public __construct(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

edit()

public edit(object $model[, string $title = '' ][, string $description = '' ][, string $titleurl = '' ]) : string
Parameters
$model : object

Modelo que contiene el valor del campo.

$title : string = ''

Clave de traducción del título.

$description : string = ''

Clave de traducción de la descripción.

$titleurl : string = ''

URL opcional para enlazar el título.

Return values
string —

HTML del widget en modo edición.

getColorFromOption()

Calculate color from option configuration

public getColorFromOption(array<string|int, string> $option, mixed $value, string $prefix) : string
Parameters
$option : array<string|int, string>
$value : mixed
$prefix : string
Return values
string

getDataSource()

Obtains the configuration of the datasource used in obtaining data

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

getImagePath()

public getImagePath() : string
Return values
string

getLevel()

public static getLevel() : int
Return values
int

getToken()

public static getToken() : string
Return values
string

getType()

Devuelve el tipo de widget.

public getType() : string
Return values
string —

Tipo del widget.

gridFormat()

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

Formato del widget para vistas en cuadrícula.

inputHidden()

public inputHidden(object $model) : string
Parameters
$model : object

Modelo que contiene el valor del campo.

Return values
string —

Campo oculto con el valor actual.

plainText()

public plainText(object $model) : string
Parameters
$model : object

Modelo que contiene el valor del campo.

Return values
string —

Representación en texto plano del valor.

processFormData()

public processFormData(object &$model, Request $request) : void
Parameters
$model : object
$request : Request

setCustomValue()

Asigna un valor fijo personalizado al widget.

public setCustomValue(mixed $value) : mixed
Parameters
$value : mixed

Valor personalizado.

setLevel()

public static setLevel(int $new) : mixed
Parameters
$new : int

setToken()

public static setToken(string $token) : mixed
Parameters
$token : string

setValuesFromArray()

Loads the value list from a given array.

public setValuesFromArray(array<string|int, mixed> $items[, bool $translate = false ][, bool $addEmpty = false ][, string $col1 = 'value' ][, string $col2 = 'title' ]) : void

The array must have one of the two following structures:

  • If it's a value array, it must use the value of each element as title and value
  • If it's a multidimensional array, the indexes value and title must be set for each element
Parameters
$items : array<string|int, mixed>
$translate : bool = false
$addEmpty : bool = false
$col1 : string = 'value'
$col2 : string = 'title'

setValuesFromArrayKeys()

public setValuesFromArrayKeys(array<string|int, mixed> $values[, bool $translate = false ][, bool $addEmpty = false ]) : void
Parameters
$values : array<string|int, mixed>
$translate : bool = false
$addEmpty : bool = false

setValuesFromCodeModel()

Loads the value list from an array with value and title (description)

public setValuesFromCodeModel(array<string|int, mixed> $rows[, bool $translate = false ]) : void
Parameters
$rows : array<string|int, mixed>
$translate : bool = false

setValuesFromRange()

public setValuesFromRange(int $start, int $end, float $step) : void
Parameters
$start : int
$end : int
$step : float

showTableTotals()

public showTableTotals() : bool
Return values
bool —

Indica si el widget muestra totales en tablas.

tableCell()

public tableCell(object $model[, string $display = 'left' ]) : string
Parameters
$model : object

Modelo que contiene el valor del campo.

$display : string = 'left'

Alineación del contenido.

Return values
string —

HTML de la celda de tabla.

applyOperatorFromOption()

protected applyOperatorFromOption(array<string|int, string> $option, mixed $value) : bool
Parameters
$option : array<string|int, string>
$value : mixed
Return values
bool

assets()

Adds assets to the asset manager.

protected assets() : void

clearImagesPath()

protected clearImagesPath() : void

colorToClass()

protected colorToClass(string $color, string $prefix) : string
Parameters
$color : string
$prefix : string
Return values
string

combineClasses()

protected combineClasses(array<string|int, mixed> ...$classes) : string
Parameters
$classes : array<string|int, mixed>
Return values
string

css()

Returns equivalent css class to $class. To extend in plugins.

protected css(string $class) : string
Parameters
$class : string
Return values
string

escapeHtml()

Normaliza entidades HTML existentes y escapa el valor para insertarlo en contexto HTML.

protected escapeHtml(mixed $value) : string
Parameters
$value : mixed

Valor a escapar.

Return values
string —

Valor escapado.

getUniqueId()

protected getUniqueId() : int
Return values
int

inputHtml()

protected inputHtml([string $type = 'radio' ][, string $extraClass = '' ]) : string
Parameters
$type : string = 'radio'
$extraClass : string = ''
Return values
string

inputHtmlExtraParams()

protected inputHtmlExtraParams() : string
Return values
string —

Parámetros HTML adicionales del input.

inputHtmlImages()

protected inputHtmlImages([mixed $type = 'radio' ][, mixed $extraClass = '' ]) : string
Parameters
$type : mixed = 'radio'
$extraClass : mixed = ''
Return values
string

loadOptions()

protected loadOptions(array<string|int, mixed> $children) : void
Parameters
$children : array<string|int, mixed>

Nodos hijos de configuración del widget.

onclickHtml()

protected onclickHtml(string $inside[, string $titleurl = '' ]) : string
Parameters
$inside : string

Contenido HTML del enlace.

$titleurl : string = ''

URL alternativa para el título.

Return values
string —

Contenido envuelto en enlace cuando corresponde.

readonly()

protected readonly() : bool
Return values
bool —

Indica si el widget está en modo solo lectura.

setSourceData()

Set datasource data and Load data from Model into values array.

protected setSourceData(array<string|int, mixed> $child[, bool $loadData = true ]) : void
Parameters
$child : array<string|int, mixed>
$loadData : bool = true

setValue()

protected setValue(object $model) : mixed
Parameters
$model : object

Modelo que contiene el valor del campo.

show()

protected show() : string
Return values
string

tableCellClass()

protected tableCellClass([string $initialClass = '' ][, string $alternativeClass = '' ]) : string
Parameters
$initialClass : string = ''

Clase CSS inicial.

$alternativeClass : string = ''

Clase CSS alternativa.

Return values
string —

Clases CSS de la celda.

On this page

Search results