ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilLTIConsumerPlaceholderValues Class Reference
+ Inheritance diagram for ilLTIConsumerPlaceholderValues:
+ Collaboration diagram for ilLTIConsumerPlaceholderValues:

Public Member Functions

 __construct (?ilDefaultPlaceholderValues $defaultPlaceholderValues=null, ?ilLanguage $language=null, ?ilCertificateObjectHelper $objectHelper=null, ?ilCertificateUserObjectHelper $userObjectHelper=null, ?ilCertificateLPStatusHelper $lpStatusHelper=null, ?ilCertificateUtilHelper $utilHelper=null, ?ilCertificateDateHelper $dateHelper=null)
 
 getPlaceholderValuesForPreview (int $userId, int $objId)
 
- 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...
 

Protected Member Functions

 getMasteryScore (ilObjLTIConsumer $object)
 
 getReachedScore (ilObjLTIConsumer $object, int $userId)
 

Private Attributes

ilDefaultPlaceholderValues $defaultPlaceholderValuesObject
 
ilCertificateObjectHelper $objectHelper
 
ilCertificateUtilHelper $utilHelper
 
ilCertificateLPStatusHelper $lpStatusHelper
 
 $dateHelper
 
ilLanguage $language
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilLTIConsumerPlaceholderValues::__construct ( ?ilDefaultPlaceholderValues  $defaultPlaceholderValues = null,
?ilLanguage  $language = null,
?ilCertificateObjectHelper  $objectHelper = null,
?ilCertificateUserObjectHelper  $userObjectHelper = null,
?ilCertificateLPStatusHelper  $lpStatusHelper = null,
?ilCertificateUtilHelper  $utilHelper = null,
?ilCertificateDateHelper  $dateHelper = null 
)
Parameters
ilDefaultPlaceholderValues | null$defaultPlaceholderValues
ilLanguage | null$language
ilCertificateObjectHelper | null$objectHelper
ilCertificateUserObjectHelper | null$userObjectHelper
ilCertificateLPStatusHelper | null$lpStatusHelper
ilCertificateUtilHelper | null$utilHelper
ilCertificateDateHelper | null$dateHelper

Definition at line 57 of file class.ilLTIConsumerPlaceholderValues.php.

65 {
66 if (null === $language) {
67 global $DIC; /* @var \ILIAS\DI\Container $DIC */
68 $language = $DIC->language();
69 }
70 $this->language = $language;
71
72 if (null === $defaultPlaceholderValues) {
73 $defaultPlaceholderValues = new ilDefaultPlaceholderValues();
74 }
75 $this->defaultPlaceholderValuesObject = $defaultPlaceholderValues;
76
77 if (null === $objectHelper) {
79 }
80 $this->objectHelper = $objectHelper;
81
82 if (null === $userObjectHelper) {
83 $userObjectHelper = new ilCertificateUserObjectHelper();
84 }
85 // $this->userObjectHelper = $userObjectHelper;
86
87 if (null === $lpStatusHelper) {
89 }
90 $this->lpStatusHelper = $lpStatusHelper;
91
92 if (null === $utilHelper) {
94 }
95 $this->utilHelper = $utilHelper;
96
97 if (null === $dateHelper) {
99 }
100 $this->dateHelper = $dateHelper;
101 }
Just a wrapper class to create Unit Test for other classes.
Collection of basic placeholder values that can be used.
global $DIC
Definition: shib_login.php:26

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

+ Here is the call graph for this function:

Member Function Documentation

◆ getMasteryScore()

ilLTIConsumerPlaceholderValues::getMasteryScore ( ilObjLTIConsumer  $object)
protected

Definition at line 156 of file class.ilLTIConsumerPlaceholderValues.php.

156 : string
157 {
158 return sprintf('%0.2f %%', $object->getMasteryScorePercent());
159 }

References ilObjLTIConsumer\getMasteryScorePercent().

+ Here is the call graph for this function:

◆ getPlaceholderValuesForPreview()

ilLTIConsumerPlaceholderValues::getPlaceholderValuesForPreview ( int  $userId,
int  $objId 
)
Exceptions
ilDateTimeException
ilException
Returns
mixed[]

Implements ilCertificatePlaceholderValues.

Definition at line 108 of file class.ilLTIConsumerPlaceholderValues.php.

108 : array
109 {
110 $placeholders = $this->defaultPlaceholderValuesObject->getPlaceholderValuesForPreview($userId, $objId);
111
112 $placeholders['OBJECT_TITLE'] = $this->utilHelper->prepareFormOutput($this->language->txt('lti_cert_ph_object_title'));
113 $placeholders['OBJECT_DESCRIPTION'] = $this->utilHelper->prepareFormOutput($this->language->txt('lti_cert_ph_object_description'));
114
115 $placeholders['MASTERY_SCORE'] = $this->utilHelper->prepareFormOutput($this->language->txt('lti_cert_ph_mastery_score'));
116 $placeholders['REACHED_SCORE'] = $this->utilHelper->prepareFormOutput($this->language->txt('lti_cert_ph_reached_score'));
117
118 return $placeholders;
119 }
$objId
Definition: xapitoken.php:57

References $objId, and ILIAS\UI\examples\Symbol\Glyph\Language\language().

+ Here is the call graph for this function:

◆ getReachedScore()

ilLTIConsumerPlaceholderValues::getReachedScore ( ilObjLTIConsumer  $object,
int  $userId 
)
protected

Definition at line 161 of file class.ilLTIConsumerPlaceholderValues.php.

161 : string
162 {
163 $userResult = ilLTIConsumerResult::getByKeys($object->getId(), $userId);
164
165 $reachedScore = sprintf('%0.2f %%', 0);
166 if ($userResult !== null) {
167 $reachedScore = sprintf('%0.2f %%', $userResult->getResult() * 100);
168 }
169
170 return $reachedScore;
171 }
static getByKeys(int $a_obj_id, int $a_usr_id, ?bool $a_create=false)
Get a result by object and user key.

References ilLTIConsumerResult\getByKeys(), and ilObject\getId().

+ Here is the call graph for this function:

Field Documentation

◆ $dateHelper

ilLTIConsumerPlaceholderValues::$dateHelper
private

Definition at line 44 of file class.ilLTIConsumerPlaceholderValues.php.

Referenced by __construct().

◆ $defaultPlaceholderValuesObject

ilDefaultPlaceholderValues ilLTIConsumerPlaceholderValues::$defaultPlaceholderValuesObject
private

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

◆ $language

ilLanguage ilLTIConsumerPlaceholderValues::$language
private

Definition at line 46 of file class.ilLTIConsumerPlaceholderValues.php.

Referenced by __construct().

◆ $lpStatusHelper

ilCertificateLPStatusHelper ilLTIConsumerPlaceholderValues::$lpStatusHelper
private

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

Referenced by __construct().

◆ $objectHelper

ilCertificateObjectHelper ilLTIConsumerPlaceholderValues::$objectHelper
private

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

Referenced by __construct().

◆ $utilHelper

ilCertificateUtilHelper ilLTIConsumerPlaceholderValues::$utilHelper
private

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

Referenced by __construct().


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