ListController

Este es un controlador específico para listados. Permite una o varias pestañas. Cada una con un listado de los registros de un modelo. Además hace uso de archivos de XMLView para definir qué columnas mostrar y cómo.

Ejemplo: ListProject.php

Siguiendo con el ejemplo de MyNewProject, vamos a crear un listado con los proyectos.

<?php
namespace FacturaScripts\Plugins\MyNewPlugin\Controller;

use FacturaScripts\Core\Lib\ExtendedController\ListController;

class ListProject extends ListController
{
    public function getPageData(): array
    {
        $page = parent::getPageData();
        $page['title'] = 'projects';
        $page['menu'] = 'sales';
        $page['icon'] = 'fas fa-search';
        return $page;
    }

    protected function createViews()
    {
        // creamos cada pestaña en una función separada, por comodidad
        $this->createViewsProject();
    }

    protected function createViewsProject(string $viewName = 'ListProject'): void
    {
        $this->addView($viewName, 'Project')
            ->addOrderBy(['name'], 'name')
            ->addSearchFields(['name']);
    }
}

createViews()

En esta función debemos crear todas las pestañas (con addView()) y definir sus campos de búsqueda, filtros y ordenación.

addView()

Añade una nueva pestaña para listar los registros de un modelo. Sus parámetros son:

• viewName: el nombre identificador de la pestaña, y que debe coincidir con el del archivo de XMLView.
• modelName: el nombre del modelo que utiliza.
• viewTitle: el título de la pestaña, que será traducido.
• icon: el icono a usar en la pestaña.

Columnas a mostrar

Este controlador buscará un archivo XMLView con el mismo nombre que la pestaña (viewName). Este archivo es el que indica qué columnas mostrar y cómo.

addColor()

Puede añadir colores a las filas de los listados desde el controlador, para saber más visite "Añadir colores desde el controlador".

Desde ListController

$this->addColor($viewName, $value, $status->idestado, $color, $title);

La función addColor() tiene los siguientes parámetros:

• $fieldName: Nombre del campo donde hacer la comprobación, igual a fieldname del xml.
• $value: Valor a comprobar, el fieldName se comprobará con este valor.
• $color: El color a mostrar en la fila.
• $title: Será el texto a mostrar en la leyenda de los colores.

addSearchFields()

Para indicar sobre qué campos queremos que busque el buscador integrado de la pestaña.

• viewName: el nombre identificador de la pestaña.
• fields: un array con las columnas sobre las que se quiera buscar.

$this->addSearchFields($viewName, ['name', 'description']);

// opción alternativa
$this->listView($viewName)->addSearchFields(['name', 'description']);

addOrderBy()

Para añadir opciones de ordenación en la pestaña.

• viewName: nombre identificador de la pestaña.
• fields: campos de ordenación de esta opción (cualquier expresión aceptada por la cláusula ORDER BY de SQL).
• label: etiqueta o título de esta opción de ordenación. Si no se indica label, se usará el nombre del primer campo (fields).
• default: un entero entre 0 y 2.

Consideraciones:

• Al añadir una ordenación siempre se añaden dos opciones de ordenación, una ascendente y otra descendente.
• Para establecer una ordenación por defecto, al añadir la ordenación podemos indicar como valores 1 para la ascendente y 2 para la descendente.

Ejemplos de ordenación:

/* Epigrafes */
$this->addOrderBy('ListEpigrafe', ['descripcion'], 'description')
    ->addOrderBy(['CONCAT(codepigrafe, codejercicio)'], 'code', 2)
    ->addOrderBy(['codejercicio']);

/* Clientes */
$this->addOrderBy('ListCliente', ['codcliente'], 'code')
    ->addOrderBy(['nombre'], 'name', 1)
    ->addOrderBy(['fecha'], 'date')
    ->addOrderBy(['codgrupo', 'codcliente'], 'group');

/* Grupos */
$this->addOrderBy('ListGrupoClientes', ['codgrupo'], 'code')
    ->addOrderBy(['nombre'], 'name', 1);

Personalización con Settings

Todas las vistas usadas en los controladores extendidos disponen de la propiedad settings que nos permite personalizar ciertos aspectos de la vista. Use el método setSettings() para modificar estas configuraciones.

Añadir filtros al listado:

El controlador ListController integra un sistema de filtrado de datos que permite personalizar de manera sencilla las opciones de filtrado que se presentan al usuario. Cada tipo de filtro requiere de una parametrización propia para su funcionamiento como el nombre de la vista a la que lo añadimos, el campo sobre el que aplicar el filtro, la etiqueta, etc...