ilCertificateBackgroundImageFileService.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Filesystem\Filesystem;

class ilCertificateBackgroundImageFileService
{
    public const BACKGROUND_IMAGE_NAME = 'background.jpg';
    public const BACKGROUND_TEMPORARY_UPLOAD_FILE_NAME = 'background_upload_tmp';
    public const BACKGROUND_THUMBNAIL_FILE_ENDING = '.thumb.jpg';
    public const PLACEHOLDER_CLIENT_WEB_DIRECTORY = '[CLIENT_WEB_DIR]';
    public const VALID_BACKGROUND_IMAGE_EXTENSIONS = ['jpg', 'jpeg', 'gif', 'png'];

    private Filesystem $fileSystem;
    private string $certificatePath;
    private string $webDirectory;

    public function __construct(
        string $certificatePath,
        Filesystem $filesystem,
        string $webDirectory = CLIENT_WEB_DIR
    ) {
        $this->certificatePath = $certificatePath;
        $this->fileSystem = $filesystem;
        $this->webDirectory = $webDirectory;
    }

    public function hasBackgroundImage(ilCertificateTemplate $template): bool
    {
        $backgroundImagePath = $template->getBackgroundImagePath();
        if ($backgroundImagePath === '') {
            return false;
        }

        if ($this->fileSystem->has($backgroundImagePath)) {
            return true;
        }

        return false;
    }

    public function hasBackgroundImageThumbnail(ilCertificateTemplate $template): bool
    {
        $backgroundImagePath = $template->getThumbnailImagePath();
        if ($backgroundImagePath === '') {
            return false;
        }

        if ($this->fileSystem->has($backgroundImagePath)) {
            return true;
        }

        return false;
    }

    public function getBackgroundImageThumbPath(): string
    {
        return $this->webDirectory . $this->certificatePath . self::BACKGROUND_IMAGE_NAME . self::BACKGROUND_THUMBNAIL_FILE_ENDING;
    }

    public function getBackgroundImageDirectory(string $backgroundImagePath = ''): string
    {
        return str_replace(
            [$this->webDirectory, '//'],
            [self::PLACEHOLDER_CLIENT_WEB_DIRECTORY, '/'],
            $backgroundImagePath
        );
    }

    public function getBackgroundImageTempfilePath(string $extension): string
    {
        return implode('', [
            $this->webDirectory,
            $this->certificatePath,
            self::BACKGROUND_TEMPORARY_UPLOAD_FILE_NAME,
            '.' . $extension
        ]);
    }

    public function getValidBackgroundImageFileExtensions(): array
    {
        return self::VALID_BACKGROUND_IMAGE_EXTENSIONS;
    }
}