ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ILIAS\Course\Certificate\CoursePlaceholderValues Class Reference
+ Inheritance diagram for ILIAS\Course\Certificate\CoursePlaceholderValues:
+ Collaboration diagram for ILIAS\Course\Certificate\CoursePlaceholderValues:

Public Member Functions

 __construct (?ilObjectCustomUserFieldsPlaceholderValues $customUserFieldsPlaceholderValues=null, ?ilDefaultPlaceholderValues $defaultPlaceholderValues=null, ?ilLanguage $language=null, ?ilCertificateObjectHelper $objectHelper=null, ?CertificateParticipantsHelper $participantsHelper=null, ?ilCertificateDateHelper $dateHelper=null, ?ilCertificateLPStatusHelper $lpStatusHelper=null)
 
 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...
 
- Public Member Functions inherited from ilCertificatePlaceholderValues
 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 Member Functions

 hasCompletionDate ($possibleDate)
 

Private Attributes

readonly ilDefaultPlaceholderValues $defaultPlaceholderValuesObject
 
readonly ilObjectCustomUserFieldsPlaceholderValues $customUserFieldsPlaceholderValuesObject
 
readonly ilCertificateObjectHelper $objectHelper
 
readonly CertificateParticipantsHelper $participantsHelper
 
readonly ilCertificateDateHelper $dateHelper
 
readonly ilCertificateLPStatusHelper $lpStatusHelper
 

Detailed Description

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

Definition at line 42 of file CoursePlaceholderValues.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Course\Certificate\CoursePlaceholderValues::__construct ( ?ilObjectCustomUserFieldsPlaceholderValues  $customUserFieldsPlaceholderValues = null,
?ilDefaultPlaceholderValues  $defaultPlaceholderValues = null,
?ilLanguage  $language = null,
?ilCertificateObjectHelper  $objectHelper = null,
?CertificateParticipantsHelper  $participantsHelper = null,
?ilCertificateDateHelper  $dateHelper = null,
?ilCertificateLPStatusHelper  $lpStatusHelper = null 
)

Definition at line 51 of file CoursePlaceholderValues.php.

59 {
60 if (null === $language) {
61 global $DIC;
62 $language = $DIC->language();
63 $language->loadLanguageModule('certificate');
64 }
65
66 if (null === $defaultPlaceholderValues) {
67 $defaultPlaceholderValues = new ilDefaultPlaceholderValues();
68 }
69
70 if (null === $customUserFieldsPlaceholderValues) {
71 $customUserFieldsPlaceholderValues = new ilObjectCustomUserFieldsPlaceholderValues();
72 }
73
74 if (null === $objectHelper) {
76 }
77 $this->objectHelper = $objectHelper;
78
79 if (null === $participantsHelper) {
80 $participantsHelper = new CertificateParticipantsHelper();
81 }
82 $this->participantsHelper = $participantsHelper;
83
84 if (null === $dateHelper) {
86 }
87 $this->dateHelper = $dateHelper;
88
89 if (null === $lpStatusHelper) {
91 }
92 $this->lpStatusHelper = $lpStatusHelper;
93
94 $this->customUserFieldsPlaceholderValuesObject = $customUserFieldsPlaceholderValues;
95 $this->defaultPlaceholderValuesObject = $defaultPlaceholderValues;
96 }
readonly ilCertificateLPStatusHelper $lpStatusHelper
readonly CertificateParticipantsHelper $participantsHelper
Collection of basic placeholder values that can be used.
global $DIC
Definition: shib_login.php:26

References ILIAS\Course\Certificate\CoursePlaceholderValues\$dateHelper, $DIC, ILIAS\Course\Certificate\CoursePlaceholderValues\$lpStatusHelper, ILIAS\Course\Certificate\CoursePlaceholderValues\$objectHelper, and ILIAS\Course\Certificate\CoursePlaceholderValues\$participantsHelper.

Member Function Documentation

◆ getPlaceholderValuesForPreview()

ILIAS\Course\Certificate\CoursePlaceholderValues::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.

Exceptions
ilDatabaseException
ilDateTimeException
ilException
ilObjectNotFoundException

Implements ilCertificatePlaceholderValues.

Definition at line 175 of file CoursePlaceholderValues.php.

175 : array
176 {
177 $placeholders = $this->defaultPlaceholderValuesObject->getPlaceholderValuesForPreview($userId, $objId);
178
179 $customUserFieldsPlaceholders = $this->customUserFieldsPlaceholderValuesObject->getPlaceholderValuesForPreview(
180 $userId,
181 $objId
182 );
183
184 $placeholders = array_merge($placeholders, $customUserFieldsPlaceholders);
185
186 $object = $this->objectHelper->getInstanceByObjId($objId);
187
188 $placeholders['COURSE_TITLE'] = ilLegacyFormElementsUtil::prepareFormOutput($object->getTitle());
189
190 return $placeholders;
191 }
static prepareFormOutput($a_str, bool $a_strip=false)
$objId
Definition: xapitoken.php:57

References $objId, and ilLegacyFormElementsUtil\prepareFormOutput().

+ Here is the call graph for this function:

◆ hasCompletionDate()

ILIAS\Course\Certificate\CoursePlaceholderValues::hasCompletionDate (   $possibleDate)
private
Parameters
mixed$possibleDate

Definition at line 101 of file CoursePlaceholderValues.php.

101 : bool
102 {
103 return
104 $possibleDate !== false &&
105 $possibleDate !== null &&
106 $possibleDate !== ''
107 ;
108 }

Field Documentation

◆ $customUserFieldsPlaceholderValuesObject

readonly ilObjectCustomUserFieldsPlaceholderValues ILIAS\Course\Certificate\CoursePlaceholderValues::$customUserFieldsPlaceholderValuesObject
private

Definition at line 45 of file CoursePlaceholderValues.php.

◆ $dateHelper

readonly ilCertificateDateHelper ILIAS\Course\Certificate\CoursePlaceholderValues::$dateHelper
private

◆ $defaultPlaceholderValuesObject

readonly ilDefaultPlaceholderValues ILIAS\Course\Certificate\CoursePlaceholderValues::$defaultPlaceholderValuesObject
private

Definition at line 44 of file CoursePlaceholderValues.php.

◆ $lpStatusHelper

readonly ilCertificateLPStatusHelper ILIAS\Course\Certificate\CoursePlaceholderValues::$lpStatusHelper
private

◆ $objectHelper

readonly ilCertificateObjectHelper ILIAS\Course\Certificate\CoursePlaceholderValues::$objectHelper
private

◆ $participantsHelper

readonly CertificateParticipantsHelper ILIAS\Course\Certificate\CoursePlaceholderValues::$participantsHelper
private

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