> Symfony 5 > Netgen Layouts: Construyendo páginas con Symfony
12.

Navegador de Contenidos: Devolver los elementos

|

Share this awesome video!

|

Nuestro Navegador de Contenidos está funcionando más o menos. Podemos ver nuestra única ubicación... sólo que aún no tenemos ningún resultado. Esto se debe a que, para cualquier ubicación seleccionada, el Navegador de Contenidos llama a getSubItems(). Nuestro trabajo aquí es devolver los resultados. En este caso, todas nuestras recetas. Si tuviéramos varias ubicaciones, como recetas divididas en categorías, podríamos utilizar la variable $location para devolver el subconjunto. Pero haremos la consulta y devolveremos todas las recetas.

Consulta en getSubItems()

Para ello, ve a la parte superior de la clase y crea un constructor conprivate RecipeRepository $recipeRepository:

72 lines | src/ContentBrowser/RecipeBrowserBackend.php
// ... lines 1 - 4
use App\Repository\RecipeRepository;
// ... lines 6 - 11
class RecipeBrowserBackend implements BackendInterface
{
public function __construct(private RecipeRepository $recipeRepository)
{
}
// ... lines 17 - 70
}

Luego, aquí abajo en getSubItems(), di $recipes = $this->recipeRepository y utiliza el mismo método de antes: ->createQueryBuilderOrderedByNewest(). A continuación añade ->setFirstResult($offset)... y ->setMaxResults($limit). El Navegador de Contenidos viene con la paginación incorporada. Nos pasa el desplazamiento y el límite de la página en la que se encuentre el usuario, lo introducimos en la consulta y todos contentos. Termina con getQuery() y getResult():

72 lines | src/ContentBrowser/RecipeBrowserBackend.php
// ... lines 1 - 11
class RecipeBrowserBackend implements BackendInterface
{
// ... lines 14 - 46
public function getSubItems(LocationInterface $location, int $offset = 0, int $limit = 25): iterable
{
$recipes = $this->recipeRepository
->createQueryBuilderOrderedByNewest()
->setFirstResult($offset)
->setMaxResults($limit)
->getQuery()
->getResult();
}
// ... lines 56 - 70
}

Fíjate en que getSubItems() devuelve un iterable... en realidad se supone que es un iterable de algo llamado ItemInterface. Así que no podemos devolver simplemente estos objetos Recipe.

Crear la clase envolvente ItemInterface

En su lugar, en src/ContentBrowser/, crea otra clase llamada, qué talRecipeBrowserItem. Haz que implemente ItemInterface -la deNetgen\ContentBrowser - y genera los cuatro métodos que necesita:

29 lines | src/ContentBrowser/RecipeBrowserItem.php
// ... lines 1 - 2
namespace App\ContentBrowser;
use Netgen\ContentBrowser\Item\ItemInterface;
class RecipeBrowserItem implements ItemInterface
{
public function getValue()
{
// TODO: Implement getValue() method.
}
public function getName(): string
{
// TODO: Implement getName() method.
}
public function isVisible(): bool
{
// TODO: Implement isVisible() method.
}
public function isSelectable(): bool
{
// TODO: Implement isSelectable() method.
}
}

Esta clase será una pequeña envoltura de un objeto Recipe. Observa: añade un método __construct() con private Recipe $recipe:

34 lines | src/ContentBrowser/RecipeBrowserItem.php
// ... lines 1 - 4
use App\Entity\Recipe;
// ... lines 6 - 7
class RecipeBrowserItem implements ItemInterface
{
public function __construct(private Recipe $recipe)
{
}
// ... lines 13 - 32
}

Ahora, para getValue(), esto debería devolver el "identificador", así quereturn $this->recipe->getId(). Para getName(), sólo necesitamos algo visual que podamos mostrar, como$this->recipe->getName(). Y para isVisible(), return true. Esto es útil si un Recipe puede estar publicado o no. Tenemos una situación similar conisSelectable():

34 lines | src/ContentBrowser/RecipeBrowserItem.php
// ... lines 1 - 7
class RecipeBrowserItem implements ItemInterface
{
// ... lines 10 - 13
public function getValue()
{
return $this->recipe->getId();
}
public function getName(): string
{
return $this->recipe->getName();
}
public function isVisible(): bool
{
return true;
}
public function isSelectable(): bool
{
return true;
}
}

Si tuvieras un conjunto de reglas en las que quisieras mostrar ciertas recetas pero hacer que no se pudieran seleccionar, podrías return false aquí.

Y... ¡ya está! ¡Ha sido fácil!

De vuelta a nuestra clase backend, necesitamos convertir estos objetos Recipe en objetosRecipeBrowserItem. Podemos hacerlo con array_map(). Volveré a utilizar la elegante sintaxis fn(), que recibirá un argumento Recipe $recipe, seguido de => new RecipeBrowserItem($recipe). Para el segundo arg, pasa $recipes:

75 lines | src/ContentBrowser/RecipeBrowserBackend.php
// ... lines 1 - 12
class RecipeBrowserBackend implements BackendInterface
{
// ... lines 15 - 47
public function getSubItems(LocationInterface $location, int $offset = 0, int $limit = 25): iterable
{
// ... lines 50 - 55
return array_map(fn(Recipe $recipe) => new RecipeBrowserItem($recipe), $recipes);
}
// ... lines 59 - 73
}

Es una forma elegante de decir

Recorre todas las recetas del sistema, crea un nuevo RecipeBrowserItem para cada una, y devuelve esa nueva matriz de elementos.

Muy bien, ¡vamos a ver qué aspecto tiene! Actualiza el diseño, haz clic en la Rejilla, vuelve a "Añadir elementos" y... ¡ya está! ¡Vemos diez elementos!

Implementando getSubItemsCount()

Pero deberíamos tener varias páginas. Ah, eso es porque seguimos devolviendo 0desde getSubItemsCount(). Vamos a arreglarlo. Roba la consulta de arriba... pega, devuelve esto, quita setFirstResult() y setMaxResults(), añade ->select('COUNT(recipe.id)'), y luego llama a getSingleScalarResult()al final:

79 lines | src/ContentBrowser/RecipeBrowserBackend.php
// ... lines 1 - 12
class RecipeBrowserBackend implements BackendInterface
{
// ... lines 15 - 59
public function getSubItemsCount(LocationInterface $location): int
{
return $this->recipeRepository
->createQueryBuilderOrderedByNewest()
->select('COUNT(recipe.id)')
->getQuery()
->getSingleScalarResult();
}
// ... lines 68 - 77
}

Y así, cuando actualicemos... y abramos el Navegador de Contenidos... ¡tendremos páginas!

Añadir la función de búsqueda

Vale, pero ¿podemos buscar recetas? Por supuesto. Podemos aprovechar search() ysearchCount(). Esto es muy sencillo. Roba toda la lógica de getSubItems(), pégala en search() y pasa $searchText al método QueryBuilder, que ya permite este argumento:

90 lines | src/ContentBrowser/RecipeBrowserBackend.php
// ... lines 1 - 12
class RecipeBrowserBackend implements BackendInterface
{
// ... lines 15 - 68
public function search(string $searchText, int $offset = 0, int $limit = 25): iterable
{
$recipes = $this->recipeRepository
->createQueryBuilderOrderedByNewest($searchText)
->setFirstResult($offset)
->setMaxResults($limit)
->getQuery()
->getResult();
return array_map(fn(Recipe $recipe) => new RecipeBrowserItem($recipe), $recipes);
}
// ... lines 80 - 88
}

Si quieres tener un poco menos de duplicación de código, podrías aislar esto en un método private en la parte inferior.

Copia también la lógica del otro método de recuento... pégalo en searchCount(), y pásalo también a $searchText:

90 lines | src/ContentBrowser/RecipeBrowserBackend.php
// ... lines 1 - 12
class RecipeBrowserBackend implements BackendInterface
{
// ... lines 15 - 80
public function searchCount(string $searchText): int
{
return $this->recipeRepository
->createQueryBuilderOrderedByNewest($searchText)
->select('COUNT(recipe.id)')
->getQuery()
->getSingleScalarResult();
}
}

Y así de fácil, si nos movemos hacia aquí e intentamos buscar... funciona. ¡Estupendo!

Muy bien - selecciona algunos elementos, pulsa "Confirmar" y... ¡oh no! ¡Se rompe! Sigue diciendo "Cargando". Si miras hacia abajo en la barra de herramientas de depuración web, tenemos un error 400. Maldita sea. Cuando lo abrimos, vemos

El cargador de valores para el tipo de valor doctrine_recipe no existe.

Sólo nos falta una pieza final: Una clase muy sencilla llamada "cargador de valores". Eso a continuación.