Collaboration diagram for ilCertificateBackgroundImageFileService:

Public Member Functions
	__construct (string $certificatePath, Filesystem $filesystem, string $webDirectory=CLIENT_WEB_DIR)

	hasBackgroundImage (ilCertificateTemplate $template)

	hasBackgroundImageThumbnail (ilCertificateTemplate $template)

	getBackgroundImageThumbPath ()

	getBackgroundImageDirectory (string $backgroundImagePath='')

	getBackgroundImageTempfilePath (string $extension)

	getValidBackgroundImageFileExtensions ()

Data Fields
const	BACKGROUND_IMAGE_NAME = 'background.jpg'

const	BACKGROUND_TEMPORARY_UPLOAD_FILE_NAME = 'background_upload_tmp'

const	BACKGROUND_THUMBNAIL_FILE_ENDING = '.thumb.jpg'

const	PLACEHOLDER_CLIENT_WEB_DIRECTORY = '[CLIENT_WEB_DIR]'

const	VALID_BACKGROUND_IMAGE_EXTENSIONS = ['jpg', 'jpeg', 'gif', 'png']

Private Attributes
Filesystem	$fileSystem

string	$certificatePath

string	$webDirectory

Detailed Description

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

Definition at line 26 of file ilCertificateBackgroundImageFileService.php.

Constructor & Destructor Documentation

◆ __construct()

ilCertificateBackgroundImageFileService::__construct	(	string	$certificatePath,
		Filesystem	$filesystem,
		string	$webDirectory = `CLIENT_WEB_DIR`
	)

Definition at line 38 of file ilCertificateBackgroundImageFileService.php.

      {
        $this->certificatePath = $certificatePath;
        $this->fileSystem = $filesystem;
        $this->webDirectory = $webDirectory;
    }

References $certificatePath, and $webDirectory.

Member Function Documentation

◆ getBackgroundImageDirectory()

ilCertificateBackgroundImageFileService::getBackgroundImageDirectory ( string $backgroundImagePath = '' )

Definition at line 81 of file ilCertificateBackgroundImageFileService.php.

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

◆ getBackgroundImageTempfilePath()

ilCertificateBackgroundImageFileService::getBackgroundImageTempfilePath ( string $extension )

Definition at line 90 of file ilCertificateBackgroundImageFileService.php.

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

◆ getBackgroundImageThumbPath()

ilCertificateBackgroundImageFileService::getBackgroundImageThumbPath ( )

Definition at line 76 of file ilCertificateBackgroundImageFileService.php.

                                                 : string
    {
        return $this->webDirectory . $this->certificatePath . self::BACKGROUND_IMAGE_NAME . self::BACKGROUND_THUMBNAIL_FILE_ENDING;
    }

References BACKGROUND_THUMBNAIL_FILE_ENDING.

◆ getValidBackgroundImageFileExtensions()

ilCertificateBackgroundImageFileService::getValidBackgroundImageFileExtensions ( )

Returns: list<string>

Definition at line 103 of file ilCertificateBackgroundImageFileService.php.

                                                           : array
    {
        return self::VALID_BACKGROUND_IMAGE_EXTENSIONS;
    }

References VALID_BACKGROUND_IMAGE_EXTENSIONS.

◆ hasBackgroundImage()

ilCertificateBackgroundImageFileService::hasBackgroundImage ( ilCertificateTemplate $template )

Definition at line 48 of file ilCertificateBackgroundImageFileService.php.

                                                                       : bool
    {
        $backgroundImagePath = $template->getBackgroundImagePath();
        if ($backgroundImagePath === '') {
            return false;
        }
 
        if ($this->fileSystem->has($backgroundImagePath)) {
            return true;
        }
 
        return false;
    }

References ilCertificateTemplate\getBackgroundImagePath().

Here is the call graph for this function:

◆ hasBackgroundImageThumbnail()

ilCertificateBackgroundImageFileService::hasBackgroundImageThumbnail ( ilCertificateTemplate $template )

Definition at line 62 of file ilCertificateBackgroundImageFileService.php.

                                                                                : bool
    {
        $backgroundImagePath = $template->getThumbnailImagePath();
        if ($backgroundImagePath === '') {
            return false;
        }
 
        if ($this->fileSystem->has($backgroundImagePath)) {
            return true;
        }
 
        return false;
    }