Collaboration diagram for ilCertificateBackgroundImageFileService:

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

	hasBackgroundImage (ilCertificateTemplate $template)
	Checks for the background image of the certificate. More...

	hasBackgroundImageThumbnail (ilCertificateTemplate $template)

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

	getBackgroundImageDirectory ($backgroundImagePath='')
	Returns the filesystem path of the background image. More...

	getBackgroundImageTempfilePath ()
	Returns the filesystem path of the background image temp file during upload. More...

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]'

Private Attributes
	$fileSystem

	$certificatePath

	$webDirectory

Detailed Description

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

Definition at line 7 of file ilCertificateBackgroundImageFileService.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

string	$certificatePath
\ILIAS\Filesystem\Filesystem	$filesystem
string	$webDirectory

Definition at line 34 of file ilCertificateBackgroundImageFileService.php.

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

References $certificatePath, and $webDirectory.

Member Function Documentation

◆ getBackgroundImageDirectory()

ilCertificateBackgroundImageFileService::getBackgroundImageDirectory ( $backgroundImagePath = '' )

Returns the filesystem path of the background image.

Parameters

string $backgroundImagePath

Returns: string The filesystem path of the background image

Definition at line 95 of file ilCertificateBackgroundImageFileService.php.

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

◆ getBackgroundImageTempfilePath()

ilCertificateBackgroundImageFileService::getBackgroundImageTempfilePath ( )

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 109 of file ilCertificateBackgroundImageFileService.php.

    {
        return $this->webDirectory . $this->certificatePath . self::BACKGROUND_TEMPORARY_UPLOAD_FILE_NAME;
    }

References BACKGROUND_TEMPORARY_UPLOAD_FILE_NAME.

◆ getBackgroundImageThumbPath()

ilCertificateBackgroundImageFileService::getBackgroundImageThumbPath ( )

Returns the filesystem path of the background image thumbnail.

Returns: string The filesystem path of the background image thumbnail

Definition at line 85 of file ilCertificateBackgroundImageFileService.php.

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

References BACKGROUND_THUMBNAIL_FILE_ENDING.

◆ hasBackgroundImage()

ilCertificateBackgroundImageFileService::hasBackgroundImage ( ilCertificateTemplate $template )

Checks for the background image of the certificate.

Parameters

ilCertificateTemplate $template

Returns: boolean Returns TRUE if the certificate has a background image, FALSE otherwise

Definition at line 49 of file ilCertificateBackgroundImageFileService.php.

    {
        $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 )

Parameters

ilCertificateTemplate $template

Returns: bool

Definition at line 67 of file ilCertificateBackgroundImageFileService.php.

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