Merge pull request #36 from tuyakhov/inclusion

Improve inclusion of related resources

Author: tuyakhov

src/Inflector.php

@@ -30,7 +30,7 @@ public static function var2member($var)
  */
  public static function member2var($member)
  {
- return str_replace(' ', '_', preg_replace('/[^A-Za-z0-9]+/', ' ', $member));
+ return str_replace(' ', '_', preg_replace('/[^A-Za-z0-9\.]+/', ' ', $member));
  }
 
  /**

src/ResourceInterface.php

@@ -19,10 +19,11 @@ public function getResourceAttributes(array $fields = []);
 
  /**
  * The "relationships" member of the resource object describing relationships between the resource and other JSON API resources.
+ * @param null|array $linked specific resource linkage that a client has requested.
  * @return ResourceIdentifierInterface[] represent references from the resource object in which it’s defined to other resource objects.
  */
- public function getResourceRelationships();
+ public function getResourceRelationships(array $linked = null);
 
  public function setResourceRelationship($name, $relationship);
 
-}
+}

src/ResourceTrait.php

@@ -51,19 +51,28 @@ public function getResourceAttributes(array $fields = [])
  }
 
  /**
+ * @param null|array $linked
  * @return array
  */
- public function getResourceRelationships()
+ public function getResourceRelationships(array $linked = null)
  {
- $relationships = [];
  $fields = [];
  if ($this instanceof Arrayable) {
  $fields = $this->extraFields();
  }
+ $resolvedFields = $this->resolveFields($fields);
+ $keys = array_keys($resolvedFields);
+ if ($linked === null) {
+ $linked = $keys;
+ }
+ $relationships = array_fill_keys($keys, null);
+ $linkedFields = array_intersect($keys, $linked);
 
- foreach ($this->resolveFields($fields) as $name => $definition) {
+ foreach ($linkedFields as $name) {
+ $definition = $resolvedFields[$name];
  $relationships[$name] = is_string($definition) ? $this->$definition : call_user_func($definition, $this, $name);
  }
+
  return $relationships;
  }
 

src/Serializer.php

@@ -105,7 +105,7 @@ public function serialize($data)
  * @param ResourceInterface $model
  * @return array
  */
- protected function serializeModel(ResourceInterface $model)
+ protected function serializeModel(ResourceInterface $model, array $included = null)
  {
  $fields = $this->getRequestedFields();
  $type = $this->pluralize ? Inflector::pluralize($model->getType()) : $model->getType();
@@ -118,8 +118,7 @@ protected function serializeModel(ResourceInterface $model)
  'attributes' => $attributes,
  ]);
 
- $included = $this->getIncluded();
- $relationships = $model->getResourceRelationships();
+ $relationships = $model->getResourceRelationships($included);
  if (!empty($relationships)) {
  foreach ($relationships as $name => $items) {
  $relationship = [];
@@ -132,17 +131,15 @@ protected function serializeModel(ResourceInterface $model)
  } elseif ($items instanceof ResourceIdentifierInterface) {
  $relationship = $this->serializeIdentifier($items);
  }
+ $memberName = $this->prepareMemberNames([$name]);
+ $memberName = reset($memberName);
  if (!empty($relationship)) {
- $memberName = $this->prepareMemberNames([$name]);
- $memberName = reset($memberName);
- if (in_array($name, $included)) {
- $data['relationships'][$memberName]['data'] = $relationship;
- }
- if ($model instanceof LinksInterface) {
- $links = $model->getRelationshipLinks($memberName);
- if (!empty($links)) {
- $data['relationships'][$memberName]['links'] = Link::serialize($links);
- }
+ $data['relationships'][$memberName]['data'] = $relationship;
+ }
+ if ($model instanceof LinksInterface) {
+ $links = $model->getRelationshipLinks($memberName);
+ if (!empty($links)) {
+ $data['relationships'][$memberName]['links'] = Link::serialize($links);
  }
  }
  }
@@ -164,11 +161,24 @@ protected function serializeResource(ResourceInterface $resource)
  if ($this->request->getIsHead()) {
  return null;
  } else {
- $data = ['data' => $this->serializeModel($resource)];
+ $included = $topLevel = $this->getIncluded();
+
+ if ($included !== null) {
+ $topLevel = array_map(function($item) {
+ if (($pos = strrpos($item, '.')) !== false) {
+ return substr($item, 0, $pos);
+ }
+ return $item;
+ }, $included);
+ }
+
+ $data = [
+ 'data' => $this->serializeModel($resource, $topLevel)
+ ];
 
- $included = $this->serializeIncluded($resource);
- if (!empty($included)) {
- $data['included'] = $included;
+ $relatedResources = $this->serializeIncluded($resource, $included);
+ if (!empty($relatedResources)) {
+ $data['included'] = $relatedResources;
  }
 
  return $data;
@@ -200,21 +210,39 @@ protected function serializeIdentifier(ResourceIdentifierInterface $identifier)
 
  /**
  * @param ResourceInterface|array $resources
+ * @param null|array $included
  * @return array
  */
- protected function serializeIncluded($resources)
+ protected function serializeIncluded($resources, array $included = null)
  {
- $included = $this->getIncluded();
  $resources = is_array($resources) ? $resources : [$resources];
  $data = [];
 
+ if ($included === null) {
+ return [];
+ }
+
+ $inclusion = [];
+ $linked = [];
+ foreach ($included as $path) {
+ if (($pos = strrpos($path, '.')) === false) {
+ $linked[] = $path;
+ $inclusion[$path] = [];
+ continue;
+ }
+ $name = substr($path, $pos + 1);
+ $key = substr($path, 0, $pos);
+ $inclusion[$key][] = $name;
+ $linked[] = $key;
+ }
+
  foreach ($resources as $resource) {
  if (!$resource instanceof ResourceInterface) {
  continue;
  }
- $relationships = $resource->getResourceRelationships();
+ $relationships = $resource->getResourceRelationships($linked);
  foreach ($relationships as $name => $relationship) {
- if (!in_array($name, $included)) {
+ if ($relationship === null) {
  continue;
  }
  if (!is_array($relationship)) {
@@ -223,7 +251,10 @@ protected function serializeIncluded($resources)
  foreach ($relationship as $model) {
  if ($model instanceof ResourceInterface) {
  $uniqueKey = $model->getType() . '/' . $model->getId();
- $data[$uniqueKey] = $this->serializeModel($model);
+ $data[$uniqueKey] = $this->serializeModel($model, $inclusion[$name]);
+ if (!empty($inclusion[$name])) {
+ $data = array_merge($data, $this->serializeIncluded($model, $inclusion[$name]));
+ }
  }
  }
  }
@@ -235,7 +266,7 @@ protected function serializeIncluded($resources)
  /**
  * Serializes a data provider.
  * @param DataProviderInterface $dataProvider
- * @return array the array representation of the data provider.
+ * @return null|array the array representation of the data provider.
  */
  protected function serializeDataProvider($dataProvider)
  {
@@ -245,17 +276,18 @@ protected function serializeDataProvider($dataProvider)
  $models = $dataProvider->getModels();
  $data = [];
 
+ $included = $this->getIncluded();
  foreach ($models as $model) {
  if ($model instanceof ResourceInterface) {
- $data[] = $this->serializeModel($model);
+ $data[] = $this->serializeModel($model, $included);
  }
  }
 
  $result = ['data' => $data];
 
- $included = $this->serializeIncluded($models);
- if (!empty($included)) {
- $result['included'] = $included;
+ $relatedResources = $this->serializeIncluded($models, $included);
+ if (!empty($relatedResources)) {
+ $result['included'] = $relatedResources;
  }
 
  if (($pagination = $dataProvider->getPagination()) !== false) {
@@ -321,9 +353,15 @@ protected function getRequestedFields()
  return $fields;
  }
 
+ /**
+ * @return array|null
+ */
  protected function getIncluded()
  {
  $include = $this->request->get($this->expandParam);
+ if (!$this->request->isGet) {
+ return null;
+ }
  return is_string($include) ? array_map($this->formatMemberName, preg_split('/\s*,\s*/', $include, -1, PREG_SPLIT_NO_EMPTY)) : [];
  }