Widget Datalist

El Widget Datalist, también conocido como WidgetList, es una especialización del WidgetSelect que permite mostrar valores relacionados con otras tablas (o con la misma) en función del texto introducido por el usuario. En lugar de mostrar la lista completa de valores, este widget presenta una lista de posibles valores que coinciden con el texto introducido.

Ejemplo Básico

Un ejemplo sencillo es un selector de ciudad en el menú Administrador > Empresas al elegir una empresa:

<column name="city" numcolumns="4" order="130">
    <widget type="datalist" fieldname="ciudad">
        <values source="ciudades" fieldcode="ciudad" fieldtitle="ciudad" limit="9000"/>
    </widget>
</column>

Ejemplo de Selectores Anidados

El datalist también es útil para crear selectores anidados. Por ejemplo, si se desea que las provincias se carguen después de seleccionar un país, el código del datalist sería:

<column name="province" numcolumns="4" order="140">
    <widget type="datalist" fieldname="provincia" parent="codpais">
        <values source="provincias" fieldcode="provincia" fieldtitle="provincia" fieldfilter="codpais"/>
    </widget>
</column>

En este ejemplo, usamos las propiedades parent y fieldfilter.

Propiedades del Widget

Las propiedades disponibles en la etiqueta del widget son:

fieldname: Nombre del campo que contiene la información. Obligatorio.
required: Impide guardar los datos del formulario si el usuario no ha escrito nada en el campo.
readonly: Impide modificar el valor.
onclick: URL o controlador al que será redirigido el usuario al hacer clic. Se añada ?code= y el valor del campo a esta URL.
icon: Icono a mostrar en el campo de edición.
translate: Establecer en true para traducir automáticamente los títulos de los valores a mostrar al usuario.
parent: Se indica el fieldname del widget si el datalist depende de otro widget datalist o select.
fieldfilter: Campo del datalist o select que se utiliza para filtrar la información del datalist actual.

Definición de la Clase

Consulta la lista completa de propiedades y métodos del widget select en la documentación de la clase WidgetDatalist.

Opciones de Coloreado

Recuerda que todos los widgets tienen una serie de propiedades y opciones comunes.

Valores a Mostrar

Podemos mostrar valores de una tabla concreta, valores fijos o incluso añadir valores manualmente desde el controlador.

Valores de una Tabla

<widget type="datalist" fieldname="codpais" required="true">
    <values source="paises" fieldcode="codpais" fieldtitle="nombre"/>
</widget>

source: Nombre de la tabla a consultar. También se puede usar el nombre de un modelo, por ejemplo, Proveedor.
fieldcode: Columna de la tabla para el valor seleccionado. Esta columna es opcional si en source se ha escrito el nombre de un modelo.
fieldtitle: Columna de la tabla para el texto a mostrar al usuario. Si no se indica, se usa fieldcode. Esta columna es opcional en el caso de modelos.
- Si se ha indicado translate en el widget, este texto se traducirá.

Valores Fijos

<widget type="datalist" fieldname="actualizastock" translate="true" required="true">
    <values title="book">-2</values>
    <values title="subtract">-1</values>
    <values title="do-nothing">0</values>
    <values title="add">1</values>
    <values title="foresee">2</values>
</widget>

Añadir Valores desde el Controlador

Para cargar una lista específica de valores en un widget datalist, se puede usar el método setValuesFromArray():

$column = $this->views[VIEW_NAME]->columnForName(NAME_DE_LA_COLUMNA_EN_EL_XMLVIEW);
if($column && $column->widget->getType() === 'datalist') {
    $customValues = [
        ['value' => '1', 'title' => 'UNO'],
        ['value' => '2', 'title' => 'DOS'],
        ['value' => '3', 'title' => 'TRES'],
        ['value' => '14', 'title' => 'CATORCE'],
    ];
    $column->widget->setValuesFromArray($customValues);

    // Para incluir un valor null, usa la siguiente línea:
    // $column->widget->setValuesFromArray($customValues, false, true);
}

Recuerda sustituir VIEW_NAME por el nombre de la vista/pestaña correspondiente, y NAME_DE_LA_COLUMNA_EN_EL_XMLVIEW por el name de la columna que contiene el widget en el archivo xmlview.

Con CodeModel

También es posible utilizar la clase CodeModel para obtener valores y cargarlos en el widget. Por ejemplo, para cargar una lista de clientes y sus números de teléfono, se usará el método setValuesFromCodeModel():

$column = $this->views[VIEW_NAME]->columnForName(NAME_DE_LA_COLUMNA_EN_EL_XMLVIEW);
if($column && $column->widget->getType() === 'datalist') {
    $customValues = $this->codeModel->all('clientes', 'codcliente', 'telefono1');
    $column->widget->setValuesFromCodeModel($customValues);
}

Anterior Siguiente

Pregunta al chatbot