ilScormPlaceholderValues Class Reference

Inheritance diagram for ilScormPlaceholderValues:

Collaboration diagram for ilScormPlaceholderValues:

Public Member Functions
	__construct (ilDefaultPlaceholderValues $defaultPlaceholderValues=null, ilLanguage $language=null, ilCertificateDateHelper $dateHelper=null, ilCertificateObjectHelper $objectHelper=null, ilCertificateUtilHelper $utilHelper=null, ilCertificateObjectLPHelper $objectLPHelper=null, ilCertificateLPStatusHelper $lpStatusHelper=null)
	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 Attributes
	$language
	$defaultPlaceholderValuesObject
	$dateHelper
	$objectHelper
	$utilHelper
	$objectLPHelper
	$lpStatusHelper

Detailed Description

Author

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

Definition at line 7 of file class.ilScormPlaceholderValues.php.

Constructor & Destructor Documentation

__construct()

ilScormPlaceholderValues::__construct	(	ilDefaultPlaceholderValues	$defaultPlaceholderValues = null,
		ilLanguage	$language = null,
		ilCertificateDateHelper	$dateHelper = null,
		ilCertificateObjectHelper	$objectHelper = null,
		ilCertificateUtilHelper	$utilHelper = null,
		ilCertificateObjectLPHelper	$objectLPHelper = null,
		ilCertificateLPStatusHelper	$lpStatusHelper = null
	)

Parameters

ilDefaultPlaceholderValues | null	$defaultPlaceholderValues
ilLanguage | null	$language
ilCertificateDateHelper | null	$dateHelper
ilCertificateObjectHelper | null	$objectHelper
ilCertificateUtilHelper | null	$utilHelper
ilCertificateObjectLPHelper | null	$objectLPHelper
ilCertificateLPStatusHelper | null	$lpStatusHelper

Definition at line 53 of file class.ilScormPlaceholderValues.php.

References $dateHelper, $DIC, $language, $lpStatusHelper, $objectHelper, $objectLPHelper, $utilHelper, and language().

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

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

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

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

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

        if (null === $objectLPHelper) {
            $objectLPHelper = new ilCertificateObjectLPHelper();
        }
        $this->objectLPHelper = $objectLPHelper;

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

Here is the call graph for this function:

Member Function Documentation

getPlaceholderValues()

ilScormPlaceholderValues::getPlaceholderValues	(	int	$userId,
		int	$objId
	)

This method MUST return an array that contains the actual data for the given user of the given object.

ilInvalidCertificateException MUST be thrown if the data could not be determined or the user did NOT achieve the certificate.

Parameters

$userId
$objId

Exceptions

ilInvalidCertificateException

Returns

mixed - [PLACEHOLDER] => 'actual value'

Exceptions

ilException

Implements ilCertificatePlaceholderValues.

Definition at line 114 of file class.ilScormPlaceholderValues.php.

References language().

                                                                  : array
    {
        $this->language->loadLanguageModule('certificate');

        $object = $this->objectHelper->getInstanceByObjId($objId);
        $points = $object->getPointsInPercent();
        $txtPoints = number_format($points, 1, $this->language->txt('lang_sep_decimal'), $this->language->txt('lang_sep_thousand')) . ' %';
        if (is_null($points)) {
            $txtPoints = $this->language->txt('certificate_points_notavailable');
        }

        $max_points = $object->getMaxPoints();
        $txtMaxPoints = $max_points;
        if (is_null($max_points)) {
            $txtMaxPoints = $this->language->txt('certificate_points_notavailable');
        } elseif ($max_points != floor($max_points)) {
            $txtMaxPoints = number_format($max_points, 1, $this->language->txt('lang_sep_decimal'), $this->language->txt('lang_sep_thousand'));
        }

        $completionDate = $this->lpStatusHelper->lookupStatusChanged($objId, $userId);

        $placeHolders = $this->defaultPlaceholderValuesObject->getPlaceholderValues($userId, $objId);

        $placeHolders['SCORM_TITLE'] = $this->utilHelper->prepareFormOutput($object->getTitle());
        $placeHolders['SCORM_POINTS'] = $txtPoints;
        $placeHolders['SCORM_POINTS_MAX'] = $txtMaxPoints;

        $placeHolders['DATE_COMPLETED'] = '';
        $placeHolders['DATETIME_COMPLETED'] = '';

        if ($completionDate !== false &&
            $completionDate !== null &&
            $completionDate !== ''
        ) {
            $placeHolders['DATE_COMPLETED'] = $this->dateHelper->formatDate($completionDate);
            $placeHolders['DATETIME_COMPLETED'] = $this->dateHelper->formatDateTime($completionDate);
        }

        $olp = $this->objectLPHelper->getInstance($object->getId());
        $collection = $olp->getCollectionInstance();

        if ($collection) {
            $counter = 0;
            foreach ($collection->getPossibleItems() as $item_id => $sahs_item) {
                if ($collection->isAssignedEntry($item_id)) {
                    $placeHolders['SCO_T_' . $counter] = $sahs_item['title'];
                    $a_scores = $collection->getScoresForUserAndCP_Node_Id($item_id, $userId);

                    $placeHolders['SCO_P_' . $counter] = $this->language->txt('certificate_points_notavailable');
                    if ($a_scores['raw'] !== null) {
                        $placeHolders['SCO_P_' . $counter] = number_format(
                            $a_scores['raw'],
                            1,
                            $this->language->txt('lang_sep_decimal'),
                            $this->language->txt('lang_sep_thousand')
                        );
                    }

                    $placeHolders['SCO_PM_' . $counter] = $this->language->txt('certificate_points_notavailable');
                    if ($a_scores['max'] !== null) {
                        $placeHolders['SCO_PM_' . $counter] = number_format(
                            $a_scores['max'],
                            1,
                            $this->language->txt('lang_sep_decimal'),
                            $this->language->txt('lang_sep_thousand')
                        );
                    }

                    $placeHolders['SCO_PP_' . $counter] = $this->language->txt('certificate_points_notavailable');
                    if ($a_scores['scaled'] !== null) {
                        $placeHolders['SCO_PP_' . $counter] = number_format(
                            ($a_scores['scaled'] * 100),
                            1,
                            $this->language->txt('lang_sep_decimal'),
                            $this->language->txt('lang_sep_thousand')
                        );

                        $placeHolders['SCO_PP_' . $counter] .= ' %';
                    }

                    $counter++;
                }
            }
        }

        return $placeHolders;
    }

Here is the call graph for this function:

getPlaceholderValuesForPreview()

ilScormPlaceholderValues::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.

Parameters

int	$userId
int	$objId

Returns

array

Implements ilCertificatePlaceholderValues.

Definition at line 211 of file class.ilScormPlaceholderValues.php.

References language().

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

        $object = $this->objectHelper->getInstanceByObjId($objId);

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

        $placeholders['SCORM_POINTS'] = number_format(
            80.7,
            1,
            $this->language->txt('lang_sep_decimal'),
            $this->language->txt('lang_sep_thousand')
        ) . ' %';

        $placeholders['SCORM_POINTS_MAX'] = number_format(
            90,
            0,
            $this->language->txt('lang_sep_decimal'),
            $this->language->txt('lang_sep_thousand')
        );

        $insert_tags = array();
        foreach ($placeholders as $id => $caption) {
            $insert_tags[$id] = $caption;
        }

        $olp = $this->objectLPHelper->getInstance($objId);
        $collection = $olp->getCollectionInstance();

        if ($collection) {
            $counter = 0;
            foreach ($collection->getPossibleItems() as $item_id => $sahs_item) {
                if ($collection->isAssignedEntry($item_id)) {
                    $insert_tags['SCO_T_' . $counter] = $sahs_item['title'];

                    $insert_tags['SCO_P_' . $counter] = number_format(
                        30.3,
                        1,
                        $this->language->txt('lang_sep_decimal'),
                        $this->language->txt('lang_sep_thousand')
                    );

                    $insert_tags['SCO_PM_' . $counter] = number_format(
                        90.9,
                        1,
                        $this->language->txt('lang_sep_decimal'),
                        $this->language->txt('lang_sep_thousand')
                    );

                    $insert_tags['SCO_PP_' . $counter] = number_format(
                        33.3333,
                        1,
                        $this->language->txt('lang_sep_decimal'),
                        $this->language->txt('lang_sep_thousand')
                    ) . ' %';

                    $counter++;
                }
            }
        }

        return $insert_tags;
    }

Here is the call graph for this function:

Field Documentation

$dateHelper

ilScormPlaceholderValues::$dateHelper

private

Definition at line 22 of file class.ilScormPlaceholderValues.php.

Referenced by __construct().

$defaultPlaceholderValuesObject

ilScormPlaceholderValues::$defaultPlaceholderValuesObject

private

Definition at line 17 of file class.ilScormPlaceholderValues.php.

$language

ilScormPlaceholderValues::$language

private

Definition at line 12 of file class.ilScormPlaceholderValues.php.

Referenced by __construct().

$lpStatusHelper

ilScormPlaceholderValues::$lpStatusHelper

private

Definition at line 42 of file class.ilScormPlaceholderValues.php.

Referenced by __construct().

$objectHelper

ilScormPlaceholderValues::$objectHelper

private

Definition at line 27 of file class.ilScormPlaceholderValues.php.

Referenced by __construct().

$objectLPHelper

ilScormPlaceholderValues::$objectLPHelper

private

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

Referenced by __construct().

$utilHelper

ilScormPlaceholderValues::$utilHelper

private

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

Referenced by __construct().

---

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

• Services/Certificate/classes/Placeholder/Values/class.ilScormPlaceholderValues.php