use data object for image preview

Author: sualko

src/Core/ImagePreview.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of littleredbutton/bigbluebutton-api-php.
+ *
+ * littleredbutton/bigbluebutton-api-php is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * littleredbutton/bigbluebutton-api-php is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with littleredbutton/bigbluebutton-api-php. If not, see <http://www.gnu.org/licenses/>.
+ */
+namespace BigBlueButton\Core;
+
+class ImagePreview
+{
+    /** @var int */
+    private $width;
+
+    /** @var int */
+    private $height;
+
+    /** @var string */
+    private $alt;
+
+    /** @var string */
+    private $url;
+
+    public function __construct(int $width, int $height, string $alt, string $url)
+    {
+        $this->width  = $width;
+        $this->height = $height;
+        $this->alt    = $alt;
+        $this->url    = $url;
+    }
+
+    public function getWidth(): int
+    {
+        return $this->width;
+    }
+
+    public function getHeight(): int
+    {
+        return $this->height;
+    }
+
+    public function getAlt(): string
+    {
+        return $this->alt;
+    }
+
+    public function getUrl(): string
+    {
+        return $this->url;
+    }
+}

src/Core/PlaybackFormat.php

@@ -35,7 +35,7 @@ class PlaybackFormat
     /** @var int */
     private $length;
 
-    /** @var array */
+    /** @var ImagePreview[] */
     private $imagePreviews;
 
     /** @var \SimpleXMLElement */
@@ -78,7 +78,7 @@ public function hasImagePreviews(): bool
 
     /**
      *
-     * @return array<int, array{width: int, height: int, alt: string, url: string}>
+     * @return ImagePreview[]
      */
     public function getImagePreviews(): array
     {
@@ -91,12 +91,12 @@ public function getImagePreviews(): array
             foreach ($this->imagePreviewsRaw->children() as $image) {
                 $attributes = $image->attributes();
 
-                $this->imagePreviews[] = [
-                    'width'  => (int) $attributes->width->__toString(),
-                    'height' => (int) $attributes->height->__toString(),
-                    'alt'    => $attributes->alt->__toString(),
-                    'url'    => $image->__toString(),
-                ];
+                $this->imagePreviews[] = new ImagePreview(
+                    (int) $attributes->width->__toString(),
+                    (int) $attributes->height->__toString(),
+                    $attributes->alt->__toString(),
+                    $image->__toString()
+                );
             }
         }
 

tests/unit/Responses/GetRecordingsResponseTest.php

@@ -112,7 +112,7 @@ public function testImagePreviews()
 
         $this->assertCount(3, $previews);
 
-        $this->assertEquals('Welcome to', $previews[0]['alt']);
-        $this->assertEquals('https://demo.bigbluebutton.org/presentation/ffbfc4cc24428694e8b53a4e144f414052431693-1530718721124/presentation/d2d9a672040fbde2a47a10bf6c37b6a4b5ae187f-1530718721134/thumbnails/thumb-1.png', $previews[0]['url']);
+        $this->assertEquals('Welcome to', $previews[0]->getAlt());
+        $this->assertEquals('https://demo.bigbluebutton.org/presentation/ffbfc4cc24428694e8b53a4e144f414052431693-1530718721124/presentation/d2d9a672040fbde2a47a10bf6c37b6a4b5ae187f-1530718721134/thumbnails/thumb-1.png', $previews[0]->getUrl());
     }
 }