Merge pull request #25 from 21TORR/slice-extra-data

Add slice extra data generator

CHANGELOG.md

@@ -1,3 +1,9 @@
+4.0.0-beta.9
+============
+
+*   (feature) Added `SliceExtraDataGenerator` to be able to append extra data to slices.
+
+
 4.0.0-beta.8
 ============
 

config/services.yaml

@@ -32,3 +32,6 @@ services:
     Torr\PrismicApi\Api\PrismicIntegrationFieldApi:
         $repository: '%env(PRISMIC_REPOSITORY)%'
         $tokens: '%env(json:PRISMIC_INTEGRATION_TOKENS)%'
+
+    Torr\PrismicApi\Transform\FieldValueTransformer:
+        $sliceExtraDataGenerators: !tagged_iterator 'prismic.slice.extra-data-generator'

src/PrismicApiBundle.php

@@ -8,6 +8,7 @@
 use Torr\BundleHelpers\Bundle\BundleExtension;
 use Torr\PrismicApi\Definition\DocumentDefinition;
 use Torr\PrismicApi\RichText\Link\LinkGeneratorHandler;
+use Torr\PrismicApi\Transform\Slice\SliceExtraDataGeneratorInterface;
 
 final class PrismicApiBundle extends Bundle
 {
@@ -26,6 +27,9 @@ public function build (ContainerBuilder $container) : void
 
 		$container->registerForAutoconfiguration(DocumentDefinition::class)
 			->addTag("prismic.document.definition");
+
+		$container->registerForAutoconfiguration(SliceExtraDataGeneratorInterface::class)
+			->addTag("prismic.slice.extra-data-generator");
 	}
 
 

src/Structure/Slice/Slice.php

@@ -122,6 +122,8 @@ public function getValidationConstraints () : array
 	public function transformValue (mixed $data, FieldValueTransformer $valueTransformer) : mixed
 	{
 		\assert(\is_array($data));
+		$resultItems = [];
+		$resultData = [];
 		$result = [
 			"data" => [],
 			"items" => [],
@@ -130,7 +132,7 @@ public function transformValue (mixed $data, FieldValueTransformer $valueTransfo
 
 		foreach ($this->fields as $key => $field)
 		{
-			$result["data"][$key] = $this->transformSingleValue(
+			$resultData[$key] = $this->transformSingleValue(
 				$valueTransformer,
 				$this->fields,
 				$key,
@@ -152,10 +154,14 @@ public function transformValue (mixed $data, FieldValueTransformer $valueTransfo
 				);
 			}
 
-			$result["items"][] = $transformedItem;
+			$resultItems[] = $transformedItem;
 		}
 
-		return $result;
+		return [
+			"data" => $resultData,
+			"items" => $resultItems,
+			"extra" => $valueTransformer->generateExtraDataForSlice($this),
+		];
 	}
 
 	/**

src/Transform/FieldValueTransformer.php

@@ -3,11 +3,16 @@
 namespace Torr\PrismicApi\Transform;
 
 use Torr\PrismicApi\Structure\Field\InputField;
+use Torr\PrismicApi\Structure\Slice\Slice;
 use Torr\PrismicApi\Structure\Slice\SliceZone;
+use Torr\PrismicApi\Transform\Slice\SliceExtraDataGeneratorInterface;
 
 final class FieldValueTransformer
 {
-	public function __construct ()
+	public function __construct (
+		/** @var iterable<SliceExtraDataGeneratorInterface> */
+		private iterable $sliceExtraDataGenerators,
+	)
 	{
 
 	}
@@ -29,4 +34,20 @@ public function transformRichText (array $data) : array
 	{
 		return $data;
 	}
+
+	/**
+	 * Generates the extra data for the given slice
+	 */
+	public function generateExtraDataForSlice (Slice $slice) : array
+	{
+		$result = [];
+
+		/** @var SliceExtraDataGeneratorInterface $dataGenerator */
+		foreach ($this->sliceExtraDataGenerators as $dataGenerator)
+		{
+			$result = $dataGenerator->appendExtraData($slice, $result);
+		}
+
+		return $result;
+	}
 }

src/Transform/Slice/SliceExtraDataGeneratorInterface.php

@@ -0,0 +1,16 @@
+<?php declare(strict_types=1);
+
+namespace Torr\PrismicApi\Transform\Slice;
+
+use Torr\PrismicApi\Structure\Slice\Slice;
+
+interface SliceExtraDataGeneratorInterface
+{
+	/**
+	 * @param array $extraData The pre-generated extra data, that can get appended to
+	 */
+	public function appendExtraData (
+		Slice $slice,
+		array $extraData,
+	) : array;
+}