Adapter class to provide certificate data for the certificate generator. More...

Inheritance diagram for ilCertificateAdapter:

Collaboration diagram for ilCertificateAdapter:

Public Member Functions
	__construct ()
	ilCertificateAdapter constructor. More...

	getCertificatePath ()
	Returns the certificate path (with a trailing path separator) More...

	getCertificateVariablesForPreview ()
	Returns an array containing all variables and values which can be exchanged in the certificate. More...

	getCertificateVariablesForPresentation ($params=array())
	Returns an array containing all variables and values which can be exchanged in the certificate The values should be calculated from real data. More...

	getCertificateVariablesDescription ()
	Returns a description of the available certificate parameters. More...

	getAdapterType ()
	Returns the adapter type This value will be used to generate file names for the certificates. More...

	getCertificateID ()
	Returns a certificate ID This value will be used to generate unique file names for the certificates. More...

	addAdditionalFormElements (&$form, $form_fields)
	Allows to add additional form fields to the certificate editor form This method will be called when the certificate editor form will built using the ilPropertyFormGUI class. More...

	hasAdditionalFormElements ()

	addFormFieldsFromPOST (&$form_fields)
	Allows to add additional form values to the array of form values evaluating a HTTP POST action. More...

	addFormFieldsFromObject (&$form_fields)
	Allows to add additional form values to the array of form values evaluating the associated adapter class if one exists This method will be called when the certificate editor form will be shown and the content of the form has to be retrieved from wherever the form values are saved. More...

	saveFormFields (&$form_fields)
	Allows to save additional adapter form fields This method will be called when the certificate editor form is complete and the form values will be saved. More...

	deleteCertificate ()
	Is called when the certificate is deleted Add some adapter specific code if more work has to be done when the certificate file was deleted. More...

	getCertificateFilename ($params=array())
	Set the name of the certificate file This method will be called when the certificate will be generated. More...

	getUserIdForParams ($a_params)
	Get user id for params. More...

Protected Member Functions
	getBaseVariablesDescription ($a_enable_last_access=true, $a_enable_completion_date=true)
	Get variable descriptions. More...

	getBaseVariablesForPreview ($a_enable_last_access=true, $a_enable_completion_date=true)
	Get variable dummys. More...

	getBaseVariablesForPresentation ($a_user_data, $a_last_access=null, $a_completion_date=false)
	Get variable values. More...

	getUserCompletionDate ($a_user_id, $a_object_id=null)
	Get completion for user. More...

Protected Attributes
	$lng

Detailed Description

Adapter class to provide certificate data for the certificate generator.

Author: Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilCertificateAdapter::__construct ( )

ilCertificateAdapter constructor.

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

    {
        global $DIC;
 
        $this->lng = $DIC['lng'];
        $this->lng->loadLanguageModule('certificate');
    }

References $DIC.

Member Function Documentation

◆ addAdditionalFormElements()

ilCertificateAdapter::addAdditionalFormElements	(	&	$form,
			$form_fields
	)

Allows to add additional form fields to the certificate editor form This method will be called when the certificate editor form will built using the ilPropertyFormGUI class.

Additional fields will be added at the bottom of the form.

Parameters

object	$form	An ilPropertyFormGUI instance
array	$form_fields	An array containing the form values. The array keys are the names of the form fields

Reimplemented in ilExerciseCertificateAdapter, ilSCORMCertificateAdapter, ilTestCertificateAdapter, and ilSkillCertificateAdapter.

Definition at line 88 of file class.ilCertificateAdapter.php.

89 {

90 }

◆ addFormFieldsFromObject()

ilCertificateAdapter::addFormFieldsFromObject ( & $form_fields )

Allows to add additional form values to the array of form values evaluating the associated adapter class if one exists This method will be called when the certificate editor form will be shown and the content of the form has to be retrieved from wherever the form values are saved.

Parameters

array $form_fields A reference to the array of form values

Reimplemented in ilExerciseCertificateAdapter, ilSCORMCertificateAdapter, ilTestCertificateAdapter, and ilSkillCertificateAdapter.

Definition at line 120 of file class.ilCertificateAdapter.php.

121 {

122 }

◆ addFormFieldsFromPOST()

ilCertificateAdapter::addFormFieldsFromPOST ( & $form_fields )

Allows to add additional form values to the array of form values evaluating a HTTP POST action.

This method will be called when the certificate editor form will be saved using the form save button.

Parameters

array $form_fields A reference to the array of form values

Reimplemented in ilExerciseCertificateAdapter, ilSCORMCertificateAdapter, ilTestCertificateAdapter, and ilSkillCertificateAdapter.

Definition at line 108 of file class.ilCertificateAdapter.php.

109 {

110 }

◆ deleteCertificate()

ilCertificateAdapter::deleteCertificate ( )

Is called when the certificate is deleted Add some adapter specific code if more work has to be done when the certificate file was deleted.

Reimplemented in ilSCORMCertificateAdapter, and ilSkillCertificateAdapter.

Definition at line 140 of file class.ilCertificateAdapter.php.

141 {

142 }

◆ getAdapterType()

ilCertificateAdapter::getAdapterType ( )

abstract

Returns the adapter type This value will be used to generate file names for the certificates.

Returns: string A string value to represent the adapter type

Reimplemented in ilCourseCertificateAdapter, ilExerciseCertificateAdapter, ilSCORMCertificateAdapter, ilTestCertificateAdapter, and ilSkillCertificateAdapter.

◆ getBaseVariablesDescription()

ilCertificateAdapter::getBaseVariablesDescription	(	$a_enable_last_access = `true`,
		$a_enable_completion_date = `true`
	)

protected

Get variable descriptions.

Parameters

bool	$a_enable_last_access
bool	$a_enable_completion_date

Returns: array

Definition at line 164 of file class.ilCertificateAdapter.php.

    {
        $vars = array(
            "USER_LOGIN" => $this->lng->txt("certificate_ph_login"),
            "USER_FULLNAME" => $this->lng->txt("certificate_ph_fullname"),
            "USER_FIRSTNAME" => $this->lng->txt("certificate_ph_firstname"),
            "USER_LASTNAME" => $this->lng->txt("certificate_ph_lastname"),
            "USER_TITLE" => $this->lng->txt("certificate_ph_title"),
            "USER_SALUTATION" => $this->lng->txt("certificate_ph_salutation"),
            "USER_BIRTHDAY" => $this->lng->txt("certificate_ph_birthday"),
            "USER_INSTITUTION" => $this->lng->txt("certificate_ph_institution"),
            "USER_DEPARTMENT" => $this->lng->txt("certificate_ph_department"),
            "USER_STREET" => $this->lng->txt("certificate_ph_street"),
            "USER_CITY" => $this->lng->txt("certificate_ph_city"),
            "USER_ZIPCODE" => $this->lng->txt("certificate_ph_zipcode"),
            "USER_COUNTRY" => $this->lng->txt("certificate_ph_country"),
            "USER_MATRICULATION" => $this->lng->txt("certificate_ph_matriculation")
        );
        
        if ($a_enable_last_access) {
            $vars["USER_LASTACCESS"] = $this->lng->txt("certificate_ph_lastaccess");
        }
        
        $vars["DATE"] = $this->lng->txt("certificate_ph_date");
        $vars["DATETIME"] = $this->lng->txt("certificate_ph_datetime");
        
        if ($a_enable_completion_date) {
            $vars["DATE_COMPLETED"] = $this->lng->txt("certificate_ph_date_completed");
            $vars["DATETIME_COMPLETED"] = $this->lng->txt("certificate_ph_datetime_completed");
        }
        
        return $vars;
    }

Referenced by ilCourseCertificateAdapter\getCertificateVariablesDescription(), ilExerciseCertificateAdapter\getCertificateVariablesDescription(), ilSCORMCertificateAdapter\getCertificateVariablesDescription(), ilTestCertificateAdapter\getCertificateVariablesDescription(), and ilSkillCertificateAdapter\getCertificateVariablesDescription().

Here is the caller graph for this function:

◆ getBaseVariablesForPresentation()

ilCertificateAdapter::getBaseVariablesForPresentation	(	$a_user_data,
		$a_last_access = `null`,
		$a_completion_date = `false`
	)

protected

Get variable values.

Parameters

array	$a_user_data
datetime	$a_last_access
datetime	$a_completion_date

Returns: array

Definition at line 253 of file class.ilCertificateAdapter.php.

    {
        $old = ilDatePresentation::useRelativeDates();
        ilDatePresentation::setUseRelativeDates(false);
 
        $salutation = '';
        $gender = $a_user_data['gender'];
        if (is_string($gender) && strlen(trim($gender)) > 0 && strtolower($gender) !== 'n') {
            $salutation = $this->lng->txt("salutation_" . $gender);
        }
 
        $birthday = "";
        if ($a_user_data["birthday"]) {
            $birthday = ilDatePresentation::formatDate(new ilDate($a_user_data["birthday"], IL_CAL_DATE));
        }
        
        $country = $a_user_data["sel_country"];
        if ($country) {
            $this->lng->loadLanguageModule("meta");
            $country = $this->lng->txt("meta_c_" . $country);
        } else {
            $country = $a_user_data["country"];
        }
        
        $vars = array(
            "USER_LOGIN" => ilUtil::prepareFormOutput(trim($a_user_data["login"])),
            "USER_FULLNAME" => ilUtil::prepareFormOutput(trim($a_user_data["title"] . " " . $a_user_data["firstname"] . " " . $a_user_data["lastname"])),
            "USER_FIRSTNAME" => ilUtil::prepareFormOutput($a_user_data["firstname"]),
            "USER_LASTNAME" => ilUtil::prepareFormOutput($a_user_data["lastname"]),
            "USER_TITLE" => ilUtil::prepareFormOutput($a_user_data["title"]),
            "USER_SALUTATION" => ilUtil::prepareFormOutput($salutation),
            "USER_BIRTHDAY" => ilUtil::prepareFormOutput($birthday),
            "USER_INSTITUTION" => ilUtil::prepareFormOutput($a_user_data["institution"]),
            "USER_DEPARTMENT" => ilUtil::prepareFormOutput($a_user_data["department"]),
            "USER_STREET" => ilUtil::prepareFormOutput($a_user_data["street"]),
            "USER_CITY" => ilUtil::prepareFormOutput($a_user_data["city"]),
            "USER_ZIPCODE" => ilUtil::prepareFormOutput($a_user_data["zipcode"]),
            "USER_COUNTRY" => ilUtil::prepareFormOutput($country),
            "USER_MATRICULATION" => ilUtil::prepareFormOutput($a_user_data["matriculation"])
        );
        
        if ($a_last_access) {
            $vars["USER_LASTACCESS"] = ilDatePresentation::formatDate(new ilDateTime($a_last_access, IL_CAL_DATETIME));
        }
        
        $vars["DATE"] = ilDatePresentation::formatDate(new ilDate(time(), IL_CAL_UNIX));
        $vars["DATETIME"] = ilDatePresentation::formatDate(new ilDateTime(time(), IL_CAL_UNIX));
        
        
        if ($a_completion_date) {
            $vars["DATE_COMPLETED"] = ilDatePresentation::formatDate(new ilDate($a_completion_date, IL_CAL_DATETIME));
 
            $dateTime = new ilDateTime($a_completion_date, IL_CAL_DATETIME);
            $vars["DATETIME_COMPLETED"] = ilDatePresentation::formatDate($dateTime);
            $vars["DATETIME_COMPLETED_UNIX"] = $dateTime->get(IL_CAL_UNIX);
        }
        
        ilDatePresentation::setUseRelativeDates($old);
        
        return $vars;
    }

References ilDatePresentation\formatDate(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_UNIX, ilUtil\prepareFormOutput(), ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

Referenced by ilCourseCertificateAdapter\getCertificateVariablesForPresentation(), ilExerciseCertificateAdapter\getCertificateVariablesForPresentation(), ilSCORMCertificateAdapter\getCertificateVariablesForPresentation(), ilTestCertificateAdapter\getCertificateVariablesForPresentation(), and ilSkillCertificateAdapter\getCertificateVariablesForPresentation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBaseVariablesForPreview()

ilCertificateAdapter::getBaseVariablesForPreview	(	$a_enable_last_access = `true`,
		$a_enable_completion_date = `true`
	)

protected

Get variable dummys.

Parameters

bool	$a_enable_last_access
bool	$a_enable_completion_date

Returns: array

Definition at line 205 of file class.ilCertificateAdapter.php.

    {
        $old = ilDatePresentation::useRelativeDates();
        ilDatePresentation::setUseRelativeDates(false);
        
        $vars = array(
            "USER_LOGIN" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_login")),
            "USER_FULLNAME" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_fullname")),
            "USER_FIRSTNAME" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_firstname")),
            "USER_LASTNAME" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_lastname")),
            "USER_TITLE" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_title")),
            "USER_SALUTATION" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_salutation")),
            "USER_BIRTHDAY" => ilDatePresentation::formatDate(new ilDate($this->lng->txt("certificate_var_user_birthday"), IL_CAL_DATE)),
            "USER_INSTITUTION" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_institution")),
            "USER_DEPARTMENT" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_department")),
            "USER_STREET" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_street")),
            "USER_CITY" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_city")),
            "USER_ZIPCODE" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_zipcode")),
            "USER_COUNTRY" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_country")),
            "USER_MATRICULATION" => ilUtil::prepareFormOutput($this->lng->txt("certificate_var_user_matriculation"))
        );
        
        if ($a_enable_last_access) {
            $vars["USER_LASTACCESS"] = ilDatePresentation::formatDate(new ilDateTime(time() - (24 * 60 * 60 * 5), IL_CAL_UNIX));
        };
                
        $vars["DATE"] = ilDatePresentation::formatDate(new ilDate(time(), IL_CAL_UNIX));
        $vars["DATETIME"] = ilDatePresentation::formatDate(new ilDateTime(time(), IL_CAL_UNIX));
        
        if ($a_enable_completion_date) {
            $vars["DATE_COMPLETED"] = ilDatePresentation::formatDate(new ilDate(time() - (24 * 60 * 60 * 5), IL_CAL_UNIX));
            $vars["DATETIME_COMPLETED"] = ilDatePresentation::formatDate(new ilDateTime(time() - (24 * 60 * 60 * 5), IL_CAL_UNIX));
        }
        
        ilDatePresentation::setUseRelativeDates($old);
        
        return $vars;
    }

References ilDatePresentation\formatDate(), IL_CAL_DATE, IL_CAL_UNIX, ilUtil\prepareFormOutput(), ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

Referenced by ilCourseCertificateAdapter\getCertificateVariablesForPreview(), ilExerciseCertificateAdapter\getCertificateVariablesForPreview(), ilSCORMCertificateAdapter\getCertificateVariablesForPreview(), ilTestCertificateAdapter\getCertificateVariablesForPreview(), and ilSkillCertificateAdapter\getCertificateVariablesForPreview().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCertificateFilename()

ilCertificateAdapter::getCertificateFilename ( $params = array() )

Set the name of the certificate file This method will be called when the certificate will be generated.

Returns: string The certificate file name

Reimplemented in ilSCORMCertificateAdapter, and ilSkillCertificateAdapter.

Definition at line 150 of file class.ilCertificateAdapter.php.

    {
        $this->lng->loadLanguageModule("certificate");
 
        return $this->lng->txt("certificate_file_basename") . ".pdf";
    }

◆ getCertificateID()

ilCertificateAdapter::getCertificateID ( )

abstract

Returns a certificate ID This value will be used to generate unique file names for the certificates.

Returns: mixed A unique ID which represents a certificate

Reimplemented in ilCourseCertificateAdapter, ilExerciseCertificateAdapter, ilSCORMCertificateAdapter, ilTestCertificateAdapter, and ilSkillCertificateAdapter.

◆ getCertificatePath()

ilCertificateAdapter::getCertificatePath ( )

abstract

Returns the certificate path (with a trailing path separator)

Returns: string The certificate path

Reimplemented in ilCourseCertificateAdapter, ilExerciseCertificateAdapter, ilSCORMCertificateAdapter, ilTestCertificateAdapter, and ilSkillCertificateAdapter.

◆ getCertificateVariablesDescription()

ilCertificateAdapter::getCertificateVariablesDescription ( )

abstract

Returns a description of the available certificate parameters.

The description will be shown at the bottom of the certificate editor text area.

Returns: string The certificate parameters description

Reimplemented in ilCourseCertificateAdapter, ilExerciseCertificateAdapter, ilSCORMCertificateAdapter, ilTestCertificateAdapter, and ilSkillCertificateAdapter.

◆ getCertificateVariablesForPresentation()

ilCertificateAdapter::getCertificateVariablesForPresentation ( $params = array() )

abstract

Returns an array containing all variables and values which can be exchanged in the certificate The values should be calculated from real data.

The $params parameter array should contain all necessary information to calculate the values.

Parameters

array $params An array of parameters to calculate the certificate parameter values

Returns: array The certificate variables

Reimplemented in ilCourseCertificateAdapter, ilExerciseCertificateAdapter, ilSCORMCertificateAdapter, ilTestCertificateAdapter, and ilSkillCertificateAdapter.

◆ getCertificateVariablesForPreview()

ilCertificateAdapter::getCertificateVariablesForPreview ( )

abstract

Returns an array containing all variables and values which can be exchanged in the certificate.

The values will be taken for the certificate preview.

Returns: array The certificate variables

Reimplemented in ilCourseCertificateAdapter, ilExerciseCertificateAdapter, ilSCORMCertificateAdapter, ilTestCertificateAdapter, and ilSkillCertificateAdapter.

◆ getUserCompletionDate()

ilCertificateAdapter::getUserCompletionDate	(	$a_user_id,
		$a_object_id = `null`
	)

protected

Get completion for user.

Parameters

int	$a_user_id
int	$a_object_id

Returns: string datetime

Definition at line 322 of file class.ilCertificateAdapter.php.

    {
        if (!$a_object_id) {
            $a_object_id = $this->object->getId();
        }
        include_once "Services/Tracking/classes/class.ilLPStatus.php";
        return ilLPStatus::_lookupStatusChanged($a_object_id, $a_user_id);
    }

References ilLPStatus\_lookupStatusChanged().

Referenced by ilExerciseCertificateAdapter\getCertificateVariablesForPresentation(), ilSCORMCertificateAdapter\getCertificateVariablesForPresentation(), and ilTestCertificateAdapter\getCertificateVariablesForPresentation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserIdForParams()

ilCertificateAdapter::getUserIdForParams ( $a_params )

Get user id for params.

Parameters

return

Reimplemented in ilSCORMCertificateAdapter, and ilTestCertificateAdapter.

Definition at line 337 of file class.ilCertificateAdapter.php.

    {
        return $a_params["user_id"];
    }

◆ hasAdditionalFormElements()

ilCertificateAdapter::hasAdditionalFormElements ( )

Returns: bool

Reimplemented in ilSCORMCertificateAdapter.

Definition at line 95 of file class.ilCertificateAdapter.php.

    {
        return false;
    }

◆ saveFormFields()

ilCertificateAdapter::saveFormFields ( & $form_fields )

Allows to save additional adapter form fields This method will be called when the certificate editor form is complete and the form values will be saved.

Parameters

array $form_fields A reference to the array of form values

Reimplemented in ilExerciseCertificateAdapter, ilSCORMCertificateAdapter, ilTestCertificateAdapter, and ilSkillCertificateAdapter.

Definition at line 131 of file class.ilCertificateAdapter.php.

132 {

133 }

Field Documentation

◆ $lng

ilCertificateAdapter::$lng

protected

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

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

Services/Certificate/classes/class.ilCertificateAdapter.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAdditionalFormElements()

◆ addFormFieldsFromObject()

◆ addFormFieldsFromPOST()

◆ deleteCertificate()

◆ getAdapterType()

◆ getBaseVariablesDescription()

◆ getBaseVariablesForPresentation()

◆ getBaseVariablesForPreview()

◆ getCertificateFilename()

◆ getCertificateID()

◆ getCertificatePath()

◆ getCertificateVariablesDescription()

◆ getCertificateVariablesForPresentation()

◆ getCertificateVariablesForPreview()

◆ getUserCompletionDate()

◆ getUserIdForParams()

◆ hasAdditionalFormElements()

◆ saveFormFields()

Field Documentation

◆ $lng