add edlibVersionId lti-dl extension

Author: emmachughes

src/Lti/Edlib/DeepLinking/EdlibContentItemMapper.php

@@ -32,6 +32,7 @@ public function map(array $data): ContentItem
                 url: $item->getUrl(),
                 custom: $item->getCustom(),
             ))
+                ->withEdlibVersionId(Prop::getOfType($data, 'edlibVersionId', Prop::TYPE_NORMALIZED_STRING))
                 ->withLanguageIso639_3(Prop::getOfType($data, 'languageIso639_3', Prop::TYPE_NORMALIZED_STRING))
                 ->withLicense(Prop::getOfType($data, 'license', Prop::TYPE_NORMALIZED_STRING))
                 ->withPublished(Prop::getOfType($data, 'published', Prop::TYPE_BOOLEAN))

src/Lti/Edlib/DeepLinking/EdlibContentItemsSerializer.php

@@ -12,6 +12,10 @@
     private const CONTEXT = [
         'edlib' => 'https://spec.edlib.com/lti/vocab#',
         'xs' => 'http://www.w3.org/2001/XMLSchema#',
+        'edlibVersionId' => [
+            '@id' => 'edlib:edlibVersionId',
+            '@type' => 'xs:normalizedString',
+        ],
         'languageIso639_3' => [
             '@id' => 'edlib:languageIso639_3',
             '@type' => 'xs:normalizedString',

src/Lti/Edlib/DeepLinking/EdlibLtiLinkItem.php

@@ -10,6 +10,8 @@
 
 class EdlibLtiLinkItem extends LtiLinkItem
 {
+    private string|null $edlibVersionId = null;
+
     private string|null $languageIso639_3 = null;
 
     private string|null $license = null;
@@ -23,6 +25,19 @@ class EdlibLtiLinkItem extends LtiLinkItem
      */
     private array $tags = [];
 
+    public function getEdlibVersionId(): string|null
+    {
+        return $this->edlibVersionId;
+    }
+
+    public function withEdlibVersionId(string|null $edlibVersionId): static
+    {
+        $self = clone $this;
+        $self->edlibVersionId = $edlibVersionId;
+
+        return $self;
+    }
+
     public function getLanguageIso639_3(): string|null
     {
         return $this->languageIso639_3;

src/Lti/Edlib/DeepLinking/EdlibLtiLinkItemSerializer.php

@@ -20,6 +20,10 @@ public function serialize(LtiLinkItem $item): array
         $serialized = $this->serializer->serialize($item);
 
         if ($item instanceof EdlibLtiLinkItem) {
+            if ($item->getEdlibVersionId() !== null) {
+                $serialized['edlibVersionId'] = $item->getEdlibVersionId();
+            }
+
             if ($item->getLicense() !== null) {
                 $serialized['license'] = $item->getLicense();
             }

tests/Lti/Edlib/EdlibContentItemMapperTest.php

@@ -28,6 +28,7 @@ public function testMapsEdlibExtensions(): void
                     'mediaType' => 'application/vnd.ims.lti.v1.ltilink',
                     'title' => 'My Cool LTI Content',
                     'url' => 'https://example.com/my-lti-content',
+                    'edlibVersionId' => '9876543210',
                     'languageIso639_3' => 'eng',
                     'license' => 'MIT',
                     'published' => true,
@@ -41,6 +42,7 @@ public function testMapsEdlibExtensions(): void
         $this->assertArrayHasKey(0, $items);
         $this->assertInstanceOf(EdlibLtiLinkItem::class, $items[0]);
         $this->assertSame('My Cool LTI Content', $items[0]->getTitle());
+        $this->assertSame('9876543210', $items[0]->getEdlibVersionId());
         $this->assertSame('eng', $items[0]->getLanguageIso639_3());
         $this->assertSame('MIT', $items[0]->getLicense());
         $this->assertFalse($items[0]->isShared());

tests/Lti/Edlib/EdlibContentItemsSerializerTest.php

@@ -19,6 +19,7 @@ public function testAddsJsonldContextAndSerializesEdlibExtensions(): void
     {
         $data = $this->serializer->serialize([
             (new EdlibLtiLinkItem(title: 'Foo'))
+                ->withEdlibVersionId('1234567890')
                 ->withLanguageIso639_3('eng')
                 ->withLicense('MIT')
                 ->withPublished(false)
@@ -41,6 +42,9 @@ public function testAddsJsonldContextAndSerializesEdlibExtensions(): void
         $this->assertArrayHasKey(0, $data['@graph']);
         $this->assertIsArray($data['@graph'][0]);
 
+        $this->assertArrayHasKey('edlibVersionId', $data['@graph'][0]);
+        $this->assertSame('1234567890', $data['@graph'][0]['edlibVersionId']);
+
         $this->assertArrayHasKey('languageIso639_3', $data['@graph'][0]);
         $this->assertSame('eng', $data['@graph'][0]['languageIso639_3']);