Pass models to events by reference and document Show endpoint

Author: tobyzerner

docs/.vuepress/config.js

@@ -39,6 +39,7 @@ module.exports = {
         collapsable: false,
         children: [
           'list',
+          'show',
           'create',
           'update',
           'delete',

docs/create.md

@@ -29,7 +29,7 @@ $type->newModel(function (Context $context) {
 Run before the model is saved.
 
 ```php
-$type->onCreating(function ($model, Context $context) {
+$type->onCreating(function (&$model, Context $context) {
     // do something
 });
 ```
@@ -39,7 +39,7 @@ $type->onCreating(function ($model, Context $context) {
 Run after the model is saved.
 
 ```php
-$type->onCreated(function ($model, Context $context) {
+$type->onCreated(function (&$model, Context $context) {
     $context->meta('foo', 'bar');
 });
 ```

docs/delete.md

@@ -19,7 +19,7 @@ $type->deletable(function (Context $context) {
 Run before the model is deleted.
 
 ```php
-$type->onDeleting(function ($model, Context $context) {
+$type->onDeleting(function (&$model, Context $context) {
     // do something
 });
 ```
@@ -29,7 +29,7 @@ $type->onDeleting(function ($model, Context $context) {
 Run after the model is deleted.
 
 ```php
-$type->onDeleted(function ($model, Context $context) {
+$type->onDeleted(function (&$model, Context $context) {
     // do something
 });
 ```

docs/show.md

@@ -0,0 +1,15 @@
+# Showing Resources
+
+For each resource type, a `GET /{type}/{id}` endpoint is exposed to show an individual resource.
+
+## Events
+
+### `onShow`
+
+Run after models and relationships have been retrieved, but before they are serialized into a JSON:API document.
+
+```php
+$type->onShow(function (&$model, Context $context) {
+    // do something
+});
+```

docs/update.md

@@ -19,7 +19,7 @@ $type->updatable(function (Context $context) {
 Run before the model is saved.
 
 ```php
-$type->onUpdating(function ($model, Context $context) {
+$type->onUpdating(function (&$model, Context $context) {
     // do something
 });
 ```
@@ -29,7 +29,7 @@ $type->onUpdating(function ($model, Context $context) {
 Run after the model is saved.
 
 ```php
-$type->onUpdated(function ($model, Context $context) {
+$type->onUpdated(function (&$model, Context $context) {
     // do something
 });
 ```

src/Endpoint/Create.php

@@ -54,11 +54,11 @@ public function handle(Context $context): ResponseInterface
         $this->assertDataValid($data, $model, $context, true);
         $this->setValues($data, $model, $context);
 
-        run_callbacks($schema->getListeners('creating'), [$model, $context]);
+        run_callbacks($schema->getListeners('creating'), [&$model, $context]);
 
         $this->save($data, $model, $context);
 
-        run_callbacks($schema->getListeners('created'), [$model, $context]);
+        run_callbacks($schema->getListeners('created'), [&$model, $context]);
 
         return (new Show($this->api, $this->resource, $model))
             ->handle($context)

src/Endpoint/Delete.php

@@ -44,15 +44,15 @@ public function handle(Context $context): ResponseInterface
             throw new ForbiddenException;
         }
 
-        run_callbacks($schema->getListeners('deleting'), [$this->model, $context]);
+        run_callbacks($schema->getListeners('deleting'), [&$this->model, $context]);
 
         if ($deleteCallback = $schema->getDeleteCallback()) {
             $deleteCallback($this->model, $context);
         } else {
             $this->resource->getAdapter()->delete($this->model);
         }
 
-        run_callbacks($schema->getListeners('deleted'), [$this->model, $context]);
+        run_callbacks($schema->getListeners('deleted'), [&$this->model, $context]);
 
         return new Response(204);
     }

src/Endpoint/Show.php

@@ -42,7 +42,7 @@ public function handle(Context $context): ResponseInterface
 
         $this->loadRelationships([$this->model], $include, $context);
 
-        run_callbacks($this->resource->getSchema()->getListeners('show'), [$this->model, $context]);
+        run_callbacks($this->resource->getSchema()->getListeners('show'), [&$this->model, $context]);
 
         $serializer = new Serializer($this->api, $context);
         $serializer->add($this->resource, $this->model, $include);

src/Endpoint/Update.php

@@ -52,11 +52,11 @@ public function handle(Context $context): ResponseInterface
         $this->assertDataValid($data, $this->model, $context, false);
         $this->setValues($data, $this->model, $context);
 
-        run_callbacks($schema->getListeners('updating'), [$this->model, $context]);
+        run_callbacks($schema->getListeners('updating'), [&$this->model, $context]);
 
         $this->save($data, $this->model, $context);
 
-        run_callbacks($schema->getListeners('updated'), [$this->model, $context]);
+        run_callbacks($schema->getListeners('updated'), [&$this->model, $context]);
 
         return (new Show($this->api, $this->resource, $this->model))
             ->handle($context);