Merge pull request nilportugues#75 from nilportugues/getRequiredFields

Mapping now has required properties to be used in the server.

Author: nilportugues

README.md

@@ -122,6 +122,14 @@ class PostMapping  implements JsonApiMapping
             ]
         ];
     }
+    
+    /**
+     * {@inheritdoc}
+     */
+    public function getRequiredProperties()
+    {
+        return ['author', 'title', 'body'];
+    }
 }
 ```
 
@@ -188,6 +196,14 @@ class PostIdMapping implements JsonApiMapping
             ],
         ];
     }
+    
+    /**
+     * {@inheritdoc}
+     */
+    public function getRequiredProperties()
+    {
+        return [];
+    }
 }
 ```
 
@@ -243,7 +259,15 @@ class UserMapping implements JsonApiMapping
             'friends' => 'http://example.com/users/{userId}/friends',
             'comments' => 'http://example.com/users/{userId}/comments',
         ];
-    }
+    }    
+   
+    /**
+     * {@inheritdoc}
+     */
+    public function getRequiredProperties()
+    {
+        return [];
+    }    
 }
 ```
 
@@ -285,7 +309,7 @@ class UserIdMapping implements JsonApiMapping
      * {@inheritdoc}
      */
     public function getIdProperties()
-        return [ 'userId',];
+        return ['userId'];
     }
     /**
      * {@inheritdoc}
@@ -298,6 +322,14 @@ class UserIdMapping implements JsonApiMapping
             'comments' => 'http://example.com/users/{userId}/comments',
         ];
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getRequiredProperties()
+    {
+        return [];
+    }        
 }
 ```
 
@@ -362,6 +394,14 @@ class CommendMapping implements JsonApiMapping
             ]
         ];
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getRequiredProperties()
+    {
+        return [];
+    }        
 }
 ```
 
@@ -425,6 +465,14 @@ class CommentId implements JsonApiMapping
             ]
         ];
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getRequiredProperties()
+    {
+        return [];
+    }        
 }
 ```
 

composer.json

@@ -14,7 +14,7 @@
     ],
     "require": {
         "php": ">=5.5.0",
-        "nilportugues/api-transformer": "^1.6",
+        "nilportugues/api-transformer": "^3.0.0",
         "symfony/psr-http-message-bridge" : "0.2"
     },
     "require-dev": {

src/Server/Data/DataObject.php

@@ -90,10 +90,11 @@ protected static function missingCreationAttributes(array $data, JsonApiSerializ
 
         $diff = [];
         if (null !== $mapping) {
+            $required = $mapping->getRequiredProperties();
             $properties = str_replace(
                 array_keys($mapping->getAliasedProperties()),
                 array_values($mapping->getAliasedProperties()),
-                $mapping->getProperties()
+                !empty($required) ? $required : $mapping->getProperties()
             );
             $properties = array_diff($properties, $mapping->getIdProperties());
 

tests/Integrations/Doctrine/Mappings/CommentMapping.php

@@ -61,4 +61,11 @@ public function getRelationships()
     {
         return [];
     }
+    /**
+     * {@inheritdoc}
+     */
+    public function getRequiredProperties()
+    {
+        return [];
+    }
 }

tests/Integrations/Doctrine/Mappings/CustomerMapping.php

@@ -61,4 +61,12 @@ public function getRelationships()
     {
         return [];
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getRequiredProperties()
+    {
+        return [];
+    }
 }

tests/Integrations/Doctrine/Mappings/PostMapping.php

@@ -61,4 +61,12 @@ public function getRelationships()
     {
         return [];
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getRequiredProperties()
+    {
+        return [];
+    }
 }