From e87b102f503d330b6bddeabbece721e1c30b61e7 Mon Sep 17 00:00:00 2001
From: Voltra <Voltra@users.noreply.github.com>
Date: Thu, 27 Jun 2024 18:56:17 +0000
Subject: [PATCH] Add a hook to allow mass-preload of related data when
 rendering a page's blocks

---
 .../views/components/page-blocks.blade.php    | 23 +++++++++++++++----
 src/Helpers.php                               | 23 +++++++++++++++++++
 src/PageBlocks/PageBlock.php                  | 12 ++++++++++
 3 files changed, 53 insertions(+), 5 deletions(-)
 create mode 100644 src/Helpers.php

diff --git a/resources/views/components/page-blocks.blade.php b/resources/views/components/page-blocks.blade.php
index fddfba3..fe2a37d 100644
--- a/resources/views/components/page-blocks.blade.php
+++ b/resources/views/components/page-blocks.blade.php
@@ -1,14 +1,27 @@
+@aware(['page'])
 @props(['blocks' => []])
 
+@php
+    $groups = \Z3d0X\FilamentFabricator\Helpers::arrayRefsGroupBy($blocks, 'type');
+
+    foreach ($groups as $blockType => &$group) {
+        /**
+         * @var class-string<\Z3d0X\FilamentFabricator\PageBlocks\PageBlock> $blockClass
+         */
+        $blockClass = FilamentFabricator::getPageBlockFromName($blockType);
+
+        if (!empty($blockClass)) {
+            $blockClass::preloadRelatedData($page, $group);
+        }
+    }
+@endphp
+
 @foreach ($blocks as $blockData)
     @php
-        $pageBlock = \Z3d0X\FilamentFabricator\Facades\FilamentFabricator::getPageBlockFromName($blockData['type'])
+        $pageBlock = \Z3d0X\FilamentFabricator\Facades\FilamentFabricator::getPageBlockFromName($blockData['type']);
     @endphp
 
     @isset($pageBlock)
-        <x-dynamic-component
-            :component="$pageBlock::getComponent()"
-            :attributes="new \Illuminate\View\ComponentAttributeBag($pageBlock::mutateData($blockData['data']))"
-        />
+        <x-dynamic-component :component="$pageBlock::getComponent()" :attributes="new \Illuminate\View\ComponentAttributeBag($pageBlock::mutateData($blockData['data']))" />
     @endisset
 @endforeach
diff --git a/src/Helpers.php b/src/Helpers.php
new file mode 100644
index 0000000..cca0ee2
--- /dev/null
+++ b/src/Helpers.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace Z3d0X\FilamentFabricator;
+
+abstract class Helpers
+{
+    /**
+     * Group an array of associative arrays by a given key
+     *
+     * @param  array[]  $arr
+     * @return array[]
+     */
+    public static function arrayRefsGroupBy(array &$arr, string $key): array
+    {
+        $ret = [];
+
+        foreach ($arr as &$item) {
+            $ret[$item[$key]][] = &$item;
+        }
+
+        return $ret;
+    }
+}
diff --git a/src/PageBlocks/PageBlock.php b/src/PageBlocks/PageBlock.php
index c32fbe3..88c4001 100644
--- a/src/PageBlocks/PageBlock.php
+++ b/src/PageBlocks/PageBlock.php
@@ -3,6 +3,7 @@
 namespace Z3d0X\FilamentFabricator\PageBlocks;
 
 use Filament\Forms\Components\Builder\Block;
+use Z3d0X\FilamentFabricator\Models\Contracts\Page;
 
 abstract class PageBlock
 {
@@ -28,4 +29,15 @@ public static function mutateData(array $data): array
     {
         return $data;
     }
+
+    /**
+     * Hook used to mass-preload related data to reduce the number of DB queries.
+     * For instance, to load model objects/data from their IDs
+     *
+     * @param  (array{
+     *     type: string,
+     *     data: array,
+     * })[]  $blocks  - The array of blocks' data for the given page and the given block type
+     */
+    public static function preloadRelatedData(Page $page, array &$blocks): void {}
 }