ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
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
ilCertificateUserObjectHelper | null$userObjectHelper
ilCertificateLPStatusHelper | null$lpStatusHelper
ilCertificateUtilHelper | null$utilHelper
ilDatePresentation | null$dateHelper

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

66 {
67 if (null === $language) {
68 global $DIC;
69 $language = $DIC->language();
70 }
71 $this->language = $language;
72
73 if (null === $defaultPlaceholderValues) {
74 $defaultPlaceholderValues = new ilDefaultPlaceholderValues();
75 }
76 $this->defaultPlaceholderValuesObject = $defaultPlaceholderValues;
77
78 if (null === $objectHelper) {
80 }
81 $this->objectHelper = $objectHelper;
82
83 if (null === $userObjectHelper) {
84 $userObjectHelper = new ilCertificateUserObjectHelper();
85 }
86 // $this->userObjectHelper = $userObjectHelper;
87
88 if (null === $lpStatusHelper) {
89 $lpStatusHelper = new ilCertificateLPStatusHelper();
90 }
91 // $this->lpStatusHelper = $lpStatusHelper;
92
93 if (null === $utilHelper) {
95 }
96 $this->utilHelper = $utilHelper;
97
98 if (null === $dateHelper) {
99 $dateHelper = new ilCertificateDateHelper();
100 }
101 // $this->dateHelper = $dateHelper;
102 }
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 $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 123 of file class.ilCmiXapiPlaceholderValues.php.

123 : array
124 {
125 $placeholders = $this->defaultPlaceholderValuesObject->getPlaceholderValues($userId, $objId);
126
127 /* @var ilObjLTIConsumer $object */
128 $object = $this->objectHelper->getInstanceByObjId($objId);
129
130 $placeholders['OBJECT_TITLE'] = $this->utilHelper->prepareFormOutput($object->getTitle());
131 $placeholders['OBJECT_DESCRIPTION'] = $this->utilHelper->prepareFormOutput($object->getDescription());
132
133 $placeholders['REACHED_SCORE'] = $this->utilHelper->prepareFormOutput($this->getReachedScore((int) $objId, (int) $userId));
134
135 return $placeholders;
136 }
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 107 of file class.ilCmiXapiPlaceholderValues.php.

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

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 138 of file class.ilCmiXapiPlaceholderValues.php.

138 : string
139 {
140 try {
142 $objectId,
143 $userId
144 );
145 } catch (ilCmiXapiException $e) {
146 $cmixResult = ilCmiXapiResult::getEmptyInstance();
147 }
148
149 return sprintf('%0.2f %%', $cmixResult->getScore() * 100);
150 }
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: