Widget Datalist

El widget datalist, o WidgetList, es una especialización del WidgetSelect que permite mostrar valores relacionados con otras tablas (o con la misma) en base al texto introducido por el usuario. Así, el widget en vez de mostrar la lista completa de valores, muestra una lista de posibles valores que cumplen con el texto que ha introducido el usuario.

Un ejemplo muy sencillo es un selector de país.

<column name="country" numcolumns="2" order="150">
    <widget type="datalist" fieldname="codpais" required="true">
        <values source="paises" fieldcode="codpais" fieldtitle="nombre" />
    </widget>
</column>

Las propiedades disponibles en la etiqueta 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. A esta URL se le añade ?code= y el valor del campo.
• icon: icono a mostrar en el campo de edición.
• translate: true para indicar que se traduzcan automáticamentelos títulos de los valores a mostrar al usuario.

Definición de la clase

Puede ver 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 los valores de una tabla concreta, valores fijos o incluso podemos 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 podemos poner el nombre de un modelo, por ejemplo Proveedor.
• fieldcode: columna de la tabla para el valor seleccionado. Si en source se ha escrito el nombre de un modelo, esta columna es opcional.
• fieldtitle: columna de la tabla para el texto a mostrar al usuario.
  • Si no se indica fieldtitle, se usa fieldcode.
  • Si en source se ha escrito el nombre de un modelo, esta columna es opcional.
  • 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

Si necesitamos cargar una lista muy concreta de valores en un widget datalist, podemos 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);

    /// si entre los valores quieres que esté null, mejor ejecuta lo siguiente en vez de la línea anterior.
    /// (tendrás que eliminar la línea anterior y descomentar esta siguiente)
    /// $column->widget->setValuesFromArray($customValues, false, true);
}

Sustituir VIEW_NAME por el nombre de la vista/pestaña que sea, 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 podemos usar la clase CodeModel para obtener los valores y cargarlos en el widget. Por ejemplo, vamos a cargar una lista con los clientes y su número de teléfono, y entonces 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);
}