Inheritance diagram for ilObjCertificateSettings:

Collaboration diagram for ilObjCertificateSettings:

Public Member Functions
	__construct (int $a_id=0, bool $a_reference=true)

	uploadBackgroundImage (UploadResult $upload_result)
	Uploads a background image for the certificate. More...

	deleteBackgroundImage ()

	getBackgroundImageDefaultFolder (bool $relativePath=false)

	getDefaultBackgroundImagePath (bool $relativePath=false)

	getDefaultBackgroundImageThumbPath (bool $relativePath=false)

	hasBackgroundImage ()

	getDefaultBackgroundImagePathWeb ()

	getBackgroundImageThumbPathWeb ()

Public Member Functions inherited from ilObject
	__construct (int $id=0, bool $reference=true)

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

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

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

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $desc)

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

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

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

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

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

	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. More...

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

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

	selfOrParentWithRatingEnabled ()

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

Private Member Functions
	getDefaultBackgroundImageTempFilePath (string $extension)

Private Attributes
ilLogger	$cert_logger

Factory	$uuid_factory

ilSetting	$certificate_settings

ilCertificateTemplateDatabaseRepository	$certificate_repo

ilUserCertificateRepository	$user_certificate_repo

Additional Inherited Members
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

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

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

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

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

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

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, \ilDBInterface $ilDB=null)

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

int	$id

bool	$referenced

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

bool	$offline = false

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Detailed Description

Class ilObjCertificateSettings.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

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

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

     {
         global $DIC;
 
         parent::__construct($a_id, $a_reference);
         $this->type = 'cert';
         $this->cert_logger = $DIC->logger()->cert();
         $this->uuid_factory = new Factory();
         $this->certificate_settings = new ilSetting('certificate');
         $this->certificate_repo = new ilCertificateTemplateDatabaseRepository($DIC->database());
         $this->user_certificate_repo = new ilUserCertificateRepository($DIC->database());
     }

Here is the call graph for this function:

Member Function Documentation

◆ deleteBackgroundImage()

ilObjCertificateSettings::deleteBackgroundImage ( )

PhpCastIsUnnecessaryInspection

UnnecessaryCastingInspection

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

References getDefaultBackgroundImagePath(), getDefaultBackgroundImageTempFilePath(), getDefaultBackgroundImageThumbPath(), and ilCertificateBackgroundImageFileService\VALID_BACKGROUND_IMAGE_EXTENSIONS.

                                            : bool
     {
         $result = true;
 
 
         if (
             $this->certificate_settings->get('defaultImageFileName', '')
             && !$this->certificate_repo->isBackgroundImageUsed($this->getDefaultBackgroundImagePath(true))
             && !$this->user_certificate_repo->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());
             }
 
             foreach (ilCertificateBackgroundImageFileService::VALID_BACKGROUND_IMAGE_EXTENSIONS as $extension) {
                 if (is_file($this->getDefaultBackgroundImageTempFilePath($extension))) {
                     $result &= unlink($this->getDefaultBackgroundImageTempFilePath($extension));
                 }
             }
         }
 
         $this->certificate_settings->set('defaultImageFileName', '');
 
         return (bool) $result; // Don't remove the cast, otherwise $result will be 1 or 0
     }

Here is the call graph for this function:

◆ getBackgroundImageDefaultFolder()

ilObjCertificateSettings::getBackgroundImageDefaultFolder ( bool $relativePath = false )

Definition at line 200 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 ( )

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

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

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

Here is the call graph for this function:

◆ getDefaultBackgroundImagePath()

ilObjCertificateSettings::getDefaultBackgroundImagePath ( bool $relativePath = false )

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

References getBackgroundImageDefaultFolder().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultBackgroundImagePathWeb()

ilObjCertificateSettings::getDefaultBackgroundImagePathWeb ( )

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

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

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

Here is the call graph for this function:

◆ getDefaultBackgroundImageTempFilePath()

ilObjCertificateSettings::getDefaultBackgroundImageTempFilePath ( string $extension )

private

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

References ilCertificateBackgroundImageFileService\BACKGROUND_TEMPORARY_UPLOAD_FILE_NAME, and getBackgroundImageDefaultFolder().

Referenced by deleteBackgroundImage(), and uploadBackgroundImage().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultBackgroundImageThumbPath()

ilObjCertificateSettings::getDefaultBackgroundImageThumbPath ( bool $relativePath = false )

Definition at line 211 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 ( )

Definition at line 225 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 ( UploadResult $upload_result )

Uploads a background image for the certificate.

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

Returns: bool True on success, otherwise false

Exceptions

ilException

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

References ilCertificateBackgroundImageFileService\BACKGROUND_THUMBNAIL_FILE_ENDING, ilShellUtil\convertImage(), getBackgroundImageDefaultFolder(), getDefaultBackgroundImagePath(), getDefaultBackgroundImageTempFilePath(), getDefaultBackgroundImageThumbPath(), ILIAS\FileUpload\DTO\UploadResult\getName(), ILIAS\FileUpload\DTO\UploadResult\getPath(), ilFileUtils\makeDirParents(), and ilFileUtils\moveUploadedFile().

                                                                       : bool
     {
         $image_temp_file_name = $upload_result->getPath();
         if ($image_temp_file_name !== '') {
             $extension = pathinfo($upload_result->getName(), PATHINFO_EXTENSION);
             $image_path = $this->getBackgroundImageDefaultFolder();
             $new_image_file_name = "background_{$this->uuid_factory->uuid4AsString()}.jpg";
             $new_image_path = $image_path . $new_image_file_name;
 
             if (!is_dir($image_path)) {
                 ilFileUtils::makeDirParents($image_path);
             }
             // upload the file
             if (!ilFileUtils::moveUploadedFile(
                 $image_temp_file_name,
                 basename($this->getDefaultBackgroundImageTempFilePath($extension)),
                 $this->getDefaultBackgroundImageTempFilePath($extension)
             )) {
                 $this->cert_logger->error(sprintf(
                     "Could not upload certificate background image from '%s' to temporary file '%s' (name: '%s')",
                     $image_temp_file_name,
                     $this->getDefaultBackgroundImageTempFilePath($extension),
                     basename($this->getDefaultBackgroundImageTempFilePath($extension))
                 ));
                 return false;
             }
 
             if (!is_file($this->getDefaultBackgroundImageTempFilePath($extension))) {
                 $this->cert_logger->error(sprintf(
                     "Uploaded certificate background image could not be moved to temporary file '%s'",
                     $this->getDefaultBackgroundImageTempFilePath($extension)
                 ));
                 return false;
             }
 
             // convert the uploaded file to JPEG
             ilShellUtil::convertImage(
                 $this->getDefaultBackgroundImageTempFilePath($extension),
                 $new_image_path,
                 'JPEG'
             );
             ilShellUtil::convertImage(
                 $this->getDefaultBackgroundImageTempFilePath($extension),
                 $new_image_path . ilCertificateBackgroundImageFileService::BACKGROUND_THUMBNAIL_FILE_ENDING,
                 'JPEG',
                 '100'
             );
 
             if (!is_file($new_image_path) || !file_exists($new_image_path)) {
                 // 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($extension),
                     $new_image_path
                 ));
                 if (!ilFileUtils::moveUploadedFile(
                     $this->getDefaultBackgroundImageTempFilePath($extension),
                     $new_image_file_name,
                     $new_image_path
                 )) {
                     $this->cert_logger->error(sprintf(
                         "Could not upload certificate background image from '%s' to final file '%s' (name: '%s')",
                         $this->getDefaultBackgroundImageTempFilePath($extension),
                         $new_image_path,
                         $new_image_file_name
                     ));
                     return false;
                 }
             }
 
             if (
                 is_file($this->getDefaultBackgroundImageTempFilePath($extension))
                 && file_exists($this->getDefaultBackgroundImageTempFilePath($extension))
             ) {
                 unlink($this->getDefaultBackgroundImageTempFilePath($extension));
             }
 
             if (file_exists($new_image_path) && (filesize($new_image_path) > 0)) {
                 $old_path = $this->getDefaultBackgroundImagePath();
                 $old_path_thumb = $this->getDefaultBackgroundImageThumbPath();
                 $old_relative_path = $this->getDefaultBackgroundImagePath(true);
                 $this->certificate_settings->set('defaultImageFileName', $new_image_file_name);
                 $new_relative_path = $this->getDefaultBackgroundImagePath(true);
 
                 $this->certificate_repo->updateDefaultBackgroundImagePaths($old_relative_path, $new_relative_path);
 
                 if (
                     !$this->certificate_repo->isBackgroundImageUsed($old_relative_path)
                     && !$this->user_certificate_repo->isBackgroundImageUsed($old_relative_path)
                 ) {
                     if (is_file($old_path) && file_exists($old_path)) {
                         unlink($old_path);
                     }
 
                     if (is_file($old_path_thumb) && file_exists($old_path_thumb)) {
                         unlink($old_path_thumb);
                     }
                 }
                 return true;
             }
 
             $this->cert_logger->error(sprintf(
                 "Final background image '%s' does not exist or is empty",
                 $new_image_path
             ));
         }
 
         return false;
     }

Here is the call graph for this function:

Field Documentation

◆ $cert_logger

ilLogger ilObjCertificateSettings::$cert_logger

private

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

◆ $certificate_repo

ilCertificateTemplateDatabaseRepository ilObjCertificateSettings::$certificate_repo

private

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

◆ $certificate_settings

ilSetting ilObjCertificateSettings::$certificate_settings

private

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

◆ $user_certificate_repo

ilUserCertificateRepository ilObjCertificateSettings::$user_certificate_repo

private

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

◆ $uuid_factory

Factory ilObjCertificateSettings::$uuid_factory

private

Definition at line 33 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

◆ $certificate_repo

◆ $certificate_settings

◆ $user_certificate_repo

◆ $uuid_factory