Add relationship docs (cloudcreativity#74)

GIANTCRAB · lindyhopchris · commit 2cab8297fb23 · 2017-06-30T09:44:25.000+01:00
* Fix password checking

* Add read related resource &amp; read relationship

* Remove old custom controller docs
diff --git a/docs/custom/controllers.md b/docs/custom/controllers.md
@@ -144,3 +144,44 @@ public function delete(RequestInterface $request)
     return $this->reply()->noContent();
 }
 ```
+
+## Relationship
+If you have defined relationships in the schema of a resource, you would then need to state the following in your controller too:
+
+1. `readRelatedResource()`
+2. `readRelationship()`
+
+### Read Related Resource
+If you link one resource to another through relationship, you'll need this to read the related resource.
+
+```php
+    /**
+     * @param JsonApiRequest $request
+     * @return mixed
+     */
+    public function readRelatedResource(JsonApiRequest $request)
+    {
+        $model = $request->getRecord();
+        $key = $request->getRelationshipName();
+        return $this
+            ->reply()
+            ->content($model->{$key});
+    }
+```
+
+### Read Relationship
+This is for reading the relationship between two resources.
+```php
+    /**
+     * @param JsonApiRequest $request
+     * @return mixed
+     */
+    public function readRelationship(JsonApiRequest $request)
+    {
+        $model = $request->getRecord();
+        $key = $request->getRelationshipName();
+        return $this
+            ->reply()
+            ->relationship($model->{$key});
+    }
+```
