Adds beforeSerialize and afterSerialize events

Author: cnizzardini

plugins/collection-view/README.md

@@ -157,3 +157,17 @@ return [
     ]
 ];
 ```
+
+## Events
+
+CollectionView dispatches two events:
+
+### MixerApi.CollectionView.beforeSerialize
+
+The event contains the Serializer as the subject and the `type` of data (i.e. "xml" or "json").
+
+### MixerApi.CollectionView.afterSerialize
+
+The event contains the Serializer as the subject, the `type` of data (i.e. "xml" or "json") and the serialized data
+as `data`.
+

plugins/collection-view/src/Serializer.php

@@ -7,6 +7,8 @@
 use Cake\Core\Configure;
 use Cake\Datasource\Paging\PaginatedResultSet;
 use Cake\Datasource\ResultSetInterface;
+use Cake\Event\Event;
+use Cake\Event\EventManager;
 use Cake\Http\ServerRequest;
 use Cake\Utility\Xml;
 use Cake\View\Helper\PaginatorHelper;
@@ -66,12 +68,21 @@ public function __construct(mixed $serialize, ?ServerRequest $request = null, ?P
      */
     public function asJson(int $jsonOptions = 0): string
     {
+        EventManager::instance()->dispatch(new Event('MixerApi.CollectionView.beforeSerialize', $this, [
+            'type' => 'json',
+        ]));
+
         $json = json_encode($this->data, $jsonOptions);
 
         if ($json === false) {
             throw new RuntimeException(json_last_error_msg(), json_last_error());
         }
 
+        EventManager::instance()->dispatch(new Event('MixerApi.CollectionView.afterSerialize', $this, [
+            'type' => 'json',
+            'data' => $json,
+        ]));
+
         return $json;
     }
 
@@ -85,7 +96,18 @@ public function asJson(int $jsonOptions = 0): string
      */
     public function asXml(array $options, string $rootNode = 'response'): string
     {
-        return Xml::fromArray([$rootNode => $this->data], $options)->saveXML();
+        EventManager::instance()->dispatch(new Event('MixerApi.CollectionView.beforeSerialize', $this, [
+            'type' => 'xml',
+        ]));
+
+        $xml = Xml::fromArray([$rootNode => $this->data], $options)->saveXML();
+
+        EventManager::instance()->dispatch(new Event('MixerApi.CollectionView.afterSerialize', $this, [
+            'type' => 'xml',
+            'data' => $xml,
+        ]));
+
+        return $xml;
     }
 
     /**

plugins/collection-view/tests/TestCase/SerializerTest.php

@@ -5,6 +5,8 @@
 use Cake\Controller\ComponentRegistry;
 use Cake\Datasource\FactoryLocator;
 use Cake\Datasource\Paging\PaginatedResultSet;
+use Cake\Event\EventList;
+use Cake\Event\EventManager;
 use Cake\Http\Response;
 use Cake\Http\ServerRequest;
 use Cake\Routing\RouteBuilder;
@@ -20,7 +22,7 @@
 class SerializerTest extends TestCase
 {
     /**
-     * @var string[]
+     * @inheritdoc
      */
     public array $fixtures = [
         'plugin.MixerApi/CollectionView.Actors',
@@ -34,6 +36,8 @@ public function setUp(): void
 
     public function test_as_json(): void
     {
+        EventManager::instance()->trackEvents(true)->setEventList(new EventList());
+
         $actor = FactoryLocator::get('Table')->get('Actors');
 
         $result = new PaginatedResultSet($actor->find()->limit(1)->all(), [
@@ -85,6 +89,8 @@ public function test_as_json(): void
 
         $obj = json_decode($json);
         $this->assertIsObject($obj);
+        $this->assertEventFired('MixerApi.CollectionView.beforeSerialize');
+        $this->assertEventFired('MixerApi.CollectionView.afterSerialize');
         $this->assertEquals(20, $obj->collection->count);
         $this->assertEquals(60, $obj->collection->total);
         $this->assertEquals('/', $obj->collection->url);
@@ -93,6 +99,7 @@ public function test_as_json(): void
 
     public function test_as_xml(): void
     {
+        EventManager::instance()->trackEvents(true)->setEventList(new EventList());
         $actor = FactoryLocator::get('Table')->get('Actors');
 
         $result = new PaginatedResultSet($actor->find()->limit(1)->all(), [
@@ -142,6 +149,8 @@ public function test_as_xml(): void
         $this->assertIsString($xml);
 
         $simpleXml = simplexml_load_string($xml);
+        $this->assertEventFired('MixerApi.CollectionView.beforeSerialize');
+        $this->assertEventFired('MixerApi.CollectionView.afterSerialize');
         $this->assertInstanceOf(SimpleXMLElement::class, $simpleXml);
         $this->assertEquals('/', $simpleXml->collection->url);
         $this->assertInstanceOf(SimpleXMLElement::class, $simpleXml->data);

plugins/hal-view/README.md

@@ -245,3 +245,15 @@ use Cake\Http\ServerRequest;
 use Cake\View\Helper\PaginatorHelper;
 $json = (new JsonSerializer($data, new ServerRequest(), new PaginatorHelper()))->asJson();
 ```
+
+## Events
+
+HalView dispatches two events:
+
+### MixerApi.HalView.beforeSerialize
+
+The event contains the Serializer as the subject.
+
+### MixerApi.HalView.afterSerialize
+
+The event contains the Serializer as the subject and the serialized data as `data`.

plugins/hal-view/src/JsonSerializer.php

@@ -6,10 +6,13 @@
 use Cake\Datasource\EntityInterface;
 use Cake\Datasource\Paging\PaginatedResultSet;
 use Cake\Datasource\ResultSetInterface;
+use Cake\Event\Event;
+use Cake\Event\EventManager;
 use Cake\Http\ServerRequest;
 use Cake\ORM\Entity;
 use Cake\Utility\Inflector;
 use Cake\View\Helper\PaginatorHelper;
+use Cake\View\View;
 use MixerApi\Core\View\SerializableAssociation;
 use ReflectionClass;
 use ReflectionException;
@@ -63,12 +66,18 @@ public function __construct(mixed $serialize, ?ServerRequest $request = null, ?P
      */
     public function asJson(int $jsonOptions = 0): string
     {
+        EventManager::instance()->dispatch(new Event('MixerApi.HalView.beforeSerialize', $this));
+
         $json = json_encode($this->data, $jsonOptions);
 
         if ($json === false) {
             throw new RuntimeException(json_last_error_msg(), json_last_error());
         }
 
+        EventManager::instance()->dispatch(new Event('MixerApi.HalView.afterSerialize', $this, [
+            'data' => $json,
+        ]));
+
         return $json;
     }
 

plugins/hal-view/tests/TestCase/JsonSerializerTest.php

@@ -4,6 +4,8 @@
 
 use Cake\Datasource\FactoryLocator;
 use Cake\Datasource\Paging\PaginatedResultSet;
+use Cake\Event\EventList;
+use Cake\Event\EventManager;
 use Cake\Http\Response;
 use Cake\Http\ServerRequest;
 use Cake\ORM\Table;
@@ -71,6 +73,8 @@ public function setUp(): void
 
     public function test_collection(): void
     {
+        EventManager::instance()->trackEvents(true)->setEventList(new EventList());
+
         $actor = FactoryLocator::get('Table')->get('Actors');
         $result = new PaginatedResultSet($actor->find()->applyOptions(['contain' => 'Films'])->limit(1)->all(), [
             'sort' => null,
@@ -101,6 +105,8 @@ public function test_collection(): void
 
         $this->assertIsString($json);
         $this->assertIsObject(json_decode($json));
+        $this->assertEventFired('MixerApi.HalView.beforeSerialize');
+        $this->assertEventFired('MixerApi.HalView.afterSerialize');
     }
 
     public function test_item(): void

plugins/json-ld-view/README.md

@@ -345,3 +345,16 @@ use Cake\Http\ServerRequest;
 use Cake\View\Helper\PaginatorHelper;
 $json = (new JsonSerializer($data, new ServerRequest(), new PaginatorHelper()))->asJson();
 ```
+
+## Events
+
+JsonLdView dispatches two events:
+
+### MixerApi.JsonLdView.beforeSerialize
+
+The event contains the Serializer as the subject.
+
+### MixerApi.JsonLdView.afterSerialize
+
+The event contains the Serializer as the subject and the serialized data as `data`.
+

plugins/json-ld-view/src/JsonSerializer.php

@@ -7,6 +7,8 @@
 use Cake\Datasource\EntityInterface;
 use Cake\Datasource\Paging\PaginatedResultSet;
 use Cake\Datasource\ResultSetInterface;
+use Cake\Event\Event;
+use Cake\Event\EventManager;
 use Cake\Http\ServerRequest;
 use Cake\ORM\Entity;
 use Cake\View\Helper\PaginatorHelper;
@@ -82,12 +84,18 @@ public function __construct(mixed $serialize, ?ServerRequest $request = null, ?P
      */
     public function asJson(int $jsonOptions = 0): string
     {
+        EventManager::instance()->dispatch(new Event('MixerApi.JsonLdView.beforeSerialize', $this));
+
         $json = json_encode($this->data, $jsonOptions);
 
         if ($json === false) {
             throw new RuntimeException(json_last_error_msg(), json_last_error());
         }
 
+        EventManager::instance()->dispatch(new Event('MixerApi.JsonLdView.afterSerialize', $this, [
+            'data' => $json,
+        ]));
+
         return $json;
     }
 

plugins/json-ld-view/tests/TestCase/JsonSerializerTest.php

@@ -4,6 +4,8 @@
 
 use Cake\Datasource\FactoryLocator;
 use Cake\Datasource\Paging\PaginatedResultSet;
+use Cake\Event\EventList;
+use Cake\Event\EventManager;
 use Cake\Http\Response;
 use Cake\Http\ServerRequest;
 use Cake\ORM\Table;
@@ -66,6 +68,8 @@ public function setUp(): void
      */
     public function test_collection(string $resultType): void
     {
+        EventManager::instance()->trackEvents(true)->setEventList(new EventList());
+
         /** @var Table $actor */
         $actor = FactoryLocator::get('Table')->get('Actors');
         $result = $actor->find()->contain('Films')->limit(1)->all();
@@ -96,6 +100,8 @@ public function test_collection(string $resultType): void
 
         $this->assertIsString($json);
         $this->assertIsObject(json_decode($json));
+        $this->assertEventFired('MixerApi.JsonLdView.beforeSerialize');
+        $this->assertEventFired('MixerApi.JsonLdView.afterSerialize');
     }
 
     public static function dataProviderForCollectionTypes(): array