Skip to content

[BUGFIX] Fix the JSON API output with relationships #927

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: 7.x-2.x
Choose a base branch
from
Open

[BUGFIX] Fix the JSON API output with relationships #927

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32ad2d6
[BUGFIX] Fix the JSON API output with relationships
Jun 27, 2016
1023cac
[FEATURE] Imprive code readability
Jun 30, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 61 additions & 32 deletions src/Plugin/formatter/FormatterJsonApi.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,14 +318,15 @@ protected function renormalize(array $output, array &$included, $allowed_fields
if ($allowed_fields !== FALSE && !in_array($field_name, $allowed_fields)) {
continue;
}
if (empty($field_contents['#embedded'])) {
if (!isset($field_contents['#embedded'])) {
$result['attributes'][$field_name] = $field_contents;
}
else {
// Handle single and multiple relationships.
$rel = array();
$single_item = $field_contents['#cardinality'] == 1;
$relationship_links = empty($field_contents['#relationship_links']) ? NULL : $field_contents['#relationship_links'];
$is_embedded = $field_contents['#embedded'];
unset($field_contents['#embedded']);
unset($field_contents['#cardinality']);
unset($field_contents['#relationship_links']);
Expand All @@ -338,25 +339,32 @@ protected function renormalize(array $output, array &$included, $allowed_fields
$element = $field_item['#relationship_info'];
unset($field_item['#relationship_info']);
$include_key = $field_item['#resource_plugin'] . '--' . $field_item['#resource_id'];
$nested_allowed_fields = $this->unprefixInputOptions($allowed_fields, $field_name);
// If the list of the child allowed fields is empty, but the parent is
// part of the includes, it means that the consumer meant to include
// all the fields in the children.
if (is_array($allowed_fields) && empty($nested_allowed_fields) && in_array($field_name, $allowed_fields)) {
$nested_allowed_fields = FALSE;
if ($is_embedded) {
$nested_allowed_fields = $this->unprefixInputOptions($allowed_fields, $field_name);
// If the list of the child allowed fields is empty, but the parent is
// part of the includes, it means that the consumer meant to include
// all the fields in the children.
if (is_array($allowed_fields) && empty($nested_allowed_fields) && in_array($field_name, $allowed_fields)) {
$nested_allowed_fields = FALSE;
}
// If we get here is because the relationship is included in the
// sparse fieldset. That means that in this context, empty field
// limits mean all the fields.
$new_includes_parents = $includes_parents;
$new_includes_parents[] = $field_name;
$included[$field_path][$include_key] = $this->renormalize($field_item, $included, $nested_allowed_fields, $new_includes_parents);
$included[$field_path][$include_key] += $include_links ? array('links' => $include_links) : array();
}
// If we get here is because the relationship is included in the
// sparse fieldset. That means that in this context, empty field
// limits mean all the fields.
$new_includes_parents = $includes_parents;
$new_includes_parents[] = $field_name;
$included[$field_path][$include_key] = $this->renormalize($field_item, $included, $nested_allowed_fields, $new_includes_parents);
$included[$field_path][$include_key] += $include_links ? array('links' => $include_links) : array();
$rel[$include_key] = $element;
}
// Only place the relationship info.
$data = $single_item ? reset($rel) : array_values($rel);
if ($single_item && empty($rel)) {
// We don't want $data to be FALSE, that is invalid JSON API.
$data = NULL;
}
$result['relationships'][$field_name] = array(
'data' => $single_item ? reset($rel) : array_values($rel),
'data' => $data,
);
if (!empty($relationship_links)) {
$result['relationships'][$field_name]['links'] = $relationship_links;
Expand Down Expand Up @@ -438,9 +446,11 @@ protected function embedField(ResourceFieldInterface $resource_field, $parent_id
}
$ids = $cardinality == 1 ? $ids = array($ids) : $ids;
$resource_info = $resource_field->getResource();
$is_embedded = !isset($resource_info['fullView']) || $resource_info['fullView'];
$empty_value = array(
'#fields' => array(),
'#embedded' => TRUE,
// Do not set the embedded flag if fullView is FALSE.
'#embedded' => $is_embedded,
'#resource_plugin' => sprintf('%s:%d.%d', $resource_info['name'], $resource_info['majorVersion'], $resource_info['minorVersion']),
'#cache_placeholder' => array(
'parents' => array_merge($parents, array($public_field_name)),
Expand All @@ -450,7 +460,8 @@ protected function embedField(ResourceFieldInterface $resource_field, $parent_id
$value = array_map(function ($id) use ($empty_value) {
return $empty_value + array('#resource_id' => $id);
}, $ids);
if ($this->needsIncluding($resource_field, $parents)) {

if ($is_embedded && $this->needsIncluding($resource_field, $parents)) {
$cid = sprintf('%s:%d.%d--%s', $resource_info['name'], $resource_info['majorVersion'], $resource_info['minorVersion'], implode(',', $ids));
if (!isset($embedded_resources[$cid])) {
$result = $resource_field->render($interpreter);
Expand All @@ -465,7 +476,7 @@ protected function embedField(ResourceFieldInterface $resource_field, $parent_id
}
$value = $embedded_resources[$cid];
}
// At this point we are dealing with an embed.

$value = array_filter($value);
// Set the resource for the reference.
$resource_plugin = $resource_field->getResourcePlugin();
Expand Down Expand Up @@ -493,21 +504,10 @@ protected function embedField(ResourceFieldInterface $resource_field, $parent_id
) + $value_item;
$output[] = $item;
}
// If there is a resource plugin for the parent, set the related
// links.
$links = array();
if ($resource = $this->getResource()) {
$links['related'] = $resource->versionedUrl('', array(
'absolute' => TRUE,
'query' => array(
'filter' => array($public_field_name => reset($ids)),
),
));
$links['self'] = $resource_plugin->versionedUrl($parent_id . '/relationships/' . $public_field_name);
}

return $output + array(
'#embedded' => TRUE,
$links = $this->buildRelationshipLinks($parent_id, $public_field_name, $resource_plugin, reset($ids));
return empty($output) ? array() : $output + array(
'#embedded' => $is_embedded,
'#cardinality' => $cardinality,
'#relationship_links' => $links,
);
Expand Down Expand Up @@ -738,4 +738,33 @@ protected static function retrieveIncludedItem($type, $id, array $included) {
return NULL;
}

/**
* Builds the relationship links.
*
* @param string $parent_id
* The ID of the host entity.
* @param string $public_field_name
* The name of the relationship.
* @param ResourceInterface $resource_plugin
* The resource plugin.
* @param string $identifier
* The ID of the target entity on the relationship.
*
* @return array
* The links.
*/
protected function buildRelationshipLinks($parent_id, $public_field_name, ResourceInterface $resource_plugin, $identifier) {
// If there is a resource plugin for the parent, set the related links.
if ($resource = $this->getResource()) {
return array();
}
return array(
'related' => $resource->versionedUrl('', array(
'absolute' => TRUE,
'query' => array('filter' => array($public_field_name => $identifier)),
)),
'self' => $resource_plugin->versionedUrl($parent_id . '/relationships/' . $public_field_name),
);
}

}