ilCoursePlaceholderDescription Class Reference

Inheritance diagram for ilCoursePlaceholderDescription:

Collaboration diagram for ilCoursePlaceholderDescription:

Public Member Functions
	__construct (int $objectId, ilDefaultPlaceholderDescription $defaultPlaceholderDescriptionObject=null, ilLanguage $language=null, ilUserDefinedFieldsPlaceholderDescription $userDefinedFieldPlaceHolderDescriptionObject=null, ilObjectCustomUserFieldsPlaceholderDescription $customUserFieldsPlaceholderDescriptionObject=null)
	createPlaceholderHtmlDescription (ilTemplate $template=null)
	This methods MUST return an array containing an array with the the description as array value. More...
	getPlaceholderDescriptions ()
	This method MUST return an array containing an array with the the description as array value. More...
Public Member Functions inherited from ilCertificatePlaceholderDescription
	getPlaceholderDescriptions ()
	This method MUST return an array containing an array with the the description as array value. More...
	createPlaceholderHtmlDescription ()

Private Attributes
	$defaultPlaceHolderDescriptionObject
	$customUserFieldsPlaceholderDescriptionObject
	$language
	$placeholder

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilCoursePlaceholderDescription::__construct	(	int	$objectId,
		ilDefaultPlaceholderDescription	$defaultPlaceholderDescriptionObject = null,
		ilLanguage	$language = null,
		ilUserDefinedFieldsPlaceholderDescription	$userDefinedFieldPlaceHolderDescriptionObject = null,
		ilObjectCustomUserFieldsPlaceholderDescription	$customUserFieldsPlaceholderDescriptionObject = null
	)

Parameters

int	$objectId
ilDefaultPlaceholderDescription | null	$defaultPlaceholderDescriptionObject
ilLanguage | null	$language
ilUserDefinedFieldsPlaceholderDescription | null	$userDefinedFieldPlaceHolderDescriptionObject
ilObjectCustomUserFieldsPlaceholderDescription | null	$customUserFieldsPlaceholderDescriptionObject

Definition at line 35 of file class.ilCoursePlaceholderDescription.php.

      {
        global $DIC;
 
        if (null === $language) {
            $language = $DIC->language();
            $language->loadLanguageModule('certificate');
        }
        $this->language = $language;
 
        if (null === $defaultPlaceholderDescriptionObject) {
            $defaultPlaceholderDescriptionObject = new ilDefaultPlaceholderDescription($language, $userDefinedFieldPlaceHolderDescriptionObject);
        }
        $this->defaultPlaceHolderDescriptionObject = $defaultPlaceholderDescriptionObject;
 
        if (null === $customUserFieldsPlaceholderDescriptionObject) {
            $customUserFieldsPlaceholderDescriptionObject = new ilObjectCustomUserFieldsPlaceholderDescription($objectId);
        }
        $this->customUserFieldsPlaceholderDescriptionObject = $customUserFieldsPlaceholderDescriptionObject;
 
        $customUserFieldsPlaceholderHtmlDescription = $this->customUserFieldsPlaceholderDescriptionObject->getPlaceholderDescriptions();
        $defaultPlaceholderDescription = $this->defaultPlaceHolderDescriptionObject->getPlaceholderDescriptions();
 
        $this->placeholder = array_merge($defaultPlaceholderDescription, $customUserFieldsPlaceholderHtmlDescription);
        $this->placeholder['COURSE_TITLE'] = $this->language->txt('crs_title');
        $this->placeholder['DATE_COMPLETED'] = ilUtil::prepareFormOutput($language->txt('certificate_ph_date_completed'));
        $this->placeholder['DATETIME_COMPLETED'] = ilUtil::prepareFormOutput($language->txt('certificate_ph_datetime_completed'));
    }

References $customUserFieldsPlaceholderDescriptionObject, $DIC, $language, language(), and ilUtil\prepareFormOutput().

Here is the call graph for this function:

Member Function Documentation

createPlaceholderHtmlDescription()

ilCoursePlaceholderDescription::createPlaceholderHtmlDescription

(

ilTemplate

$template = null

)

This methods MUST return an array containing an array with the the description as array value.

Parameters

null

$template

Returns

mixed - [PLACEHOLDER] => 'description'

Definition at line 75 of file class.ilCoursePlaceholderDescription.php.

                                                                                  : string
    {
        if (null === $template) {
            $template = new ilTemplate('tpl.default_description.html', true, true, 'Services/Certificate');
        }
 
        $template->setVariable("PLACEHOLDER_INTRODUCTION", $this->language->txt('certificate_ph_introduction'));
 
        $template->setCurrentBlock("items");
        foreach ($this->placeholder as $id => $caption) {
            $template->setVariable("ID", $id);
            $template->setVariable("TXT", $caption);
            $template->parseCurrentBlock();
        }
 
        return $template->get();
    }

References language().

Here is the call graph for this function:

getPlaceholderDescriptions()

ilCoursePlaceholderDescription::getPlaceholderDescriptions

(

)

This method MUST return an array containing an array with the the description as array value.

Returns

mixed - [PLACEHOLDER] => 'description'

Implements ilCertificatePlaceholderDescription.

Definition at line 98 of file class.ilCoursePlaceholderDescription.php.

                                                 : array
    {
        return $this->placeholder;
    }

References $placeholder.

Field Documentation

$customUserFieldsPlaceholderDescriptionObject

ilCoursePlaceholderDescription::$customUserFieldsPlaceholderDescriptionObject

private

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

Referenced by __construct().

$defaultPlaceHolderDescriptionObject

ilCoursePlaceholderDescription::$defaultPlaceHolderDescriptionObject

private

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

$language

ilCoursePlaceholderDescription::$language

private

Definition at line 21 of file class.ilCoursePlaceholderDescription.php.

Referenced by __construct().

$placeholder

ilCoursePlaceholderDescription::$placeholder

private

Definition at line 26 of file class.ilCoursePlaceholderDescription.php.

Referenced by getPlaceholderDescriptions().

---

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

• Services/Certificate/classes/Placeholder/Description/class.ilCoursePlaceholderDescription.php