Inheritance diagram for ilObjCertificateSettings:

Collaboration diagram for ilObjCertificateSettings:

Public Member Functions
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...

	uploadBackgroundImage (string $imageTempFileName)
	Uploads a background image for the certificate. More...

	deleteBackgroundImage ()
	Deletes the background image of a certificate. More...

	getBackgroundImageDefaultFolder (bool $relativePath=false)

	getDefaultBackgroundImagePath (bool $relativePath=false)
	Returns the filesystem path of the background image. More...

	getDefaultBackgroundImageThumbPath (bool $relativePath=false)
	Returns the filesystem path of the background image thumbnail. More...

	hasBackgroundImage ()

	getDefaultBackgroundImagePathWeb ()
	Returns the web path of the background image. More...

	getBackgroundImageThumbPathWeb ()
	Returns the web path of the background image thumbnail. More...

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...

	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...

	read ()
	read object data from db into object More...

	getId ()
	get object id public More...

	setId ($a_id)
	set object id public More...

	setRefId ($a_id)
	set reference id public More...

	getRefId ()
	get reference id public More...

	getType ()
	get object type public More...

	setType ($a_type)
	set object type public More...

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()
	get object title public More...

	getUntranslatedTitle ()
	get untranslated object title public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	setOfflineStatus ($a_status)
	Set offline status. More...

	getOfflineStatus ()
	Get offline status. More...

	supportsOfflineHandling ()
	Check whether object supports offline handling. More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date public More...

	getLastUpdateDate ()
	get last update date public More...

	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...

	create ()
	create More...

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

	updateOwner ()
	update owner of object in db More...

	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...

	setPermissions ($a_parent_ref)
	set permissions of object More...

	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object More...

	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

	cloneMetaData ($target_obj)
	Copy meta data. More...

	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Private Member Functions
	getDefaultBackgroundImageTempFilePath ()
	Returns the filesystem path of the background image temp file during upload. More...

Private Attributes
	$cert_logger

	$uuidFactory

	$certificateSettings

	$certificateRepo

	$userCertificateRepo

Additional Inherited Members
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	lookupOfflineStatus ($a_obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id, $a_deleted_by)

static	setDeletedDates ($a_ref_ids, $a_user_id)
	Set deleted date. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ( $a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Detailed Description

Class ilObjCertificateSettings.

Author: Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de

Version: $Id$

Definition at line 36 of file class.ilObjCertificateSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjCertificateSettings::__construct	(	$a_id = `0`,
		$a_reference = `true`
	)

Constructor public.

Parameters

int	$a_id	reference_id or object_id
bool	$a_reference	treat the id as reference_id (true) or object_id (false)

Definition at line 67 of file class.ilObjCertificateSettings.php.

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

     {
         global $DIC;
 
         $this->type = 'cert';
         parent::__construct($a_id, $a_reference);
         $this->cert_logger = $DIC->logger()->cert();
         $this->uuidFactory = new Factory();
         $this->certificateSettings = new ilSetting('certificate');
         $this->certificateRepo = new ilCertificateTemplateRepository($DIC->database());
         $this->userCertificateRepo = new ilUserCertificateRepository($DIC->database());
     }

Here is the call graph for this function:

Member Function Documentation

◆ deleteBackgroundImage()

ilObjCertificateSettings::deleteBackgroundImage ( )

Deletes the background image of a certificate.

Returns: bool TRUE if the process succeeds

Definition at line 196 of file class.ilObjCertificateSettings.php.

References $result, getDefaultBackgroundImagePath(), getDefaultBackgroundImageTempFilePath(), and getDefaultBackgroundImageThumbPath().

                                             : bool
     {
         $result = true;
 
 
         if (
             $this->certificateSettings->get('defaultImageFileName', '')
             && !$this->certificateRepo->isBackgroundImageUsed($this->getDefaultBackgroundImagePath(true))
             && !$this->userCertificateRepo->isBackgroundImageUsed($this->getDefaultBackgroundImagePath(true))
         ) {
             //No certificates exist using the currently configured file, deleting file possible.
 
             if (is_file($this->getDefaultBackgroundImageThumbPath())) {
                 $result &= unlink($this->getDefaultBackgroundImageThumbPath());
             }
             if (is_file($this->getDefaultBackgroundImagePath())) {
                 $result &= unlink($this->getDefaultBackgroundImagePath());
             }
             if (is_file($this->getDefaultBackgroundImageTempFilePath())) {
                 $result &= unlink($this->getDefaultBackgroundImageTempFilePath());
             }
         }
 
         $this->certificateSettings->set('defaultImageFileName', '');
 
         return $result;
     }

Here is the call graph for this function:

◆ getBackgroundImageDefaultFolder()

ilObjCertificateSettings::getBackgroundImageDefaultFolder ( bool $relativePath = false )

Definition at line 224 of file class.ilObjCertificateSettings.php.

References CLIENT_WEB_DIR.

Referenced by getDefaultBackgroundImagePath(), getDefaultBackgroundImageTempFilePath(), and uploadBackgroundImage().

                                                                                 : string
     {
         return ($relativePath ? '' : CLIENT_WEB_DIR) . '/certificates/default/';
     }

Here is the caller graph for this function:

◆ getBackgroundImageThumbPathWeb()

ilObjCertificateSettings::getBackgroundImageThumbPathWeb ( )

Returns the web path of the background image thumbnail.

Returns: string The web path of the background image thumbnail

Definition at line 286 of file class.ilObjCertificateSettings.php.

References getDefaultBackgroundImageThumbPath(), and ilUtil\removeTrailingPathSeparators().

                                                      : string
     {
         return str_replace(
             ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH),
             ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH),
             $this->getDefaultBackgroundImageThumbPath()
         );
     }

Here is the call graph for this function:

◆ getDefaultBackgroundImagePath()

ilObjCertificateSettings::getDefaultBackgroundImagePath ( bool $relativePath = false )

Returns the filesystem path of the background image.

Returns: string The filesystem path of the background image

Definition at line 234 of file class.ilObjCertificateSettings.php.

References getBackgroundImageDefaultFolder().

Referenced by deleteBackgroundImage(), getDefaultBackgroundImagePathWeb(), getDefaultBackgroundImageThumbPath(), hasBackgroundImage(), and uploadBackgroundImage().

                                                                               : string
     {
         return $this->getBackgroundImageDefaultFolder($relativePath)
             . $this->certificateSettings->get('defaultImageFileName', '');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultBackgroundImagePathWeb()

ilObjCertificateSettings::getDefaultBackgroundImagePathWeb ( )

Returns the web path of the background image.

Returns: string The web path of the background image

Definition at line 273 of file class.ilObjCertificateSettings.php.

References getDefaultBackgroundImagePath(), and ilUtil\removeTrailingPathSeparators().

                                                        : string
     {
         return str_replace(
             ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH),
             ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH),
             $this->getDefaultBackgroundImagePath()
         );
     }

Here is the call graph for this function:

◆ getDefaultBackgroundImageTempFilePath()

ilObjCertificateSettings::getDefaultBackgroundImageTempFilePath ( )

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 255 of file class.ilObjCertificateSettings.php.

References ilCertificateBackgroundImageFileService\BACKGROUND_TEMPORARY_UPLOAD_FILE_NAME, and getBackgroundImageDefaultFolder().

Referenced by deleteBackgroundImage(), and uploadBackgroundImage().

                                                              : string
     {
         return $this->getBackgroundImageDefaultFolder() . ilCertificateBackgroundImageFileService::BACKGROUND_TEMPORARY_UPLOAD_FILE_NAME;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultBackgroundImageThumbPath()

ilObjCertificateSettings::getDefaultBackgroundImageThumbPath ( bool $relativePath = false )

Returns the filesystem path of the background image thumbnail.

Returns: string The filesystem path of the background image thumbnail

Definition at line 245 of file class.ilObjCertificateSettings.php.

References ilCertificateBackgroundImageFileService\BACKGROUND_THUMBNAIL_FILE_ENDING, and getDefaultBackgroundImagePath().

Referenced by deleteBackgroundImage(), getBackgroundImageThumbPathWeb(), and uploadBackgroundImage().

                                                                                    : string
     {
         return $this->getDefaultBackgroundImagePath($relativePath) . ilCertificateBackgroundImageFileService::BACKGROUND_THUMBNAIL_FILE_ENDING;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasBackgroundImage()

ilObjCertificateSettings::hasBackgroundImage ( )

Returns: bool

Definition at line 263 of file class.ilObjCertificateSettings.php.

References getDefaultBackgroundImagePath().

                                          : bool
     {
         $filePath = $this->getDefaultBackgroundImagePath();
         return is_file($filePath) && filesize($filePath) > 0;
     }

Here is the call graph for this function:

◆ uploadBackgroundImage()

ilObjCertificateSettings::uploadBackgroundImage ( string $imageTempFileName )

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

Returns: bool True on success otherwise false

Exceptions

ilException
Exception

Definition at line 89 of file class.ilObjCertificateSettings.php.

References ilCertificateBackgroundImageFileService\BACKGROUND_THUMBNAIL_FILE_ENDING, ilUtil\convertImage(), getBackgroundImageDefaultFolder(), getDefaultBackgroundImagePath(), getDefaultBackgroundImageTempFilePath(), getDefaultBackgroundImageThumbPath(), ilUtil\makeDirParents(), and ilUtil\moveUploadedFile().

                                                                      : bool
     {
         if (!empty($imageTempFileName)) {
             $imagePath = $this->getBackgroundImageDefaultFolder();
             $newImageFileName = "background_{$this->uuidFactory->uuid4AsString()}.jpg";
             $newImagePath = $imagePath . $newImageFileName;
 
             if (!file_exists($imagePath)) {
                 ilUtil::makeDirParents($imagePath);
             }
             // upload the file
             if (!ilUtil::moveUploadedFile(
                 $imageTempFileName,
                 basename($this->getDefaultBackgroundImageTempFilePath()),
                 $this->getDefaultBackgroundImageTempFilePath()
             )) {
                 $this->cert_logger->error(sprintf(
                     "Could not upload certificate background image from '%s' to temporary file '%s' (name: '%s')",
                     $imageTempFileName,
                     $this->getDefaultBackgroundImageTempFilePath(),
                     basename($this->getDefaultBackgroundImageTempFilePath())
                 ));
                 return false;
             }
 
             // convert the uploaded file to JPEG
             ilUtil::convertImage(
                 $this->getDefaultBackgroundImageTempFilePath(),
                 $newImagePath,
                 'JPEG'
             );
             ilUtil::convertImage(
                 $this->getDefaultBackgroundImageTempFilePath(),
                 $newImagePath . ilCertificateBackgroundImageFileService::BACKGROUND_THUMBNAIL_FILE_ENDING,
                 'JPEG',
                 100
             );
 
             if (!is_file($newImagePath) || !file_exists($newImagePath)) {
                 // Something went wrong converting the file. Use the original file and hope, that PDF can work with it.
                 $this->cert_logger->error(sprintf(
                     "Could not convert certificate background image from '%s' as JPEG to '%s', trying fallbacj ...",
                     $this->getDefaultBackgroundImageTempFilePath(),
                     $newImagePath
                 ));
                 if (!rename(
                     $this->getDefaultBackgroundImageTempFilePath(),
                     $newImagePath
                 )) {
                     $this->cert_logger->error(sprintf(
                         "Could not upload certificate background image from '%s' to final file '%s' (name: '%s')",
                         $this->getDefaultBackgroundImageTempFilePath(),
                         $newImagePath,
                         $newImageFileName
                     ));
                     return false;
                 }
             }
 
             if (
                 is_file($this->getDefaultBackgroundImageTempFilePath())
                 && file_exists($this->getDefaultBackgroundImageTempFilePath())
             ) {
                 unlink($this->getDefaultBackgroundImageTempFilePath());
             }
 
             if (file_exists($newImagePath) && (filesize($newImagePath) > 0)) {
                 $oldPath = $this->getDefaultBackgroundImagePath();
                 $oldPathThumb = $this->getDefaultBackgroundImageThumbPath();
 
                 $oldRelativePath = $this->getDefaultBackgroundImagePath(true);
                 $this->certificateSettings->set('defaultImageFileName', $newImageFileName);
                 $newRelativePath = $this->getDefaultBackgroundImagePath(true);
 
                 $this->certificateRepo->updateDefaultBackgroundImagePaths($oldRelativePath, $newRelativePath);
 
                 if (
                     !$this->certificateRepo->isBackgroundImageUsed($oldRelativePath)
                     && !$this->userCertificateRepo->isBackgroundImageUsed($oldRelativePath)
                 ) {
                     if (is_file($oldPath) && file_exists($oldPath)) {
                         unlink($oldPath);
                     }
 
                     if (is_file($oldPathThumb) && file_exists($oldPathThumb)) {
                         unlink($oldPathThumb);
                     }
                 }
 
 
                 return true;
             }
 
             $this->cert_logger->error(sprintf(
                 "Final background image '%s' does not exist or is empty",
                 $newImagePath
             ));
         }
 
         return false;
     }

Here is the call graph for this function:

Field Documentation

◆ $cert_logger

ilObjCertificateSettings::$cert_logger

private

Definition at line 39 of file class.ilObjCertificateSettings.php.

◆ $certificateRepo

ilObjCertificateSettings::$certificateRepo

private

Definition at line 54 of file class.ilObjCertificateSettings.php.

◆ $certificateSettings

ilObjCertificateSettings::$certificateSettings

private

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

◆ $userCertificateRepo

ilObjCertificateSettings::$userCertificateRepo

private

Definition at line 59 of file class.ilObjCertificateSettings.php.

◆ $uuidFactory

ilObjCertificateSettings::$uuidFactory

private

Definition at line 44 of file class.ilObjCertificateSettings.php.

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

Services/Certificate/classes/class.ilObjCertificateSettings.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteBackgroundImage()

◆ getBackgroundImageDefaultFolder()

◆ getBackgroundImageThumbPathWeb()

◆ getDefaultBackgroundImagePath()

◆ getDefaultBackgroundImagePathWeb()

◆ getDefaultBackgroundImageTempFilePath()

◆ getDefaultBackgroundImageThumbPath()

◆ hasBackgroundImage()

◆ uploadBackgroundImage()

Field Documentation

◆ $cert_logger

◆ $certificateRepo

◆ $certificateSettings

◆ $userCertificateRepo

◆ $uuidFactory