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)

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.

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

      {
        if (null === $language) {
            global $DIC;
            $language = $DIC->language();
        }
        $this->language = $language;

        if (null === $defaultPlaceholderValues) {
            $defaultPlaceholderValues = new ilDefaultPlaceholderValues();
        }
        $this->defaultPlaceholderValuesObject = $defaultPlaceholderValues;

        if (null === $objectHelper) {
            $objectHelper = new ilCertificateObjectHelper();
        }
        $this->objectHelper = $objectHelper;

        if (null === $userObjectHelper) {
            $userObjectHelper = new ilCertificateUserObjectHelper();
        }
        //        $this->userObjectHelper = $userObjectHelper;

        if (null === $lpStatusHelper) {
            $lpStatusHelper = new ilCertificateLPStatusHelper();
        }
        //        $this->lpStatusHelper = $lpStatusHelper;

        if (null === $utilHelper) {
            $utilHelper = new ilCertificateUtilHelper();
        }
        $this->utilHelper = $utilHelper;

        if (null === $dateHelper) {
            $dateHelper = new ilCertificateDateHelper();
        }
        //        $this->dateHelper = $dateHelper;
    }

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.

References getReachedScore().

                                                                 : array
    {
        $placeholders = $this->defaultPlaceholderValuesObject->getPlaceholderValues($userId, $objId);

        /* @var ilObjLTIConsumer $object */
        $object = $this->objectHelper->getInstanceByObjId($objId);

        $placeholders['OBJECT_TITLE'] = $this->utilHelper->prepareFormOutput($object->getTitle());
        $placeholders['OBJECT_DESCRIPTION'] = $this->utilHelper->prepareFormOutput($object->getDescription());

        $placeholders['REACHED_SCORE'] = $this->utilHelper->prepareFormOutput($this->getReachedScore((int) $objId, (int) $userId));

        return $placeholders;
    }

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.

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

                                                                           : array
    {
        $placeholders = $this->defaultPlaceholderValuesObject->getPlaceholderValuesForPreview($userId, $objId);

        $placeholders['OBJECT_TITLE'] = $this->utilHelper->prepareFormOutput($this->language->txt('lti_cert_ph_object_title'));
        $placeholders['OBJECT_DESCRIPTION'] = $this->utilHelper->prepareFormOutput($this->language->txt('lti_cert_ph_object_description'));

        $placeholders['MASTERY_SCORE'] = $this->utilHelper->prepareFormOutput($this->language->txt('lti_cert_ph_mastery_score'));
        $placeholders['REACHED_SCORE'] = $this->utilHelper->prepareFormOutput($this->language->txt('lti_cert_ph_reached_score'));

        return $placeholders;
    }

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.

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

Referenced by getPlaceholderValues().

                                                                  : string
    {
        try {
            $cmixResult = ilCmiXapiResult::getInstanceByObjIdAndUsrId(
                $objectId,
                $userId
            );
        } catch (ilCmiXapiException $e) {
            $cmixResult = ilCmiXapiResult::getEmptyInstance();
        }

        return sprintf('%0.2f %%', $cmixResult->getScore() * 100);
    }

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:

• components/ILIAS/CmiXapi/classes/Certificate/class.ilCmiXapiPlaceholderValues.php