Inheritance diagram for ilCoursePlaceholderValues:

Collaboration diagram for ilCoursePlaceholderValues:

Public Member Functions
	__construct (?ilObjectCustomUserFieldsPlaceholderValues $customUserFieldsPlaceholderValues=null, ?ilDefaultPlaceholderValues $defaultPlaceholderValues=null, ?ilLanguage $language=null, ?ilCertificateObjectHelper $objectHelper=null, ?ilCertificateParticipantsHelper $participantsHelper=null, ?ilCertificateUtilHelper $ilUtilHelper=null, ?ilCertificateDateHelper $dateHelper=null, ?ilCertificateLPStatusHelper $lpStatusHelper=null)

	getPlaceholderValues (int $userId, int $objId)
	This method MUST return an array that contains the actual data for the given user of the given object. More...

	getPlaceholderValuesForPreview (int $userId, int $objId)
	This method is different then the 'getPlaceholderValues' method, this method is used to create a placeholder value array containing dummy values that is used to create a preview certificate. More...

	getPlaceholderValues (int $userId, int $objId)
	This method MUST return an array that contains the actual data for the given user of the given object. More...

	getPlaceholderValuesForPreview (int $userId, int $objId)
	This method is different then the 'getPlaceholderValues' method, this method is used to create a placeholder value array containing dummy values that is used to create a preview certificate. More...

Private Member Functions
	hasCompletionDate ($possibleDate)

Private Attributes
ilDefaultPlaceholderValues	$defaultPlaceholderValuesObject

ilObjectCustomUserFieldsPlaceholderValues	$customUserFieldsPlaceholderValuesObject

ilLanguage	$language

ilCertificateObjectHelper	$objectHelper

ilCertificateParticipantsHelper	$participantsHelper

ilCertificateUtilHelper	$ilUtilHelper

ilCertificateDateHelper	$dateHelper

ilCertificateLPStatusHelper	$lpStatusHelper

Detailed Description

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

Definition at line 24 of file class.ilCoursePlaceholderValues.php.

Constructor & Destructor Documentation

◆ __construct()

ilCoursePlaceholderValues::__construct	(	?ilObjectCustomUserFieldsPlaceholderValues	$customUserFieldsPlaceholderValues = `null`,
		?ilDefaultPlaceholderValues	$defaultPlaceholderValues = `null`,
		?ilLanguage	$language = `null`,
		?ilCertificateObjectHelper	$objectHelper = `null`,
		?ilCertificateParticipantsHelper	$participantsHelper = `null`,
		?ilCertificateUtilHelper	$ilUtilHelper = `null`,
		?ilCertificateDateHelper	$dateHelper = `null`,
		?ilCertificateLPStatusHelper	$lpStatusHelper = `null`
	)

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

      {
        if (null === $language) {
            global $DIC;
            $language = $DIC->language();
            $language->loadLanguageModule('certificate');
        }
        $this->language = $language;
 
        if (null === $defaultPlaceholderValues) {
            $defaultPlaceholderValues = new ilDefaultPlaceholderValues();
        }
 
        if (null === $customUserFieldsPlaceholderValues) {
            $customUserFieldsPlaceholderValues = new ilObjectCustomUserFieldsPlaceholderValues();
        }
 
        if (null === $objectHelper) {
            $objectHelper = new ilCertificateObjectHelper();
        }
        $this->objectHelper = $objectHelper;
 
        if (null === $participantsHelper) {
            $participantsHelper = new ilCertificateParticipantsHelper();
        }
        $this->participantsHelper = $participantsHelper;
 
        if (null === $ilUtilHelper) {
            $ilUtilHelper = new ilCertificateUtilHelper();
        }
        $this->ilUtilHelper = $ilUtilHelper;
 
        if (null === $dateHelper) {
            $dateHelper = new ilCertificateDateHelper();
        }
        $this->dateHelper = $dateHelper;
 
        if (null === $lpStatusHelper) {
            $lpStatusHelper = new ilCertificateLPStatusHelper();
        }
        $this->lpStatusHelper = $lpStatusHelper;
 
        $this->customUserFieldsPlaceholderValuesObject = $customUserFieldsPlaceholderValues;
        $this->defaultPlaceholderValuesObject = $defaultPlaceholderValues;
    }

References $dateHelper, $DIC, $ilUtilHelper, $language, $lpStatusHelper, $objectHelper, $participantsHelper, ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ilLanguage\loadLanguageModule().

Here is the call graph for this function:

Member Function Documentation

◆ getPlaceholderValues()

ilCoursePlaceholderValues::getPlaceholderValues	(	int	$userId,
		int	$objId
	)

This method MUST return an array that contains the actual data for the given user of the given object.

ilInvalidCertificateException MUST be thrown if the data could not be determined or the user did NOT achieve the certificate.

Parameters

int	$userId
int	$objId

Returns: array - [PLACEHOLDER] => 'actual value'

Exceptions

ilDatabaseException
ilDateTimeException
ilException
ilInvalidCertificateException
ilObjectNotFoundException

Implements ilCertificatePlaceholderValues.

Definition at line 117 of file class.ilCoursePlaceholderValues.php.

                                                                 : array
    {
        $courseObject = $this->objectHelper->getInstanceByObjId($objId);
 
        $placeholders = $this->defaultPlaceholderValuesObject->getPlaceholderValues($userId, $objId);
 
        $customUserFieldsPlaceholders = $this->customUserFieldsPlaceholderValuesObject->getPlaceholderValues(
            $userId,
            $objId
        );
 
        $placeholders = array_merge($placeholders, $customUserFieldsPlaceholders);
 
        $completionDate = $this->participantsHelper->getDateTimeOfPassed($objId, $userId);
        if (!$this->hasCompletionDate($completionDate)) {
            $completionDate = $this->lpStatusHelper->lookupStatusChanged($objId, $userId);
        }
 
        if ($this->hasCompletionDate($completionDate)) {
            $placeholders['DATE_COMPLETED'] = $this->dateHelper->formatDate($completionDate);
            $placeholders['DATETIME_COMPLETED'] = $this->dateHelper->formatDateTime($completionDate);
        }
 
        $placeholders['COURSE_TITLE'] = $this->ilUtilHelper->prepareFormOutput($courseObject->getTitle());
 
        return $placeholders;
    }

References $objId, and hasCompletionDate().

Here is the call graph for this function:

◆ getPlaceholderValuesForPreview()

ilCoursePlaceholderValues::getPlaceholderValuesForPreview	(	int	$userId,
		int	$objId
	)

This method is different then the 'getPlaceholderValues' method, this method is used to create a placeholder value array containing dummy values that is used to create a preview certificate.

Parameters

int	$userId
int	$objId

Returns: array

Exceptions

ilDatabaseException
ilDateTimeException
ilException
ilObjectNotFoundException

Implements ilCertificatePlaceholderValues.

Definition at line 157 of file class.ilCoursePlaceholderValues.php.

                                                                           : array
    {
        $placeholders = $this->defaultPlaceholderValuesObject->getPlaceholderValuesForPreview($userId, $objId);
 
        $customUserFieldsPlaceholders = $this->customUserFieldsPlaceholderValuesObject->getPlaceholderValuesForPreview(
            $userId,
            $objId
        );
 
        $placeholders = array_merge($placeholders, $customUserFieldsPlaceholders);
 
        $object = $this->objectHelper->getInstanceByObjId($objId);
 
        $placeholders['COURSE_TITLE'] = ilLegacyFormElementsUtil::prepareFormOutput($object->getTitle());
 
        return $placeholders;
    }

References $objId, and ilLegacyFormElementsUtil\prepareFormOutput().

Here is the call graph for this function:

◆ hasCompletionDate()

ilCoursePlaceholderValues::hasCompletionDate ( $possibleDate )

private

Parameters

mixed $possibleDate

Returns: bool

Definition at line 93 of file class.ilCoursePlaceholderValues.php.

                                                     : bool
    {
        return (
            $possibleDate !== false &&
            $possibleDate !== null &&
            $possibleDate !== ''
        );
    }