RC4

Author: neomerx

README.md

@@ -1,36 +1,29 @@
 ## Neomerx JSON API sample application
 
-### Basic usage
+### Install
 
-```php
-$encoder = Encoder::instance([
-    Author::class  => AuthorSchema::class,
-], new JsonEncodeOptions(JSON_PRETTY_PRINT));
+Via Composer
 
-echo $encoder->encode($author) . PHP_EOL;
+```
+$ composer install
 ```
 
-will output
+### Run sample
 
-```json
-{
-    "data": {
-        "type": "people",
-        "id": "123",
-        "attributes": {
-            "first_name": "John",
-            "last_name": "Dow"
-        },
-        "links": {
-            "self": "http:\/\/example.com\/people\/123"
-        }
-    }
-}
 ```
+$ php sample.php
+```
+
+The application will output a few encoding results for
 
-For more details see [this sample file](sample.php)
+* a resource with no relationships
+* a resource with included relationships
+* sparse and field set filters usage sample
+* top level links and meta information usage sample
 
-## Neomerx JSON API performance test
+For more details see [the app source code](sample.php)
+
+## Performance test
 
 This application includes performance test as well. It can be run with default parameters
 
@@ -41,7 +34,7 @@ $ php sample.php -t
 or with execution time measurement and specified number of iterations
 
 ```
-$ php time sample.php -t=10000
+$ time php sample.php -t=10000
 ```
 
 If your system has debug assertions enabled it is recommended to turn them off. Just to give you an idea that debug assert are not free here is the execution time comparison
@@ -50,11 +43,3 @@ If your system has debug assertions enabled it is recommended to turn them off.
 |---------------------|--------------------------------------------------|--------------|
 |Enabled              |```$ php -d assert.active=1 sample.php -t=10000```|7.589s        |
 |Disabled             |```$ php -d assert.active=0 sample.php -t=10000```|2.884s        |
-
-The following command could be used for performance profiling with [blackfire.io](https://blackfire.io/)
-
-```
-$ blackfire --slot <slot number here> --samples 1 run php -d assert.active=0 sample.php -t=100
-```
-
-Are you in a mood to optimize performance? You can start from this [performance baseline profile](https://blackfire.io/profiles/a25af07b-b0c2-4a80-ae0b-8e64222b1e10/graph).

sample/README.md

@@ -16,6 +16,6 @@
     },
     "minimum-stability": "dev",
     "require": {
-        "neomerx/json-api": "0.3.0"
+        "neomerx/json-api": "0.4.0"
     }
 }

sample/composer.json

@@ -16,6 +16,7 @@
  * limitations under the License.
  */
 
+use \Neomerx\JsonApi\Schema\Link;
 use \Neomerx\JsonApi\Encoder\Encoder;
 use \Neomerx\JsonApi\Document\DocumentLinks;
 use \Neomerx\JsonApi\Encoder\JsonEncodeOptions;
@@ -85,7 +86,7 @@ private function showSparseAndFieldSetsExample()
         $site     = Site::instance('1', 'JSON API Samples', [$post]);
 
         $options  = new EncodingParameters(
-            ['posts.author'], // Paths to be included. Note neither 'posts' nor 'posts.comments' will be shown.
+            ['posts.author'], // Paths to be included. Note 'posts.comments' will not be shown.
             [
                 // Attributes and links that should be shown
                 'sites'  => ['name'],
@@ -120,10 +121,10 @@ private function showTopLevelMetaAndLinksExample()
         ];
         $links  = new DocumentLinks(
             null,
-            'http://example.com/people?first',
-            'http://example.com/people?last',
-            'http://example.com/people?prev',
-            'http://example.com/people?next'
+            new Link('http://example.com/people?first'),
+            new Link('http://example.com/people?last'),
+            new Link('http://example.com/people?prev'),
+            new Link('http://example.com/people?next')
         );
 
         $encoder  = Encoder::instance([
@@ -167,7 +168,7 @@ private function runPerformanceTest($iterations)
 
             $encoder->encode(
                 $site,
-                new DocumentLinks('http://example.com/sites/1?' . $rand),
+                new DocumentLinks(new Link('http://example.com/sites/1?' . $rand)),
                 ['some' => ['meta' => 'information' . $rand]],
                 $options
             );

sample/sample.php

@@ -42,7 +42,7 @@ public function getAttributes($comment)
         ];
     }
 
-    public function getLinks($comment)
+    public function getRelationships($comment)
     {
         /** @var Comment $comment */
         return [

sample/schemas/CommentSchema.php

@@ -41,7 +41,7 @@ public function getAttributes($post)
         ];
     }
 
-    public function getLinks($post)
+    public function getRelationships($post)
     {
         /** @var Post $post */
         return [

sample/schemas/PostSchema.php

@@ -40,7 +40,7 @@ public function getAttributes($site)
         ];
     }
 
-    public function getLinks($site)
+    public function getRelationships($site)
     {
         /** @var Site $site */
         return [