Inheritance diagram for ilExercisePlaceholderValues:

Collaboration diagram for ilExercisePlaceholderValues:

Public Member Functions
	__construct (?ilDefaultPlaceholderValues $defaultPlaceholderValues=null, ?ilLanguage $language=null, ?ilCertificateObjectHelper $objectHelper=null, ?ilCertificateLPMarksHelper $lpMarksHelper=null, ?ilCertificateExerciseMembersHelper $exerciseMembersHelper=null, ?ilCertificateLPStatusHelper $lpStatusHelper=null, ?ilCertificateUtilHelper $utilHelper=null, ?ilCertificateDateHelper $dateHelper=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 Attributes
ilLanguage	$language

ilDefaultPlaceholderValues	$defaultPlaceholderValuesObject

ilCertificateLPMarksHelper	$lpMarksHelper

ilCertificateObjectHelper	$objectHelper

ilCertificateExerciseMembersHelper	$exerciseMembersHelper

ilCertificateLPStatusHelper	$lpStatusHelper

ilCertificateUtilHelper	$utilHelper

ilCertificateDateHelper	$dateHelper

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ilExercisePlaceholderValues::__construct	(	?ilDefaultPlaceholderValues	$defaultPlaceholderValues = `null`,
		?ilLanguage	$language = `null`,
		?ilCertificateObjectHelper	$objectHelper = `null`,
		?ilCertificateLPMarksHelper	$lpMarksHelper = `null`,
		?ilCertificateExerciseMembersHelper	$exerciseMembersHelper = `null`,
		?ilCertificateLPStatusHelper	$lpStatusHelper = `null`,
		?ilCertificateUtilHelper	$utilHelper = `null`,
		?ilCertificateDateHelper	$dateHelper = `null`
	)

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

      {
        if (null === $language) {
            global $DIC;
            $language = $DIC->language();
            $language->loadLanguageModule('certificate');
        }
        $language->loadLanguageModule('exercise');
        $language->loadLanguageModule('exc');
 
        $this->language = $language;
 
        if (null === $defaultPlaceholderValues) {
            $defaultPlaceholderValues = new ilDefaultPlaceholderValues();
        }
        $this->defaultPlaceholderValuesObject = $defaultPlaceholderValues;
 
        if (null === $objectHelper) {
            $objectHelper = new ilCertificateObjectHelper();
        }
        $this->objectHelper = $objectHelper;
 
        if (null === $lpMarksHelper) {
            $lpMarksHelper = new ilCertificateLPMarksHelper();
        }
        $this->lpMarksHelper = $lpMarksHelper;
 
        if (null === $exerciseMembersHelper) {
            $exerciseMembersHelper = new ilCertificateExerciseMembersHelper();
        }
        $this->exerciseMembersHelper = $exerciseMembersHelper;
 
        if (null === $lpStatusHelper) {
            $lpStatusHelper = new ilCertificateLPStatusHelper();
        }
        $this->lpStatusHelper = $lpStatusHelper;
 
        if (null === $utilHelper) {
            $utilHelper = new ilCertificateUtilHelper();
        }
        $this->utilHelper = $utilHelper;
 
        if (null === $dateHelper) {
            $dateHelper = new ilCertificateDateHelper();
        }
        $this->dateHelper = $dateHelper;
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ getPlaceholderValues()

ilExercisePlaceholderValues::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
ilObjectNotFoundException

Implements ilCertificatePlaceholderValues.

Definition at line 105 of file class.ilExercisePlaceholderValues.php.

                                                                 : array
    {
        $exerciseObject = $this->objectHelper->getInstanceByObjId($objId);
 
        $mark = $this->lpMarksHelper->lookUpMark($userId, $objId);
        $status = $this->exerciseMembersHelper->lookUpStatus($objId, $userId);
 
        $completionDate = $this->lpStatusHelper->lookupStatusChanged($objId, $userId);
 
        $placeHolders = $this->defaultPlaceholderValuesObject->getPlaceholderValues($userId, $objId);
 
        if ($status !== null) {
            $placeHolders['RESULT_PASSED'] = $this->utilHelper->prepareFormOutput($this->language->txt('exc_' . $status));
        }
 
        $placeHolders['RESULT_MARK'] = $this->utilHelper->prepareFormOutput($mark);
        $placeHolders['EXERCISE_TITLE'] = $this->utilHelper->prepareFormOutput($exerciseObject->getTitle());
        $placeHolders['DATE_COMPLETED'] = '';
        $placeHolders['DATETIME_COMPLETED'] = '';
 
        if ($completionDate !== '') {
            $placeHolders['DATE_COMPLETED'] = $this->dateHelper->formatDate($completionDate);
            $placeHolders['DATETIME_COMPLETED'] = $this->dateHelper->formatDateTime($completionDate);
        }
 
        return $placeHolders;
    }

References $objId, and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

◆ getPlaceholderValuesForPreview()

ilExercisePlaceholderValues::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

Implements ilCertificatePlaceholderValues.

Definition at line 141 of file class.ilExercisePlaceholderValues.php.

                                                                           : array
    {
        $placeholders = $this->defaultPlaceholderValuesObject->getPlaceholderValuesForPreview($userId, $objId);
 
        $object = $this->objectHelper->getInstanceByObjId($objId);
 
        $placeholders['RESULT_PASSED'] = $this->utilHelper->prepareFormOutput($this->language->txt('certificate_var_result_passed'));
        $placeholders['RESULT_MARK'] = $this->utilHelper->prepareFormOutput($this->language->txt('certificate_var_result_mark_short'));
        $placeholders['EXERCISE_TITLE'] = $this->utilHelper->prepareFormOutput($object->getTitle());
 
        return $placeholders;
    }