Inheritance diagram for ILIAS\StudyProgramme\Certificate\ilStudyProgrammePlaceholderValues:

Collaboration diagram for ILIAS\StudyProgramme\Certificate\ilStudyProgrammePlaceholderValues:

Public Member Functions
	__construct (?\ilDefaultPlaceholderValues $defaultPlaceholderValues=null, ?\ilLanguage $language=null, ?\ilCertificateObjectHelper $objectHelper=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
readonly ilDefaultPlaceholderValues	$defaultPlaceholderValuesObject

readonly ilCertificateObjectHelper	$objectHelper

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ILIAS\StudyProgramme\Certificate\ilStudyProgrammePlaceholderValues::__construct	(	?\ilDefaultPlaceholderValues	$defaultPlaceholderValues = `null`,
		?\ilLanguage	$language = `null`,
		?\ilCertificateObjectHelper	$objectHelper = `null`
	)

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

References $DIC, ILIAS\StudyProgramme\Certificate\ilStudyProgrammePlaceholderValues\$objectHelper, and null.

       {
         if (null === $language) {
             global $DIC;
             $language = $DIC->language();
             $language->loadLanguageModule('certificate');
         }
 
         if (null === $defaultPlaceholderValues) {
             $defaultPlaceholderValues = new \ilDefaultPlaceholderValues();
         }
 
         if (null === $objectHelper) {
             $objectHelper = new \ilCertificateObjectHelper();
         }
         $this->objectHelper = $objectHelper;
 
         $this->defaultPlaceholderValuesObject = $defaultPlaceholderValues;
     }

Member Function Documentation

◆ getPlaceholderValues()

ILIAS\StudyProgramme\Certificate\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.

Exceptions

Implements ilCertificatePlaceholderValues.

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

References $ass_id, and ilLegacyFormElementsUtil\prepareFormOutput().

                                                                  : array
     {
         $object = $this->objectHelper->getInstanceByObjId($objId);
         $placeholders = $this->defaultPlaceholderValuesObject->getPlaceholderValues($userId, $objId);
 
         $latest_progress = false;
         $ass_id = $object->getCertificateRelevantAssignmentIds($userId);
         if ($ass_id !== []) {
             $latest_progress = $object->getSpecificAssignment(current($ass_id))->getProgressTree();
         }
 
         $type = $object->getSubType();
         $placeholders['PRG_TITLE'] = \ilLegacyFormElementsUtil::prepareFormOutput($object->getTitle());
         $placeholders['PRG_DESCRIPTION'] = \ilLegacyFormElementsUtil::prepareFormOutput($object->getDescription());
         $placeholders['PRG_TYPE'] = \ilLegacyFormElementsUtil::prepareFormOutput($type ? $type->getTitle() : '');
         $placeholders['PRG_POINTS'] = \ilLegacyFormElementsUtil::prepareFormOutput(
             $latest_progress ? (string) $latest_progress->getCurrentAmountOfPoints() : ''
         );
         $placeholders['PRG_COMPLETION_DATE'] = \ilLegacyFormElementsUtil::prepareFormOutput(
             $latest_progress && $latest_progress->getCompletionDate() instanceof \DateTimeImmutable ? $latest_progress->getCompletionDate(
             )->format('d.m.Y') : ''
         );
         $placeholders['PRG_EXPIRES_AT'] = \ilLegacyFormElementsUtil::prepareFormOutput(
             $latest_progress && $latest_progress->getValidityOfQualification(
             ) instanceof \DateTimeImmutable ? $latest_progress->getValidityOfQualification()->format('d.m.Y') : ''
         );
         return $placeholders;
     }

Here is the call graph for this function:

◆ getPlaceholderValuesForPreview()

ILIAS\StudyProgramme\Certificate\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.

Implements ilCertificatePlaceholderValues.

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

References ilLegacyFormElementsUtil\prepareFormOutput().

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