ImageResource.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Imaging;
 
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Resource\File;
use ‪TYPO3\CMS\Core\Resource\ProcessedFile;
use TYPO3\CMS\Core\Type\File\ImageInfo;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
use ‪TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
 
class ImageResource
{
    public function __construct(
        protected int $width,
        protected int $height,
        protected string $extension,
        protected string $fullPath,
        protected ?string ‪$publicUrl = null,
        protected ?File $originalFile = null,
        protected ?ProcessedFile $processedFile = null
    ) {}
 
    public static function createFromImageInfo(ImageInfo $imageInfo): self
    {
        return new self(
            $imageInfo->getWidth(),
            $imageInfo->getHeight(),
            $imageInfo->getExtension(),
            $imageInfo->getRealPath(),
            ‪PathUtility::stripPathSitePrefix($imageInfo->getRealPath()),
        );
    }
 
    public static function createFromProcessedFile(ProcessedFile $processedFile): self
    {
        return new self(
            (int)$processedFile->getProperty('width'),
            (int)$processedFile->getProperty('height'),
            $processedFile->getExtension(),
            ‪Environment::getPublicPath() . '/' . $processedFile->getPublicUrl(),
            $processedFile->getPublicUrl(),
            $processedFile->getOriginalFile(),
            $processedFile
        );
    }
 
    public function getWidth(): int
    {
        return $this->width;
    }
 
    public function withWidth(int $width): self
    {
        $imageResource = clone $this;
        $imageResource->width = $width;
        return $imageResource;
    }
 
    public function getHeight(): int
    {
        return $this->height;
    }
 
    public function withHeight(int $height): self
    {
        $imageResource = clone $this;
        $imageResource->height = $height;
        return $imageResource;
    }
 
    public function getExtension(): string
    {
        return $this->extension;
    }
 
    public function withExtension(string $extension): self
    {
        $imageResource = clone $this;
        $imageResource->extension = $extension;
        return $imageResource;
    }
 
    public function getFullPath(): string
    {
        return $this->fullPath;
    }
 
    public function withFullPath(string $fullPath): self
    {
        $imageResource = clone $this;
        $imageResource->fullPath = $fullPath;
        return $imageResource;
    }
 
    public function getPublicUrl(): ?string
    {
        return ‪$this->publicUrl;
    }
 
    public function withPublicUrl(string ‪$publicUrl): self
    {
        $imageResource = clone $this;
        $imageResource->publicUrl = ‪$publicUrl;
        return $imageResource;
    }
 
    public function getOriginalFile(): ?File
    {
        return $this->originalFile;
    }
 
    public function withOriginalFile(?File $originalFile): self
    {
        $imageResource = clone $this;
        $imageResource->originalFile = $originalFile;
        return $imageResource;
    }
 
    public function getProcessedFile(): ?ProcessedFile
    {
        return $this->processedFile;
    }
 
    public function withProcessedFile(?ProcessedFile $processedFile): self
    {
        $imageResource = clone $this;
        $imageResource->processedFile = $processedFile;
        return $imageResource;
    }
 
    public function getLegacyImageResourceInformation(): array
    {
        return [
            0 => $this->width,
            1 => $this->height,
            2 => $this->extension,
            3 => $this->fullPath,
            'origFile' => ‪$this->publicUrl,
            'origFile_mtime' => $this->originalFile?->getModificationTime(),
        ];
    }
}