ILIAS  release_8 Revision v8.24
ilCmiXapiPlaceholderValues Class Reference
+ Inheritance diagram for ilCmiXapiPlaceholderValues:
+ Collaboration diagram for ilCmiXapiPlaceholderValues:

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)
 
 getPlaceholderValues (int $userId, int $objId)
 
 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

 getReachedScore (int $objectId, int $userId)
 

Private Attributes

ilDefaultPlaceholderValues $defaultPlaceholderValuesObject
 
ilCertificateObjectHelper $objectHelper
 
ilCertificateUtilHelper $utilHelper
 
ilLanguage $language
 

Detailed Description

Definition at line 30 of file class.ilCmiXapiPlaceholderValues.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

67 {
68 if (null === $language) {
69 global $DIC;
70 $language = $DIC->language();
71 }
72 $this->language = $language;
73
74 if (null === $defaultPlaceholderValues) {
75 $defaultPlaceholderValues = new ilDefaultPlaceholderValues();
76 }
77 $this->defaultPlaceholderValuesObject = $defaultPlaceholderValues;
78
79 if (null === $objectHelper) {
81 }
82 $this->objectHelper = $objectHelper;
83
84 if (null === $userObjectHelper) {
85 $userObjectHelper = new ilCertificateUserObjectHelper();
86 }
87// $this->userObjectHelper = $userObjectHelper;
88
89 if (null === $lpStatusHelper) {
90 $lpStatusHelper = new ilCertificateLPStatusHelper();
91 }
92// $this->lpStatusHelper = $lpStatusHelper;
93
94 if (null === $utilHelper) {
96 }
97 $this->utilHelper = $utilHelper;
98
99 if (null === $dateHelper) {
100 $dateHelper = new ilCertificateDateHelper();
101 }
102// $this->dateHelper = $dateHelper;
103 }
Just a wrapper class to create Unit Test for other classes.
Collection of basic placeholder values that can be used.
global $DIC
Definition: feed.php:28

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

+ Here is the call graph for this function:

Member Function Documentation

◆ getPlaceholderValues()

ilCmiXapiPlaceholderValues::getPlaceholderValues ( int  $userId,
int  $objId 
)
Returns
mixed[]

Implements ilCertificatePlaceholderValues.

Definition at line 124 of file class.ilCmiXapiPlaceholderValues.php.

124 : array
125 {
126 $placeholders = $this->defaultPlaceholderValuesObject->getPlaceholderValues($userId, $objId);
127
128 /* @var ilObjLTIConsumer $object */
129 $object = $this->objectHelper->getInstanceByObjId($objId);
130
131 $placeholders['OBJECT_TITLE'] = $this->utilHelper->prepareFormOutput($object->getTitle());
132 $placeholders['OBJECT_DESCRIPTION'] = $this->utilHelper->prepareFormOutput($object->getDescription());
133
134 $placeholders['REACHED_SCORE'] = $this->utilHelper->prepareFormOutput($this->getReachedScore((int) $objId, (int) $userId));
135
136 return $placeholders;
137 }
getReachedScore(int $objectId, int $userId)
$objId
Definition: xapitoken.php:57

References $objId, and getReachedScore().

+ Here is the call graph for this function:

◆ getPlaceholderValuesForPreview()

ilCmiXapiPlaceholderValues::getPlaceholderValuesForPreview ( int  $userId,
int  $objId 
)
Returns
mixed[]

Implements ilCertificatePlaceholderValues.

Definition at line 108 of file class.ilCmiXapiPlaceholderValues.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 }

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

+ Here is the call graph for this function:

◆ getReachedScore()

ilCmiXapiPlaceholderValues::getReachedScore ( int  $objectId,
int  $userId 
)
protected

Definition at line 139 of file class.ilCmiXapiPlaceholderValues.php.

139 : string
140 {
141 try {
143 $objectId,
144 $userId
145 );
146 } catch (ilCmiXapiException $e) {
147 $cmixResult = ilCmiXapiResult::getEmptyInstance();
148 }
149
150 return sprintf('%0.2f %%', $cmixResult->getScore() * 100);
151 }
static getInstanceByObjIdAndUsrId(int $objId, int $usrId)

References Vendor\Package\$e, ilCmiXapiResult\getEmptyInstance(), and ilCmiXapiResult\getInstanceByObjIdAndUsrId().

Referenced by getPlaceholderValues().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $defaultPlaceholderValuesObject

ilDefaultPlaceholderValues ilCmiXapiPlaceholderValues::$defaultPlaceholderValuesObject
private

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

◆ $language

ilLanguage ilCmiXapiPlaceholderValues::$language
private

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

Referenced by __construct().

◆ $objectHelper

ilCertificateObjectHelper ilCmiXapiPlaceholderValues::$objectHelper
private

Definition at line 34 of file class.ilCmiXapiPlaceholderValues.php.

Referenced by __construct().

◆ $utilHelper

ilCertificateUtilHelper ilCmiXapiPlaceholderValues::$utilHelper
private

Definition at line 38 of file class.ilCmiXapiPlaceholderValues.php.

Referenced by __construct().


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