Interacturar con las Vistas

Las vistas XML permite controlar los objetos de la pantalla de manera simple. Vamos a ver algunos ejemplos de como acceder y variar la configuración desde nuestro controlador de una columna y de su widget. Primero recordar dos conceptos, que los controladores extendidos son contenedores de vistas ($this->views) y que el proceso de carga se realiza según el patrón:

• Añadir vista: Carga la configuración de la vista para el usuario activo.
• Cargar datos: Se realiza la lectura de los datos del modelo de la vista.
• Pintado de la vista: Mediante plantilla de twig se compone y visualiza la vista al usuario.

Hay dos procesos donde estan cargados los datos de configuración de la vista pudiendo alterarlos antes de que el usuario reciba la vista.

Seleccionar columnas

Una vez cargada la vista, para poder modificar la configuración de una columna y/o de su widget primero debemos acceder o seleccionar la columna. Para esto la vista tiene dos métodos donde obtenemos un objeto de la clase ColumnItem:

• columnForField: Devuelve la columna que tiene el fieldname igual al indicado.
• columnForName: Devuelve la columna que tiene por 'name' el indicado.

// Establece el tamaño de la columna en 6 y amplia el nivel de seguridad a 50
$column1 = $this->views['Nombre_de_Vista']->columnForField('Nombre_del_campo');
$column1->numColumns = 6;
$column1->level = 50;

// Establece una longitud máxima de los datos a 50 caracteres
$column2 = $this->views['Nombre_de_Vista']->columnForName('Nombre_de_la_columna');
$column2->widget->maxLenght = 50;

Apagar y encender columnas

Aunque podemos activar y desactivar columnas mediante la propiedad readOnly del widget de la columna (es decir, seleccionamos la columna y accedemos a la propiedad del widget), existe un método más directo desde la vista. Para ello usaremos el método disableColumn informando del name de la columna en el archivo xml y de si deseamos que esté o no en disabled.

// Disable mediante Widget (NO RECOMENDADO)
$column = $this->views['Nombre_de_Vista']->columnForField('Nombre_del_campo');
$column->widget->readonly = 'true';

// Disable mediante Vista (RECOMENDADO)
$this->views['Nombre_de_Vista']->disableColumn('Nombre_de_la_columna', true);

Seleccionar filtros en ListController

Para controladores que heredan de ListController es posible personalizar o alterar los filtros añadidos a una vista. Debemos seleccionar la vista y luego seleccionar el filtro consultando la propiedad filters que contiene un array con cada uno de los filtros definidos (un array de BaseFilter). Para seleccionar el filtro utilizaremos el nombre que indicamos como key al añadirlo a la vista.

// Ejemplo de carga manual de valores en filtros de tipo select
$companyFilter = $this->views['ListEmployee']->filters['company'];
$companyFilter->options['values'] = $this->codeModel->all('empresas', 'idempresa', 'nombre');

$departmentsFilter = $this->views['ListEmployee']->filters['company'];
$departmentsFilter->options['values'] = $this->codeModel->all('departments', 'id', 'name');

// Ejemplo de captura del valor del filtro
$companyFilter = $this->views['ListEmployee']->filters['company'];
if ($companyFilter->value !== '') {
    [ ... nuestras instrucciones php ... ]
}

Añadir botones de acción

También puede añadir un botón de acción simplemente usando el método addButton(). Por ejemplo este botón que redirige al controlador EditProducto.

$this->addButton('ListProducto', [
        'action' => 'EditProducto',
        'icon' => 'fas fa-plus',
        'label' => 'new',
        'type' => 'link'
]);

Tiene más detalles sobre los botones en la sección de row actions.