Merge pull request #6313 from WoltLab/6.2-file-cover-photos

Cover photos based on file uploads

Author: BurntimeX

wcfsetup/install/files/lib/system/image/cover/photo/CoverPhotoImage.class.php

@@ -11,6 +11,7 @@
  * @copyright   2001-2019 WoltLab GmbH
  * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @since       5.2
+ * @deprecated  6.2 Use `ICoverPhoto` instead.
  */
 class CoverPhotoImage
 {

wcfsetup/install/files/lib/system/image/cover/photo/DefaultCoverPhoto.class.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace wcf\system\image\cover\photo;
+
+use wcf\system\style\StyleHandler;
+
+/**
+ * Represents the default cover photo as defined in the style configuration.
+ *
+ * @author      Marcel Werk
+ * @copyright   2001-2025 WoltLab GmbH
+ * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since       6.2
+ */
+final class DefaultCoverPhoto implements ICoverPhoto
+{
+    private static DefaultCoverPhoto $defaultCoverPhoto;
+
+    /**
+     * @var array{height: int, width: int}
+     */
+    private array $dimensions;
+
+    private function __construct() {}
+
+    #[\Override]
+    public function getUrl(?string $size = null): string
+    {
+        return StyleHandler::getInstance()->getStyle()->getCoverPhotoUrl();
+    }
+
+    #[\Override]
+    public function getWidth(?string $size = null): int
+    {
+        return $this->getDimensions()['width'];
+    }
+
+    #[\Override]
+    public function getHeight(?string $size = null): int
+    {
+        return $this->getDimensions()['height'];
+    }
+
+    /**
+     * @return array{height: int, width: int}
+     */
+    private function getDimensions(): array
+    {
+        if (!isset($this->dimensions)) {
+            $this->dimensions = ['height' => 0, 'width' => 0];
+            $dimensions = @\getimagesize(
+                StyleHandler::getInstance()->getStyle()->getCoverPhotoLocation()
+            );
+            if (\is_array($dimensions)) {
+                $this->dimensions['width'] = $dimensions[0];
+                $this->dimensions['height'] = $dimensions[1];
+            }
+        }
+
+        return $this->dimensions;
+    }
+
+    public static function getDefaultCoverPhoto(): self
+    {
+        if (!isset(self::$defaultCoverPhoto)) {
+            self::$defaultCoverPhoto = new self();
+        }
+
+        return self::$defaultCoverPhoto;
+    }
+}

wcfsetup/install/files/lib/system/image/cover/photo/FileCoverPhoto.class.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace wcf\system\image\cover\photo;
+
+use wcf\data\file\File;
+
+/**
+ * Represents a cover photo that is based on a file upload.
+ *
+ * @author      Marcel Werk
+ * @copyright   2001-2025 WoltLab GmbH
+ * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since       6.2
+ */
+final class FileCoverPhoto implements ICoverPhoto
+{
+    public function __construct(private readonly File $file) {}
+
+    #[\Override]
+    public function getUrl(?string $size = null): string
+    {
+        if ($size !== null) {
+            $thumbnail = $this->file->getThumbnail($size);
+            if ($thumbnail !== null) {
+                return $thumbnail->getLink();
+            }
+        }
+
+        return $this->file->getFullSizeImageSource() ?: $this->file->getLink();
+    }
+
+    #[\Override]
+    public function getWidth(?string $size = null): int
+    {
+        if ($size !== null) {
+            $thumbnail = $this->file->getThumbnail($size);
+            if ($thumbnail !== null) {
+                return $thumbnail->width;
+            }
+        }
+
+        return $this->file->width;
+    }
+
+    #[\Override]
+    public function getHeight(?string $size = null): int
+    {
+        if ($size !== null) {
+            $thumbnail = $this->file->getThumbnail($size);
+            if ($thumbnail !== null) {
+                return $thumbnail->height;
+            }
+        }
+
+        return $this->file->height;
+    }
+}

wcfsetup/install/files/lib/system/image/cover/photo/ICoverPhoto.class.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace wcf\system\image\cover\photo;
+
+/**
+ * Default interface for cover photos that support mulitple sizes.
+ *
+ * @author      Marcel Werk
+ * @copyright   2001-2025 WoltLab GmbH
+ * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since       6.2
+ */
+interface ICoverPhoto
+{
+    public function getUrl(?string $size = null): string;
+
+    public function getWidth(?string $size = null): int;
+
+    public function getHeight(?string $size = null): int;
+}

wcfsetup/install/files/lib/system/image/cover/photo/ICoverPhotoImage.class.php

@@ -9,6 +9,7 @@
  * @copyright   2001-2019 WoltLab GmbH
  * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @since       5.2
+ * @deprecated  6.2 Use `ICoverPhoto` instead.
  */
 interface ICoverPhotoImage
 {