Collaboration diagram for ilCertificateBackgroundImageUpload:

Public Member Functions
	__construct (FileUpload $fileUpload, string $certificatePath, ilLanguage $language, ilLogger $logger, ?Filesystem $fileSystem=null, ?ilCertificateUtilHelper $utilHelper=null, ?ilCertificateFileUtilsHelper $certificateFileUtilsHelper=null, ?LegacyPathHelperHelper $legacyPathHelper=null, string $rootDirectory=CLIENT_WEB_DIR, string $clientID=CLIENT_ID, ?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
	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'

FileUpload	$fileUpload

string	$certificatePath

ilLanguage	$language

string	$rootDirectory

Filesystem	$fileSystem

ilCertificateUtilHelper	$utilHelper

ilCertificateFileUtilsHelper	$fileUtilsHelper

string	$clientId

LegacyPathHelperHelper	$legacyPathHelper

ilLogger	$logger

Filesystem	$tmp_file_system

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References $certificatePath, $DIC, $fileSystem, $fileUpload, $language, $legacyPathHelper, $logger, $rootDirectory, $tmp_file_system, $utilHelper, ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Repository\logger().

       {
         $this->fileUpload = $fileUpload;
         $this->certificatePath = $certificatePath;
         $this->language = $language;
         $this->logger = $logger;
         $this->rootDirectory = $rootDirectory;
 
         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;
 
         $this->clientId = $clientID;
 
         if (null === $tmp_file_system) {
             global $DIC;
             $tmp_file_system = $DIC->filesystem()->temp();
         }
         $this->tmp_file_system = $tmp_file_system;
     }

Here is the call graph for this function:

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 259 of file class.ilCertificateBackgroundImageUpload.php.

Referenced by uploadBackgroundImage().

                                                                          : 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 273 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 249 of file class.ilCertificateBackgroundImageUpload.php.

Referenced by uploadBackgroundImage().

                                                  : 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 225 of file class.ilCertificateBackgroundImageUpload.php.

References CLIENT_DATA_DIR.

Referenced by uploadBackgroundImage().

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

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
array \| null	$pending_file

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

Exceptions

IllegalStateException
FileNotFoundException
IOException
ilException
ilFileUtilsException

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

References $certificatePath, createBackgroundImageTempfilePath(), createBackgroundImageThumbPath(), getTargetDir(), getTargetFilesystem(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ilFileUtils\makeDirParents(), ilFileUtils\moveUploadedFile(), and ILIAS\FileUpload\DTO\ProcessingStatus\REJECTED.

                                                                                                                : 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,
             'JPEG'
         );
 
         $backgroundImageThumbnailPath = $this->createBackgroundImageThumbPath();
 
         $this->utilHelper->convertImage(
             $backgroundImageTempFilePath,
             $backgroundImageThumbnailPath,
             'JPEG',
             "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');
     }