Funciones y métodos en Twig

El motor de plantillas de Twig permite crear funciones que podemos invocar directamente en la vista.

Aunque hay que separar la vista de la lógica, en ocasiones es necesario crear funciones o métodos en Twig para acceder a cosas de la lógica.

En este post te mostraré cómo crear funciones en Twig.

Declarar función en Twig

Supongo que ya tienes un entorno de Twig. Por ejemplo:

<?php
use Twig\TwigFunction;
use Twig\Loader\FilesystemLoader;
$loader = new FilesystemLoader(DIRECTORIO_RAIZ . "/vistas");
$twig = new Environment($loader, [
    "cache" => $rutaCacheTwig,
]);

Para crear una función puedes usar TwigFunction (Twig\TwigFunction) así:

<?php
# en la parte superior va la siguiente línea...
use Twig\TwigFunction;
# Después puedes definir la función ;)
$funcion = new TwigFunction("nombre_funcion", function(){
    return "Todo bien";
});

El primer argumento es el nombre de la función y el segundo es la función en sí. En este caso la función (dentro de Twig) se llama nombre_funcion.

Agregar función a Twig

Hemos creado la función pero no la hemos agregado. Para agregarla, una vez que ya la hemos definido, invocamos a addFunction en el entorno:

<?php
$funcion = new TwigFunction("nombre_funcion", function(){
    return "Todo bien";
});
# La agregamos
$twig->addFunction($funcion);

Usar función en la vista

Después, dentro de la vista, usamos la función. Podemos encerrar su resultado en una variable o simplemente invocar a la función. En mi caso:

<h1 class="text-center">Agregar usuario {{ nombre_funcion() }}</h1>

Y al renderizar:

Argumentos en funciones de Twig

Como cualquier otra función, las funciones o métodos de Twig pueden recibir argumentos:

<?php
$funcion = new TwigFunction("saludo", function($nombre){
    return "Hola, $nombre";
});
$twig->addFunction($funcion);

Definimos el nombre de la función, y el callable. Dentro del callable indicamos que vamos a recibir un argumento llamado $nombre, después regresamos un saludo.

En este caso solo estoy regresando un valor; las funciones, como toda función de PHP, pueden o no devolver algo, así como realizar otras acciones.

El punto es que para invocar esa función se hace lo siguiente:

<h1 class="text-center">Agregar usuario {{ saludo('Luis') }}</h1>

Con el resultado que se ve en la imagen:

Funciones en Twig con funciones existentes

Como el segundo argumento para una TwigFunction es un callable, podemos indicarle el nombre de una función que ya existe. De este modo podemos exponer funciones de PHP en la vista de Twig.

Por ejemplo, voy a exponer la función date que sirve, entre otras cosas, para formatear la fecha actual.

Comienzo agregando la función. No te confundas, el nombre de la función dentro de Twig es date, y le estoy pasando el nombre de otra función callable que ya existe en PHP, llamada date (podría ser otra función como in_array, function_exists, etcétera)

<?php
$funcion = new TwigFunction("date", "date");
$twig->addFunction($funcion);

Después se utiliza así:

<h1 class="text-center">Agregar usuario {{ date('Y-m-d') }}</h1>

Con el siguiente resultado:

Obviamente si date no recibiera argumentos no tendríamos que indicarlos. Como lo dije, esto es usar una función normal de PHP en Twig, ya sea que regrese o no regrese algo, o haga o no haga algo.

Si quieres el ejemplo completo o un lugar en donde se use, mira mi plantilla para proyectos de PHP.