PanelController

Este controlador, al igual que el controlador ListController es un controlador extendido para múltiples vistas/pestañas aunque en este caso se permite el uso de distintos tipos de vistas/pestañas:

• ListView: para mostrar listados.
• EditView: para editar los datos de un único modelo.
• EditListView: para editar múltiples registros de un modelo modelos.
• HTMLView: para mostar html con absoluta libertad.

El controlador divide la pantalla en dos zonas, una a la izquierda (zona de navegación) y otra la derecha donde se visualizan las vistas con los datos.

Para el uso de este controlador es necesario crear las vistas en formato XML, como en el resto de controladores extendidos.

Ejemplo: EditFabricante.php

<?php
namespace FacturaScripts\Core\Controller;

use FacturaScripts\Core\Base\DataBase\DataBaseWhere;
use FacturaScripts\Core\Lib\ExtendedController\PanelController;

class EditFabricante extends PanelController
{
    public function getPageData(): array
    {
        $page = parent::getPageData();
        $page['title'] = 'manufacturer';
        $page['menu'] = 'warehouse';
        $page['icon'] = 'fa-folder-open';
        $page['showonmenu'] = false;
        return $page;
    }

    protected function createViews() {
        $this->addEditView('EditFabricante', 'Fabricante', 'manufacturer');
        $this->addListView('ListProducto', 'Producto', 'products');
    }

    protected function loadData($viewName, $view) {
        switch ($viewName) {
            case 'EditFabricante':
                $code = $this->request->get('code');
                $view->loadData($code);
                break;

            case 'ListProducto':
                $where = [new DataBaseWhere('codfabricante', $this->getModel()->primaryColumnValue())];
                $view->loadData('', $where);
                break;
        }
    }
}

createViews()

Dentro de este método, en nuestra nueva clase, debemos ir creando las distintas vistas/pestañas que se visualizarán, debiendo usar distintos métodos según el tipo de vista que estamos añadiendo. Debemos indicar mediante cadenas de texto, al añadir una vista, el modelo (Nombre completo) y el nombre de la vista XML, y opcionalmente el título y el icono para el grupo de navegación.

• addEditView(): añade una pestaña/vista para editar datos de un único registro de un modelo.
• addEditListView(): añade una vista pestaña/para editar múltiples registros de un modelo.
• addListView(): añade una pestaña/vista para visualizar en modo lista múltiples registros de un modelo.
• addHtmlView(): añade una pestaña/vista con total libertad sobre el HTML.

Existe la posibilidad de añadir varias vistas/pestañas para un mismo modelo y usando la misma vista XML. Para ello, al añadir la vista debemos un índice numérico empezando por 1 y separando el nombre de la vista del índice con un guión ('-').

$this->addListView('ListPartidaImpuesto-1', 'PartidaImpuesto', 'purchases', 'fas fa-sign-in-alt');
$this->addListView('ListPartidaImpuesto-2', 'PartidaImpuesto', 'sales', 'fas fa-sign-out-alt');

Este método tiene una visibilidad de protected de manera que los plugins pueden ir extendiendo nuestra clase y añadir nuevas vistas, o modificar las existentes.

loadData()

Este método es llamado por cada una de las vistas para que podamos cargar los datos específicos de la misma. En la llamada se nos informa del identificador de la vista y el propio objeto view, pudiendo acceder a todas las propiedades del mismo. La carga de datos puede variar según el tipo de vista, por lo que es responsabilidad del programador realizar la carga de datos correctamente. Aunque esto pueda suponer una dificultad añadida, también nos permite un mayor control sobre los datos que a leer del modelo.

$this->hasData

Este controlador comprueba durante la carga (el loadData) si el modelo de la primera pestaña existe en la base de datos, es decir, si hemos añadido una pestaña EditView con el modelo Producto en primera posición, comprobará si el producto existe. En caso contrario la navegación entre pestañas aparecerá bloqueada.

Si queremos que las pestañas siempre estén activas, podemos poner $this->hasData a true en el loadData(), por ejemplo:

$this->hasData = true;

setTabsPosition()

Este método permite poner las pestaña a la izquierda, arriba, abajo o abajo a la izquierda:

$this->setTabsPosition('left'); // coloca las pestañas a la izquierda
$this->setTabsPosition('top'); // coloca las pestañas arriba
$this->setTabsPosition('bottom'); // coloca las pestañas abajo (la primera pestaña queda arriba y las demás debajo)
$this->setTabsPosition('left-bottom'); // coloca las pestañas abajo a la izquierda (la primera queda arriba y las demás abajo)

Cuando están colocadas abajo (bottom), se muestra ventana principal (primera vista que se añade) y debajo la información de la pestaña seleccionada. Si sólo hay una vista/pestaña (a demás de la principal) se muestra directamente la vista sin el diseño de pestañas.