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;

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

    protected function createViews()
    {
        $this->createViewsProject();
    }

    protected function createViewsProject(string $viewName = 'ListProject')
    {
        $this->addView($viewName, 'Project');
        $this->addOrderBy($viewName, ['name'], 'name');
        $this->addSearchFields($viewName, ['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('ListProject', ['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');
$this->addOrderBy('ListEpigrafe', ['CONCAT(codepigrafe, codejercicio)'], 'code', 2);
$this->addOrderBy('ListEpigrafe', ['codejercicio']);

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

/* Grupos */
$this->addOrderBy('ListGrupoClientes', ['codgrupo'], 'code');
$this->addOrderBy('ListGrupoClientes', ['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...


Siguiente

Necesita identificarse para continuar con esta acción. Haga clic en iniciar sesión o cree una cuenta.

Iniciar sesión
PRO
neorazorx_1
neorazorx_1

España, 10 años, nivel 100

PRO
daniel89fg_739
daniel89fg_739

España, 4 años, nivel 60

Controladores extendidos

Patrocinadores

FacturaScripts avanza más rápido gracias al apoyo financiero de los patrocinadores, que contribuyen a que podamos dedicar más tiempo al desarrollo, testeo y documentación. Usted también puede poner su granito de arena y convertirse en patrocinador ;-)

ORO
elurk_3992
ORO
manel_11440
ORO
contacta_2746
ORO
franciscmuniztv_17817
ORO
clinicastillo_1549
ORO
luis_18101
ORO
ccano_8323
ORO
mariano_6807
PLATA
compras_1706
PLATA
acaselles_13670
PLATA
angelgonzalez_1980
PLATA
v.delgado_14821
PLATA
bombelec_12337
PLATA
robertchio_499
PLATA
miguel_14380
PLATA
contacto_2906
PLATA
phtemprano_14326
BRONCE
rexmaris_12857
BRONCE
dante281_4400
BRONCE
braunny809_17749
BRONCE
info.bpsevilla_8888
PRO
neorazorx_1
PRO
jmoreno_2610
PRO
yopli2000_5
PRO
civernet_11724
PRO
daniel89fg_739
PRO
estrategicos_11919
Patrocinar

Amplíe sus conocimientos con los cursos oficiales

Curso básico de programación

Con este curso aprenderá cómo crear un plugin sencillo para FacturaScripts 2021: añadir nuevas páginas, tablas y columnas. Para entender este curso no se necesita mucha experiencia en programación, le enseñaremos los básico para modelar problemas sencillos. ¿A quién va dirigido? A cualquier persona con unos conocimientos muy básicos de programación. ¿Qué incluye? 18 lecciones con 14 vídeos explicativos.

325 9,99 €
Sesiones de programación

Esta es una recopilación de vídeos y documentación de pequeños desarrollos sobre FacturaScripts y sus plugins. Perfecto para expandir tus conocimientos de programación. ¿A quién va dirigido? A personas que ya hayan superado el curso básico de programación y busquen ampliar sus conocimientos. ¿Qué incluye? 19 lecciones con 19 vídeos explicativos (más de 9 horas de vídeos) y el código fuente de los ejemplos. Novedades mensuales: Este curso se amplía cada mes con nuevas lecciones.

96 19,99 €
Cookies
Usamos cookies en nuestro sitio web para brindarte la experiencia más relevante recordando tus preferencias y visitas repetidas. Al hacer clic en "Aceptar", aceptas el uso de TODAS las cookies necesarias.

Copyright (c) 2013-2023 FacturaScripts

Soporte