Inheritance diagram for ilStudyProgrammePlaceholderValues:

Collaboration diagram for ilStudyProgrammePlaceholderValues:

Public Member Functions
	__construct (ilDefaultPlaceholderValues $defaultPlaceholderValues=null, ilLanguage $language=null, ilCertificateObjectHelper $objectHelper=null, ilCertificateParticipantsHelper $participantsHelper=null, ilCertificateUtilHelper $ilUtilHelper=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
	$defaultPlaceholderValuesObject

	$language

	$objectHelper

	$participantsHelper

	$ilUtilHelper

Detailed Description

Definition at line 4 of file class.ilStudyProgrammePlaceholderValues.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammePlaceholderValues::__construct	(	ilDefaultPlaceholderValues	$defaultPlaceholderValues = `null`,
		ilLanguage	$language = `null`,
		ilCertificateObjectHelper	$objectHelper = `null`,
		ilCertificateParticipantsHelper	$participantsHelper = `null`,
		ilCertificateUtilHelper	$ilUtilHelper = `null`
	)

Parameters

ilDefaultPlaceholderValues	$defaultPlaceholderValues
ilLanguage \| null	$language
ilCertificateObjectHelper \| null	$objectHelper
ilCertificateParticipantsHelper \| null	$participantsHelper
ilCertificateUtilHelper	$ilUtilHelper
ilCertificateDateHelper \| null	$ilDateHelper

Definition at line 39 of file class.ilStudyProgrammePlaceholderValues.php.

      {
        if (null === $language) {
            global $DIC;
            $language = $DIC->language();
            $language->loadLanguageModule('certificate');
        }
        $this->language = $language;
 
        if (null === $defaultPlaceholderValues) {
            $defaultPlaceholderValues = new ilDefaultPlaceholderValues();
        }
 
        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;
 
        $this->defaultPlaceholderValuesObject = $defaultPlaceholderValues;
    }

References $DIC, $ilUtilHelper, $language, $objectHelper, $participantsHelper, and language().

Here is the call graph for this function:

Member Function Documentation

◆ getPlaceholderValues()

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

ilException

Implements ilCertificatePlaceholderValues.

Definition at line 88 of file class.ilStudyProgrammePlaceholderValues.php.

                                                                  : array
    {
        $object = $this->objectHelper->getInstanceByObjId($objId);
        $placeholders = $this->defaultPlaceholderValuesObject->getPlaceholderValues($userId, $objId);
        $latest_progress = array_reduce(
            $object->getProgressesOf($userId),
            function ($one, $other) {
                if ($one !== null && $one->isSuccessful() && $other !== null && $other->isSuccessful()) {
                    return
                        $one->getCompletionDate()->format('Y-m-d H:i:s') > $other->getCompletionDate()->format('Y-m-d H:i:s') ?
                        $one :
                        $other;
                }
                if ($one !== null && $one->isSuccessful()) {
                    return $one;
                }
                if ($other !== null && $other->isSuccessful()) {
                    return $other;
                }
                return null;
            }
        );
 
        if (!$latest_progress) {
            throw new \ilInvalidCertificateException('PRG: no valid progress for user ' . $userId . ' while generating certificate');
        }
 
        $type = $object->getSubType();
        $placeholders['PRG_TITLE'] = ilUtil::prepareFormOutput($object->getTitle());
        $placeholders['PRG_DESCRIPTION'] = ilUtil::prepareFormOutput($object->getDescription());
        $placeholders['PRG_TYPE'] = ilUtil::prepareFormOutput($type ? $type->getTitle() : '');
        $placeholders['PRG_POINTS'] = ilUtil::prepareFormOutput($object->getPoints());
        $placeholders['PRG_COMPLETION_DATE'] = ilUtil::prepareFormOutput($latest_progress->getCompletionDate() instanceof \DateTimeImmutable ? $latest_progress->getCompletionDate()->format('d.m.Y') : '');
        $placeholders['PRG_EXPIRES_AT'] = ilUtil::prepareFormOutput($latest_progress->getValidityOfQualification() instanceof \DateTimeImmutable ? $latest_progress->getValidityOfQualification()->format('d.m.Y') : '');
        return $placeholders;
    }

References $objId, $type, if, and ilUtil\prepareFormOutput().

Here is the call graph for this function:

◆ getPlaceholderValuesForPreview()

ilStudyProgrammePlaceholderValues::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: mixed

Implements ilCertificatePlaceholderValues.

Definition at line 134 of file class.ilStudyProgrammePlaceholderValues.php.

    {
        $placeholders = $this->defaultPlaceholderValuesObject->getPlaceholderValuesForPreview($userId, $objId);
 
        $object = $this->objectHelper->getInstanceByObjId($objId);
        $type = $object->getSubType();
        $today = ilUtil::prepareFormOutput((new DateTime())->format('d.m.Y'));
        $placeholders['PRG_TITLE'] = ilUtil::prepareFormOutput($object->getTitle());
        $placeholders['PRG_DESCRIPTION'] = ilUtil::prepareFormOutput($object->getDescription());
        $placeholders['PRG_TYPE'] = ilUtil::prepareFormOutput($type ? $type->getTitle() : '');
        $placeholders['PRG_POINTS'] = ilUtil::prepareFormOutput($object->getPoints());
        $placeholders['PRG_COMPLETION_DATE'] = $today;
        $placeholders['PRG_EXPIRES_AT'] = $today;
        return $placeholders;
    }