Skip to content
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

Close #123 #124

Merged
merged 1 commit into from
May 26, 2016
Merged

Close #123 #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 24 additions & 11 deletions src/PhlyRestfully/Plugin/HalLinks.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,10 +139,11 @@ public function setEventManager(EventManagerInterface $events)

$events->attach('getIdFromResource', function ($e) {
$resource = $e->getParam('resource');
$identifierName = $e->getParam('identifier_name', 'id');

// Found id in array
if (is_array($resource) && array_key_exists('id', $resource)) {
return $resource['id'];
if (is_array($resource) && array_key_exists($identifierName, $resource)) {
return $resource[$identifierName];
}

// No id in array, or not an object; return false
Expand All @@ -151,13 +152,15 @@ public function setEventManager(EventManagerInterface $events)
}

// Found public id property on object
if (isset($resource->id)) {
return $resource->id;
if (isset($resource->{$identifierName})) {
return $resource->{$identifierName};
}

$publicGetter = 'get' . ucfirst($identifierName);

// Found public id getter on object
if (method_exists($resource, 'getid')) {
return $resource->getId();
if (method_exists($resource, $publicGetter)) {
return $resource->{$publicGetter}();
}

// not found
Expand Down Expand Up @@ -578,7 +581,7 @@ public function createResource($resource, $route, $identifierName)
}

if (!$resource instanceof HalResource) {
$id = $this->getIdFromResource($resource);
$id = $this->getIdFromResource($resource, $identifierName);
if (!$id) {
return new ApiProblem(
422,
Expand Down Expand Up @@ -820,18 +823,21 @@ protected function extractCollection(HalCollection $halCollection)
}
}

$id = $this->getIdFromResource($resource);
$id = $this->getIdFromResource($resource, $identifierName);
if (!$id) {
// Cannot handle resources without an identifier
// Return as-is
$collection[] = $resource;
continue;
}



if ($eventParams['resource'] instanceof LinkCollectionAwareInterface) {
$links = $eventParams['resource']->getLinks();
} else {
$links = new LinkCollection();
var_dump($eventParams['route']);
}

$selfLink = new Link('self');
Expand All @@ -853,21 +859,28 @@ protected function extractCollection(HalCollection $halCollection)
/**
* Retrieve the identifier from a resource
*
* Expects an "id" member to exist; if not, a boolean false is returned.
* Expects an "id" or $identifierName member to exist; if not, a boolean false is returned.
*
* Triggers the "getIdFromResource" event with the resource; listeners can
* return a non-false, non-null value in order to specify the identifier
* to use for URL assembly.
*
* @param array|object $resource
* @param null|string $identifierName
* @return mixed|false
*/
protected function getIdFromResource($resource)
protected function getIdFromResource($resource, $identifierName = null)
{
$params = array('resource' => $resource);

if ($identifierName) {
$params['identifier_name'] = $identifierName;
}

$results = $this->getEventManager()->trigger(
__FUNCTION__,
$this,
array('resource' => $resource),
$params,
function ($r) {
return (null !== $r && false !== $r);
}
Expand Down
12 changes: 6 additions & 6 deletions test/PhlyRestfullyTest/ChildResourcesIntegrationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,8 +349,8 @@ public function testChildResourceObjectIdentiferMappingViaControllerReturn()
$resource = new Resource();
$resource->getEventManager()->attach('fetch', function ($e) {
return (object) array(
'id' => 'luke',
'name' => 'Luke Skywalker',
'child_id' => 'luke',
'name' => 'Luke Skywalker',
);
});
$controller = new ResourceController();
Expand Down Expand Up @@ -393,12 +393,12 @@ public function testChildResourceObjectIdentiferMappingInCollectionsViaControlle
$resource->getEventManager()->attach('fetchAll', function ($e) {
return array(
(object) array(
'id' => 'luke',
'name' => 'Luke Skywalker',
'child_id' => 'luke',
'name' => 'Luke Skywalker',
),
(object) array(
'id' => 'leia',
'name' => 'Leia Organa',
'child_id' => 'leia',
'name' => 'Leia Organa',
),
);
});
Expand Down
27 changes: 27 additions & 0 deletions test/PhlyRestfullyTest/Plugin/HalLinksTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,6 +435,33 @@ public function testRenderingCollectionRendersAllLinksInEmbeddedResources()
$this->assertRelationalLinkContains('/users/foo', 'self', $user);
$this->assertRelationalLinkContains('/users/foo/phones', 'phones', $user);
}

public function testRenderingCollectionRendersAllLinksInEmbeddedArrayResourcesWithCustomIdentifier()
{
$embedded = array('custom_id' => 'foo', 'name' => 'foo');

$collection = new HalCollection(array($embedded));
$collection->setCollectionName('embedded_custom');
$collection->setCollectionRoute('hostname/embedded_custom');
$collection->setResourceRoute('hostname/embedded_custom');
$collection->setIdentifierName('custom_id');
$self = new Link('self');
$self->setRoute('hostname/embedded_custom');
$collection->getLinks()->add($self);

$rendered = $this->plugin->renderCollection($collection);

$this->assertRelationalLinkContains('/embedded_custom', 'self', $rendered);
$this->assertArrayHasKey('_embedded', $rendered);
$this->assertInternalType('array', $rendered['_embedded']);
$this->assertArrayHasKey('embedded_custom', $rendered['_embedded']);

$embeddedCustoms = $rendered['_embedded']['embedded_custom'];
$this->assertInternalType('array', $embeddedCustoms);
$embeddedCustom = array_shift($embeddedCustoms);

$this->assertRelationalLinkContains('/embedded_custom/foo', 'self', $embeddedCustom);
}

public function testResourcesFromCollectionCanUseHydratorSetInMetadataMap()
{
Expand Down