Added documentation for zfcampus#79

- Covers new "links" element of the Metadata - Covers new renderResource and renderCollection events
pagbada · Jul 25, 2013 · 7b49b73 · 7b49b73
1 parent 55adde0
commit 7b49b73
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 2 deletions.
diff --git a/docs/ref/advanced-rendering.rst b/docs/ref/advanced-rendering.rst
@@ -26,6 +26,7 @@ However, it does expose a few pieces of functionality that may be of interest:
   was detailed :ref:`in the previous section <ref/advanced-routing>`.
 - The ``getIdFromResource`` event (also detailed :ref:`in the previous section
   <ref/advanced-routing>`). 
+- The ``renderResource`` and ``renderCollection`` events.
 - The ``renderCollection.resource`` event.
 
 If in a controller, or interacting with a controller instance, you can access it
@@ -36,8 +37,53 @@ via the controller's ``plugin()`` method:
     $halLinks = $controller->plugin('HalLinks');
 
 For the purposes of this chapter, we'll look specifically at the
-``renderCollection.resource`` event, as it allows you, the developer, to fully
-customize how you extract your resource to an array.
+``renderResource``, ``renderCollection``, and ``renderCollection.resource``
+events, as they allow you, the developer, to fully customize how you extract
+your resource to an array as well as manipulate links.
+
+The renderResource and renderCollection events
+----------------------------------------------
+
+These events are triggered each time you render a resource or collection, even
+if they are embedded. As such, this allows you to introspect these items and
+manipulate them prior to extracting them to a representation.
+
+As an example, let's say we want to inject a "describedby" link into any
+``My\User`` resource and/or ``My\Users`` collection. We can do this as follows:
+
+.. code-block:: php
+    :linenos:
+
+    $sharedEvents->attach(
+        'PhlyRestfully\Plugin\HalLinks',
+        array('renderResource', 'renderCollection'),
+        function ($e) {
+            $resource   = $e->getParam('resource', false);
+            $collection = $e->getParam('collection', false);
+            if (!$resource && !$collection) {
+                return;
+            }
+            if ($resource && !$resource instanceof \My\User) {
+                return;
+            }
+            if ($collection && !$collection instanceof \My\Users) {
+                return;
+            }
+            if ($collection) {
+                $resource = $collection;
+            }
+            $links = $resource->getLinks();
+            $links->add(\PhlyRestfully\Link::factory(array(
+                'rel' => 'describedby',
+                'url' => 'http://example.com/api/help/resources/user',
+            )));
+        }
+    );
+
+The above attaches to both events, and then checks if we have a resource or
+collection we're interested in; if so, it creates a link and injects it into the
+composed link collection. This will ensure we have a "describedby" relational
+link in each one of these rendered resources.
 
 The renderCollection.resource event
 -----------------------------------

diff --git a/docs/ref/metadata-map.rst b/docs/ref/metadata-map.rst
@@ -65,6 +65,11 @@ The following options are available for metadata maps:
   defaults to "id". (**OPTIONAL**)
 - **is_collection**: boolean flag indicating whether or not the resource is a
   collection; defaults to "false". (**OPTIONAL**)
+- **links**: array of additional relational links to use with the resource or
+  collection. Each item in the array is itself an array, with the required key
+  "rel" (describing the relation), and one of either "url" (a string) or "route"
+  (an array with the members: "name", required; "params", an array, optional;
+  and "options", an array, optional). (**OPTIONAL**)
 - **resource_route**: the name of the route to use for resources embedded as part
   of a collection. If not set, the route for the resource is used. (**OPTIONAL**)
 - **route**: the name of the route to use for generating the "self" relational