Las vistas HTML

FacturaScripts utiliza el motor de plantillas twig. Un motor realmente potente que permite bloques, macros, funciones, extensiones y herencia entre plantillas. Los archivos de las vistas HTML deben tener la extensión .html.twig y se deben almacenar en la carpeta View de su plugin.

Ejemplo: MyNewView.html.twig

Este es un ejemplo muy básico de plantilla HTML:

{% extends "Master/MenuTemplate.html.twig" %}

{% block body %}
    {{ parent() }}
    <h1>Hola mundo</h1>
{% endblock %}

{% block css %}
    {{ parent() }}
{% endblock %}

{% block javascripts %}
    {{ parent() }}
{% endblock %}

Esta vista hereda de Master/MenuTemplate.html.twig, que es la vista de FacturaScripts que incluye el menú superior. Si por el contrario no queremos el menú, podemos heredar de Master/MicroTemplate.html.twig

Elegir una vista desde el controlador.

Para seleccionar otra vista desde el controlador simplente debemos llamar a la función setTemplate() indicando el nombre de la vista, sin la extensión.

$this->setTemplate('MyNewView'); // seleccionamos View/MyNewView.html.twig

Si por el contrario no queremos ninguna vista, es decir, queremos desactivar la salida HTML, debemos psarle al valor false:

$this->setTemplate('false'); // desactivamos la salida HTML

Variables accesibles desde la vista:

• appSettings: La clase que permite acceder rápidamente al apartado Por defecto (menú administrador, panel de control).
• assetManager: Para obtener el js o css cargado desde el controlador.
• controllerName: Nombre del controlador ejecutado.
• fsc: el controlador ejecutado. A través del cual podemos acceder a todas sus propiedades o métodos públicos.
• i18n: El traductor.
• log: El MiniLog.
• template: el nombre de la plantilla cargada.

Obtener la url de la página actual.

En ocasiones se necesita la URL de la página actual, bien sea para un formulario o un enlace. Todos los controladores tienen su función url(), por lo que podemos llamarla en cualquier momento.

{{ fsc.url() }}

Obtener la url de un controlador especifico.

En ocasiones se necesita la URL de un controlador especifico, bien sea para un formulario o un enlace. Para eso utilizamos la funcion asset() de las vistas.

{{ asset('ListFacturaCliente') }}

Obtener el nombre del usuario.

{{ fsc.user.nick }}

Obtener texto traducido

Podemos usar trans() para mostrar en pantalla texto traducido al idioma del usuario. En este ejemplo la palabra 'save':

{{ trans('save') }}

Si queremos pasar parámetros a la traducción:

{{ trans('save', {'code':'FAC1578'}) }}

Y si queremos traducir a un idioma concreto:

{{ trans('save', {}, 'de_DE') }}

Obtener un archivo de la biblioteca

Le pasamos el id del archivo de la biblioteca y nos devuelve el objeto si lo encuentra.

{% set file = attachedFile(5) %}
{{ file.path }}

Obtener el token para formularios

Con esta línea obtendremos el input ya rellenado con el token para ponerlo en el formulario.

{{ formToken() }}

También podemos obtener solo el token sin el input.

{{ formToken(false) }}

Obtener números formateados con decimales

Para formatear un número con los decimales establecidos en la configuración general, por ejemplo 2 decimales.

{{ number(20.338547) }}

También podemos establecer los decimales manualmente.

{{ number(20.338547, 4) }}

Obtener precios formateados

Para formatear un número con la divisa por defecto del sistema.

{{ money(15.42) }}

Para especificar la divisa podemos pasarla como segundo parámetro.

{{ money(15.42, 'EUR') }}

Obtener parámetros de la configuración (Settings)

El panel de control (menú Administrador, Panel de control) se guarda en un tabla llamada settings en la base de datos, y usa su modelo Setting. Cada pestaña o submenu dentro del panel de control pertenece a un grupo, la configuración general de FacturaScripts pertenece al grupo default. Podemos llamar a la función settings pasandole el grupo, la propiedad y como terncer parámetro opcional un valor por defecto.

Para obtener datos guardados en la configuración general podemos hacer lo siguiente:

{% set divisa = settings('default', 'coddivisa') %}
{% set decimales = settings('default', 'decimals') %}

Además podemos establcer un tercer parámetro, para ponerlo por defecto por si no encuetrá el valor a buscar:

{% set dias = settings('default', 'dias', 7) %}

Añadir nuestras propias funciones

Podemos añadir desde nuestros plugins funciones personalizadas a la clase Html, de este modo podremos usar dichas funciones desde cualquier vista twig.

En nuestro archivo Init.php del plugin, añadimos lo siguiente. Esto es un ejemplo para añadir una función personalizada llamada "fecha", que nos permitirá obtener la decha actual en el formato que le digamos.

<?php
namespace FacturaScripts\Plugins\MiPlugin;

use FacturaScripts\Core\Html;
use FacturaScripts\Core\Base\InitClass;
use Twig\TwigFunction;

class Init extends InitClass
{
    public function init()
    {
        Html::addFunction(new TwigFunction('fecha', function (string $format = 'Y-m-d H:i:s') {
            return date($format);
        }));
    }
}

Modo de uso en la plantilla twig.

{{ fecha() }}

{{ fecha('d-m-Y') }}

Documentación de Twig oficial

Tiene la documentación completa de twig en https://twig.symfony.com/doc/3.x/