ilExercisePlaceholderValues Class Reference

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

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.

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

      {
        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;
    }

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.

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

                                                                 : 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;
    }

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.

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

                                                                           : 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;
    }

Here is the call graph for this function:

Field Documentation

$dateHelper

ilCertificateDateHelper ilExercisePlaceholderValues::$dateHelper

private

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

Referenced by __construct().

$defaultPlaceholderValuesObject

ilDefaultPlaceholderValues ilExercisePlaceholderValues::$defaultPlaceholderValuesObject

private

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

$exerciseMembersHelper

ilCertificateExerciseMembersHelper ilExercisePlaceholderValues::$exerciseMembersHelper

private

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

Referenced by __construct().

$language

ilLanguage ilExercisePlaceholderValues::$language

private

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

Referenced by __construct().

$lpMarksHelper

ilCertificateLPMarksHelper ilExercisePlaceholderValues::$lpMarksHelper

private

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

Referenced by __construct().

$lpStatusHelper

ilCertificateLPStatusHelper ilExercisePlaceholderValues::$lpStatusHelper

private

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

Referenced by __construct().

$objectHelper

ilCertificateObjectHelper ilExercisePlaceholderValues::$objectHelper

private

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

Referenced by __construct().

$utilHelper

ilCertificateUtilHelper ilExercisePlaceholderValues::$utilHelper

private

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

Referenced by __construct().

---

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

• Services/Certificate/classes/Placeholder/Values/class.ilExercisePlaceholderValues.php