Collaboration diagram for ilCertificateBackgroundImageUpload:

Public Member Functions
	__construct (private readonly FileUpload $fileUpload, private readonly string $certificatePath, private readonly ilLanguage $language, private readonly string $rootDirectory=CLIENT_WEB_DIR, private readonly string $clientId=CLIENT_ID, ?Filesystem $fileSystem=null, ?ilCertificateUtilHelper $utilHelper=null, ?ilCertificateFileUtilsHelper $certificateFileUtilsHelper=null, ?LegacyPathHelperHelper $legacyPathHelper=null, ?Filesystem $tmp_file_system=null)

	uploadBackgroundImage (string $imageTempFilename, int $version, ?array $pending_file=null)
	Uploads a background image for the certificate. More...

Private Member Functions
	uploadFile (string $temporaryFilename, ?array $pending_file=null)

	getTargetFilesystem (string $target)

	getTargetDir (string $target)

	createBackgroundImageTempfilePath (string $extension)
	Returns the filesystem path of the background image temp file during upload. More...

	createBackgroundImageThumbPath ()
	Returns the filesystem path of the background image thumbnail. More...

Private Attributes
const	BACKGROUND_IMAGE_NAME = 'background.jpg'

const	BACKGROUND_THUMBNAIL_IMAGE_NAME = 'background.jpg.thumb.jpg'

const	BACKGROUND_TEMPORARY_FILENAME = 'background_upload_tmp'

readonly Filesystem	$fileSystem

readonly ilCertificateUtilHelper	$utilHelper

readonly ilCertificateFileUtilsHelper	$fileUtilsHelper

readonly LegacyPathHelperHelper	$legacyPathHelper

readonly Filesystem	$tmp_file_system

Detailed Description

Author: Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de

Definition at line 31 of file class.ilCertificateBackgroundImageUpload.php.

Constructor & Destructor Documentation

◆ __construct()

ilCertificateBackgroundImageUpload::__construct	(	private readonly FileUpload	$fileUpload,
		private readonly string	$certificatePath,
		private readonly ilLanguage	$language,
		private readonly string	$rootDirectory = `CLIENT_WEB_DIR`,
		private readonly string	$clientId = `CLIENT_ID`,
		?Filesystem	$fileSystem = `null`,
		?ilCertificateUtilHelper	$utilHelper = `null`,
		?ilCertificateFileUtilsHelper	$certificateFileUtilsHelper = `null`,
		?LegacyPathHelperHelper	$legacyPathHelper = `null`,
		?Filesystem	$tmp_file_system = `null`
	)

Definition at line 42 of file class.ilCertificateBackgroundImageUpload.php.

References $DIC, $fileSystem, $legacyPathHelper, $tmp_file_system, and $utilHelper.

       {
         if (null === $fileSystem) {
             global $DIC;
             $fileSystem = $DIC->filesystem()->web();
         }
         $this->fileSystem = $fileSystem;
 
         if (null === $utilHelper) {
             $utilHelper = new ilCertificateUtilHelper();
         }
         $this->utilHelper = $utilHelper;
 
         if (null === $certificateFileUtilsHelper) {
             $certificateFileUtilsHelper = new ilCertificateFileUtilsHelper();
         }
         $this->fileUtilsHelper = $certificateFileUtilsHelper;
 
         if (null === $legacyPathHelper) {
             $legacyPathHelper = new LegacyPathHelperHelper();
         }
         $this->legacyPathHelper = $legacyPathHelper;
 
         if (null === $tmp_file_system) {
             global $DIC;
             $tmp_file_system = $DIC->filesystem()->temp();
         }
         $this->tmp_file_system = $tmp_file_system;
     }

Member Function Documentation

◆ createBackgroundImageTempfilePath()

ilCertificateBackgroundImageUpload::createBackgroundImageTempfilePath ( string $extension )

private

Returns the filesystem path of the background image temp file during upload.

Returns: string The filesystem path of the background image temp file

Definition at line 227 of file class.ilCertificateBackgroundImageUpload.php.

Referenced by uploadFile().

                                                                          : string
     {
         return implode('', [
             $this->rootDirectory,
             $this->certificatePath,
             self::BACKGROUND_TEMPORARY_FILENAME,
             '.' . $extension
         ]);
     }

Here is the caller graph for this function:

◆ createBackgroundImageThumbPath()

ilCertificateBackgroundImageUpload::createBackgroundImageThumbPath ( )

private

Returns the filesystem path of the background image thumbnail.

Returns: string The filesystem path of the background image thumbnail

Definition at line 241 of file class.ilCertificateBackgroundImageUpload.php.

Referenced by uploadBackgroundImage().

                                                      : string
     {
         return $this->rootDirectory . $this->certificatePath . self::BACKGROUND_THUMBNAIL_IMAGE_NAME;
     }

Here is the caller graph for this function:

◆ getTargetDir()

ilCertificateBackgroundImageUpload::getTargetDir ( string $target )

private

Definition at line 217 of file class.ilCertificateBackgroundImageUpload.php.

Referenced by uploadFile().

                                                  : string
     {
         $absTargetDir = dirname($target);
         return $this->legacyPathHelper->createRelativePath($absTargetDir);
     }

Here is the caller graph for this function:

◆ getTargetFilesystem()

ilCertificateBackgroundImageUpload::getTargetFilesystem ( string $target )

private

Definition at line 201 of file class.ilCertificateBackgroundImageUpload.php.

References CLIENT_DATA_DIR.

Referenced by uploadFile().

                                                         : int
     {
         return match (true) {
             str_starts_with($target, $this->rootDirectory . '/' . $this->clientId), str_starts_with(
                 $target,
                 './' . $this->rootDirectory . '/' . $this->clientId
             ), str_starts_with($target, $this->rootDirectory) => Location::WEB,
             str_starts_with($target, CLIENT_DATA_DIR . "/temp") => Location::TEMPORARY,
             str_starts_with($target, CLIENT_DATA_DIR) => Location::STORAGE,
             str_starts_with($target, ILIAS_ABSOLUTE_PATH . '/Customizing') => Location::CUSTOMIZING,
             default => throw new InvalidArgumentException(
                 "Can not move files to \"$target\" because path can not be mapped to web, storage or customizing location."
             ),
         };
     }

Here is the caller graph for this function:

◆ uploadBackgroundImage()

ilCertificateBackgroundImageUpload::uploadBackgroundImage	(	string	$imageTempFilename,
		int	$version,
		?array	$pending_file = `null`
	)

Uploads a background image for the certificate.

Creates a new directory for the certificate if needed. Removes an existing certificate image if necessary

Parameters

string	$imageTempFilename	Name of the temporary uploaded image file
int	$version	- Version of the current certifcate template

Returns: string An errorcode if the image upload fails, 0 otherwise

Exceptions

IllegalStateException
FileNotFoundException
IOException
ilException
ilFileUtilsException

Definition at line 94 of file class.ilCertificateBackgroundImageUpload.php.

References createBackgroundImageThumbPath(), ilFileUtils\makeDirParents(), ilFileUtils\moveUploadedFile(), and uploadFile().

                                                                                                                : string
     {
         $imagepath = $this->rootDirectory . $this->certificatePath;
 
         if (!$this->fileSystem->hasDir($imagepath)) {
             ilFileUtils::makeDirParents($imagepath);
         }
 
         $backgroundImageTempFilePath = $this->uploadFile($imageTempFilename, $pending_file);
 
         $backgroundImagePath = $this->certificatePath . 'background_' . $version . '.jpg';
 
         $this->utilHelper->convertImage(
             $backgroundImageTempFilePath,
             $this->rootDirectory . $backgroundImagePath
         );
 
         $backgroundImageThumbnailPath = $this->createBackgroundImageThumbPath();
 
         $this->utilHelper->convertImage(
             $backgroundImageTempFilePath,
             $backgroundImageThumbnailPath,
             "100"
         );
 
         $convert_filename = self::BACKGROUND_IMAGE_NAME;
 
         // something went wrong converting the file. use the original file and hope, that PDF can work with it
         if (!$this->fileSystem->has($backgroundImagePath) && !ilFileUtils::moveUploadedFile(
             $backgroundImageTempFilePath,
             $convert_filename,
             $this->rootDirectory . $backgroundImagePath
         )) {
             throw new ilException('Unable to convert the file and the original file');
         }
 
         if ($this->fileSystem->has($backgroundImageTempFilePath)) {
             $this->fileSystem->delete($backgroundImageTempFilePath);
         }
 
         if ($this->fileSystem->has($backgroundImagePath)) {
             return $this->certificatePath . 'background_' . $version . '.jpg';
         }
 
         throw new ilException('The given temporary filename is empty');
     }

Here is the call graph for this function:

◆ uploadFile()

ilCertificateBackgroundImageUpload::uploadFile	(	string	$temporaryFilename,
		?array	$pending_file = `null`
	)

private

Exceptions

FileNotFoundException
IOException
IllegalStateException
ilException
ilFileUtilsException

Definition at line 148 of file class.ilCertificateBackgroundImageUpload.php.

References createBackgroundImageTempfilePath(), getTargetDir(), getTargetFilesystem(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\FileUpload\DTO\ProcessingStatus\REJECTED.

Referenced by uploadBackgroundImage().

                                                                                        : string
     {
         if (!$this->fileUpload->hasBeenProcessed()) {
             $this->fileUpload->process();
         }
 
         if (!$this->fileUpload->hasUploads()) {
             throw new ilException($this->language->txt('upload_error_file_not_found'));
         }
 
         $uploadResults = $this->fileUpload->getResults();
         if (isset($uploadResults[$temporaryFilename])) {
             $uploadResult = $uploadResults[$temporaryFilename];
             $processingStatus = $uploadResult->getStatus();
             if ($processingStatus->getCode() === ILIAS\FileUpload\DTO\ProcessingStatus::REJECTED) {
                 throw new ilException($processingStatus->getMessage());
             }
 
             $extension = pathinfo($uploadResult->getName(), PATHINFO_EXTENSION);
             $temp_file_path = $this->createBackgroundImageTempfilePath($extension);
             $target_file_name = basename($temp_file_path);
             $target_file_name = $this->fileUtilsHelper->getValidFilename($target_file_name);
 
             $target_file_system = $this->getTargetFilesystem($temp_file_path);
             $target_directory = $this->getTargetDir($temp_file_path);
 
             $this->fileUpload->moveOneFileTo(
                 $uploadResult,
                 $target_directory,
                 $target_file_system,
                 $target_file_name,
                 true
             );
 
             return $temp_file_path;
         } elseif (is_array($pending_file) && $pending_file !== []) {
             $extension = pathinfo($pending_file['name'], PATHINFO_EXTENSION);
             $temp_file_path = $this->createBackgroundImageTempfilePath($extension);
 
             $target_file_name = basename($temp_file_path);
             $target_file_name = $this->fileUtilsHelper->getValidFilename($target_file_name);
 
             $target_directory = $this->getTargetDir($temp_file_path);
 
             $stream = $this->tmp_file_system->readStream(basename($pending_file['tmp_name']));
             $this->fileSystem->writeStream($target_directory . '/' . $target_file_name, $stream);
 
             return $temp_file_path;
         } else {
             throw new ilException($this->language->txt('upload_error_file_not_found'));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BACKGROUND_IMAGE_NAME

const ilCertificateBackgroundImageUpload::BACKGROUND_IMAGE_NAME = 'background.jpg'

private

Definition at line 33 of file class.ilCertificateBackgroundImageUpload.php.

◆ BACKGROUND_TEMPORARY_FILENAME

const ilCertificateBackgroundImageUpload::BACKGROUND_TEMPORARY_FILENAME = 'background_upload_tmp'

private

Definition at line 35 of file class.ilCertificateBackgroundImageUpload.php.

◆ BACKGROUND_THUMBNAIL_IMAGE_NAME

const ilCertificateBackgroundImageUpload::BACKGROUND_THUMBNAIL_IMAGE_NAME = 'background.jpg.thumb.jpg'

private

Definition at line 34 of file class.ilCertificateBackgroundImageUpload.php.

The documentation for this class was generated from the following file:

Services/Certificate/classes/File/Background/class.ilCertificateBackgroundImageUpload.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createBackgroundImageTempfilePath()

◆ createBackgroundImageThumbPath()

◆ getTargetDir()

◆ getTargetFilesystem()

◆ uploadBackgroundImage()

◆ uploadFile()

Field Documentation

◆ $fileSystem

◆ $fileUtilsHelper

◆ $legacyPathHelper

◆ $tmp_file_system

◆ $utilHelper

◆ BACKGROUND_IMAGE_NAME

◆ BACKGROUND_TEMPORARY_FILENAME

◆ BACKGROUND_THUMBNAIL_IMAGE_NAME