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
	$language
	$defaultPlaceholderValuesObject
	$lpMarksHelper
	$objectHelper
	$exerciseMembersHelper
	$lpStatusHelper
	$utilHelper
	$dateHelper

Detailed Description

Author

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

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

Parameters

ilDefaultPlaceholderValues | null	$defaultPlaceholderValues
ilLanguage | null	$language
ilCertificateObjectHelper | null	$objectHelper
ilCertificateLPMarksHelper | null	$lpMarksHelper
ilCertificateExerciseMembersHelper | null	$exerciseMembersHelper
ilCertificateLPStatusHelper | null	$lpStatusHelper
ilCertificateUtilHelper | null	$utilHelper
ilCertificateDateHelper | null	$dateHelper

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

References $dateHelper, $DIC, $exerciseMembersHelper, $language, $lpMarksHelper, $lpStatusHelper, $objectHelper, and $utilHelper.

      {
        if (null === $language) {
            global $DIC;
            $language = $DIC->language();
        }
        $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;
    }

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

$userId
$objId

Returns

mixed - [PLACEHOLDER] => 'actual value'

Exceptions

ilDateTimeException
ilException

Implements ilCertificatePlaceholderValues.

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

                                                                  : array
    {
        $exerciseObject = $this->objectHelper->getInstanceByObjId($objId);

        $mark = (string) $this->lpMarksHelper->lookUpMark($userId, $objId);
        $status = $this->exerciseMembersHelper->lookUpStatus($objId, $userId);

        $completionDate = $this->lpStatusHelper->lookupStatusChanged($objId, $userId);

        $placeHolders = $this->defaultPlaceholderValuesObject->getPlaceholderValues($userId, $objId);

        $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 !== false &&
            $completionDate !== null &&
            $completionDate !== ''
        ) {
            $placeHolders['DATE_COMPLETED'] = $this->dateHelper->formatDate($completionDate);
            $placeHolders['DATETIME_COMPLETED'] = $this->dateHelper->formatDateTime($completionDate);
        }

        return $placeHolders;
    }

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

Field Documentation

$dateHelper

ilExercisePlaceholderValues::$dateHelper

private

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

Referenced by __construct().

$defaultPlaceholderValuesObject

ilExercisePlaceholderValues::$defaultPlaceholderValuesObject

private

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

$exerciseMembersHelper

ilExercisePlaceholderValues::$exerciseMembersHelper

private

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

Referenced by __construct().

$language

ilExercisePlaceholderValues::$language

private

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

Referenced by __construct().

$lpMarksHelper

ilExercisePlaceholderValues::$lpMarksHelper

private

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

Referenced by __construct().

$lpStatusHelper

ilExercisePlaceholderValues::$lpStatusHelper

private

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

Referenced by __construct().

$objectHelper

ilExercisePlaceholderValues::$objectHelper

private

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

Referenced by __construct().

$utilHelper

ilExercisePlaceholderValues::$utilHelper

private

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