ilCoursePlaceholderValues Class Reference

Inheritance diagram for ilCoursePlaceholderValues:

Collaboration diagram for ilCoursePlaceholderValues:

Public Member Functions
	__construct (ilObjectCustomUserFieldsPlaceholderValues $customUserFieldsPlaceholderValues=null, ilDefaultPlaceholderValues $defaultPlaceholderValues=null, ilLanguage $language=null, ilCertificateObjectHelper $objectHelper=null, ilCertificateParticipantsHelper $participantsHelper=null, ilCertificateUtilHelper $ilUtilHelper=null, ilCertificateDateHelper $dateHelper=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 Member Functions
	hasCompletionDate ($possibleDate)

Private Attributes
	$defaultPlaceholderValuesObject
	$customUserFieldsPlaceholderValuesObject
	$language
	$objectHelper
	$participantsHelper
	$ilUtilHelper
	$dateHelper
	$lpStatusHelper

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilCoursePlaceholderValues::__construct	(	ilObjectCustomUserFieldsPlaceholderValues	$customUserFieldsPlaceholderValues = null,
		ilDefaultPlaceholderValues	$defaultPlaceholderValues = null,
		ilLanguage	$language = null,
		ilCertificateObjectHelper	$objectHelper = null,
		ilCertificateParticipantsHelper	$participantsHelper = null,
		ilCertificateUtilHelper	$ilUtilHelper = null,
		ilCertificateDateHelper	$dateHelper = null,
		ilCertificateLPStatusHelper	$lpStatusHelper = null
	)

Parameters

ilObjectCustomUserFieldsPlaceholderValues | null	$customUserFieldsPlaceholderValues
ilDefaultPlaceholderValues	$defaultPlaceholderValues
ilLanguage | null	$language
ilCertificateObjectHelper | null	$objectHelper
ilCertificateParticipantsHelper | null	$participantsHelper
ilCertificateUtilHelper	$ilUtilHelper
ilCertificateDateHelper | null	$dateHelper
ilCertificateLPStatusHelper | null	$lpStatusHelper

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

References $dateHelper, $DIC, $ilUtilHelper, $language, $lpStatusHelper, $objectHelper, $participantsHelper, and language().

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

        if (null === $defaultPlaceholderValues) {
            $defaultPlaceholderValues = new ilDefaultPlaceholderValues();
        }

        if (null === $customUserFieldsPlaceholderValues) {
            $customUserFieldsPlaceholderValues = new ilObjectCustomUserFieldsPlaceholderValues();
        }

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

        if (null === $participantsHelper) {
            $participantsHelper = new ilCertificateParticipantsHelper();
        }
        $this->participantsHelper = $participantsHelper;

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

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

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

        $this->customUserFieldsPlaceholderValuesObject = $customUserFieldsPlaceholderValues;
        $this->defaultPlaceholderValuesObject = $defaultPlaceholderValues;
    }

Here is the call graph for this function:

Member Function Documentation

getPlaceholderValues()

ilCoursePlaceholderValues::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

Returns

array - [PLACEHOLDER] => 'actual value'

Exceptions

ilException

Implements ilCertificatePlaceholderValues.

Definition at line 137 of file class.ilCoursePlaceholderValues.php.

References hasCompletionDate().

                                                                  : array
    {
        $courseObject = $this->objectHelper->getInstanceByObjId($objId);

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

        $customUserFieldsPlaceholders = $this->customUserFieldsPlaceholderValuesObject->getPlaceholderValues($userId, $objId);

        $placeholders = array_merge($placeholders, $customUserFieldsPlaceholders);

        $completionDate = $this->participantsHelper->getDateTimeOfPassed($objId, $userId);
        if (!$this->hasCompletionDate($completionDate)) {
            $completionDate = $this->lpStatusHelper->lookupStatusChanged($objId, $userId);
        }

        if ($this->hasCompletionDate($completionDate)) {
            $placeholders['DATE_COMPLETED'] = $this->dateHelper->formatDate($completionDate);
            $placeholders['DATETIME_COMPLETED'] = $this->dateHelper->formatDateTime($completionDate);
        }

        $placeholders['COURSE_TITLE'] = $this->ilUtilHelper->prepareFormOutput($courseObject->getTitle());

        return $placeholders;
    }

Here is the call graph for this function:

getPlaceholderValuesForPreview()

ilCoursePlaceholderValues::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 170 of file class.ilCoursePlaceholderValues.php.

References ilUtil\prepareFormOutput().

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

        $customUserFieldsPlaceholders = $this->customUserFieldsPlaceholderValuesObject->getPlaceholderValuesForPreview($userId, $objId);

        $placeholders = array_merge($placeholders, $customUserFieldsPlaceholders);

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

        $placeholders['COURSE_TITLE'] = ilUtil::prepareFormOutput($object->getTitle());

        return $placeholders;
    }

Here is the call graph for this function:

hasCompletionDate()

ilCoursePlaceholderValues::hasCompletionDate (   $possibleDate )

private

Parameters

mixed

$possibleDate

Returns

bool

Definition at line 117 of file class.ilCoursePlaceholderValues.php.

Referenced by getPlaceholderValues().

                                                      : bool
    {
        return (
            $possibleDate !== false &&
            $possibleDate !== null &&
            $possibleDate !== ''
        );
    }

Here is the caller graph for this function:

Field Documentation

$customUserFieldsPlaceholderValuesObject

ilCoursePlaceholderValues::$customUserFieldsPlaceholderValuesObject

private

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

$dateHelper

ilCoursePlaceholderValues::$dateHelper

private

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

Referenced by __construct().

$defaultPlaceholderValuesObject

ilCoursePlaceholderValues::$defaultPlaceholderValuesObject

private

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

$ilUtilHelper

ilCoursePlaceholderValues::$ilUtilHelper

private

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

Referenced by __construct().

$language

ilCoursePlaceholderValues::$language

private

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

Referenced by __construct().

$lpStatusHelper

ilCoursePlaceholderValues::$lpStatusHelper

private

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

Referenced by __construct().

$objectHelper

ilCoursePlaceholderValues::$objectHelper

private

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

Referenced by __construct().

$participantsHelper

ilCoursePlaceholderValues::$participantsHelper

private

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

Referenced by __construct().

---

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

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