Merge pull request #102 from spatie/ft-ld-json-id

serialize identifier to ld+json @id
spatie · Sep 26, 2019 · 5ede7ed · 5ede7ed
2 parents e7f5288 + 01dc3ac
commit 5ede7ed
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 0 deletions.
diff --git a/generator/templates/static/BaseType.php b/generator/templates/static/BaseType.php
@@ -81,6 +81,7 @@ public function offsetUnset($offset)
 
  public function toArray(): array
  {
+ $this->serializeIdentifier();
  $properties = $this->serializeProperty($this->getProperties());
 
  return [
@@ -115,6 +116,14 @@ protected function serializeProperty($property)
  return $property;
  }
 
+ protected function serializeIdentifier()
+ {
+ if (isset($this['identifier'])) {
+ $this->setProperty('@id', $this['identifier']);
+ unset($this['identifier']);
+ }
+ }
+
  public function toScript(): string
  {
  return '<script type="application/ld+json">'.json_encode($this->toArray(), JSON_UNESCAPED_UNICODE).'</script>';

diff --git a/src/BaseType.php b/src/BaseType.php
@@ -81,6 +81,7 @@ public function offsetUnset($offset)
 
  public function toArray(): array
  {
+ $this->serializeIdentifier();
  $properties = $this->serializeProperty($this->getProperties());
 
  return [
@@ -115,6 +116,14 @@ protected function serializeProperty($property)
  return $property;
  }
 
+ protected function serializeIdentifier()
+ {
+ if (isset($this['identifier'])) {
+ $this->setProperty('@id', $this['identifier']);
+ unset($this['identifier']);
+ }
+ }
+
  public function toScript(): string
  {
  return '<script type="application/ld+json">'.json_encode($this->toArray(), JSON_UNESCAPED_UNICODE).'</script>';

diff --git a/tests/BaseTypeTest.php b/tests/BaseTypeTest.php
@@ -308,6 +308,22 @@ public function it_can_be_casted_to_string()
 
  $this->assertEquals($expected, (string) $type);
  }
+
+ /** @test */
+ public function it_replaces_identifier_with_at_id_property()
+ {
+ $type = new DummyType();
+
+ $type->setProperty('identifier', 'object#1');
+
+ $expected = [
+ '@context' => 'https://schema.org',
+ '@type' => 'DummyType',
+ '@id' => 'object#1',
+ ];
+
+ $this->assertEquals($expected, $type->toArray());
+ }
 }
 
 class DummyType extends BaseType