MDL-79675 libraries: upgrade lti1p3 to v6.0.0

Author: snake

lib/lti1p3/README.md

@@ -4,12 +4,10 @@ A library used for building IMS-certified LTI 1.3 tool providers in PHP.
 
 This library is a fork of the [packbackbooks/lti-1-3-php-library](https://github.com/packbackbooks/lti-1-3-php-library), patched specifically for use in [Moodle](https://github.com/moodle/moodle).
 
-It is currently based on version [5.4.1 of the packbackbooks/lti-1-3-php-library](https://github.com/packbackbooks/lti-1-3-php-library/releases/tag/v5.4.1) library.
+It is currently based on version [6.0.0 of the packbackbooks/lti-1-3-php-library](https://github.com/packbackbooks/lti-1-3-php-library/releases/tag/v6.0.0) library.
 
 The following changes are included so that the library may be used with Moodle:
 
   * Replace the phpseclib dependency with openssl equivalent call in public key generation code.
 
 Please see the original [README](https://github.com/packbackbooks/lti-1-3-php-library/blob/master/README.md) for more information about the upstream library.
-
-

lib/lti1p3/src/Concerns/Arrayable.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Packback\Lti1p3\Concerns;
+
+use Packback\Lti1p3\Helpers\Helpers;
+
+trait Arrayable
+{
+    abstract public function getArray(): array;
+
+    public function toArray(): array
+    {
+        return Helpers::filterOutNulls($this->getArray());
+    }
+}

lib/lti1p3/src/Concerns/JsonStringable.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Packback\Lti1p3\Concerns;
+
+trait JsonStringable
+{
+    use Arrayable;
+
+    public function __toString(): string
+    {
+        return json_encode($this->toArray());
+    }
+}

lib/lti1p3/src/DeepLinkResources/DateTimeInterval.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Packback\Lti1p3\DeepLinkResources;
+
+use DateTime;
+use Packback\Lti1p3\Concerns\Arrayable;
+use Packback\Lti1p3\LtiException;
+
+class DateTimeInterval
+{
+    use Arrayable;
+    public const ERROR_NO_START_OR_END = 'Either a start or end time must be specified.';
+    public const ERROR_START_GT_END = 'The start time cannot be greater than end time.';
+
+    public function __construct(
+        private ?DateTime $start = null,
+        private ?DateTime $end = null
+    ) {
+        $this->validateStartAndEnd();
+    }
+
+    public static function new(): self
+    {
+        return new DateTimeInterval();
+    }
+
+    public function getArray(): array
+    {
+        if (!isset($this->start) && !isset($this->end)) {
+            throw new LtiException(self::ERROR_NO_START_OR_END);
+        }
+
+        $this->validateStartAndEnd();
+
+        return [
+            'startDateTime' => $this->start?->format(DateTime::ATOM),
+            'endDateTime' => $this->end?->format(DateTime::ATOM),
+        ];
+    }
+
+    public function setStart(?DateTime $start): self
+    {
+        $this->start = $start;
+
+        return $this;
+    }
+
+    public function getStart(): ?DateTime
+    {
+        return $this->start;
+    }
+
+    public function setEnd(?DateTime $end): self
+    {
+        $this->end = $end;
+
+        return $this;
+    }
+
+    public function getEnd(): ?DateTime
+    {
+        return $this->end;
+    }
+
+    /**
+     * @throws LtiException
+     */
+    private function validateStartAndEnd(): void
+    {
+        if (isset($this->start) && isset($this->end) && $this->start > $this->end) {
+            throw new LtiException(self::ERROR_START_GT_END);
+        }
+    }
+}

lib/lti1p3/src/DeepLinkResources/HasDimensions.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Packback\Lti1p3\DeepLinkResources;
+
+trait HasDimensions
+{
+    public function setWidth(?int $width): self
+    {
+        $this->width = $width;
+
+        return $this;
+    }
+
+    public function getWidth(): ?int
+    {
+        return $this->width;
+    }
+
+    public function setHeight(?int $height): self
+    {
+        $this->height = $height;
+
+        return $this;
+    }
+
+    public function getHeight(): ?int
+    {
+        return $this->height;
+    }
+}

lib/lti1p3/src/DeepLinkResources/Icon.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Packback\Lti1p3\DeepLinkResources;
+
+use Packback\Lti1p3\Concerns\Arrayable;
+
+class Icon
+{
+    use Arrayable, HasDimensions;
+
+    public function __construct(
+        private string $url,
+        private int $width,
+        private int $height
+    ) {
+    }
+
+    public static function new(string $url, int $width, int $height): self
+    {
+        return new Icon($url, $width, $height);
+    }
+
+    public function getArray(): array
+    {
+        return [
+            'url' => $this->url,
+            'width' => $this->width,
+            'height' => $this->height,
+        ];
+    }
+
+    public function setUrl(string $url): self
+    {
+        $this->url = $url;
+
+        return $this;
+    }
+
+    public function getUrl(): string
+    {
+        return $this->url;
+    }
+}

lib/lti1p3/src/DeepLinkResources/Iframe.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Packback\Lti1p3\DeepLinkResources;
+
+use Packback\Lti1p3\Concerns\Arrayable;
+
+class Iframe
+{
+    use Arrayable, HasDimensions;
+
+    public function __construct(
+        private ?string $src = null,
+        private ?int $width = null,
+        private ?int $height = null
+    ) {
+    }
+
+    public static function new(): self
+    {
+        return new Iframe();
+    }
+
+    public function getArray(): array
+    {
+        return [
+            'width' => $this->width,
+            'height' => $this->height,
+            'src' => $this->src,
+        ];
+    }
+
+    public function setSrc(?string $src): self
+    {
+        $this->src = $src;
+
+        return $this;
+    }
+
+    public function getSrc(): ?string
+    {
+        return $this->src;
+    }
+}