Exercise certificate adapter. More...

Inheritance diagram for ilExerciseCertificateAdapter:

Collaboration diagram for ilExerciseCertificateAdapter:

Public Member Functions
	__construct ($object)
	ilTestCertificateAdapter contructor 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...

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

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

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

	hasUserCertificate (int $userId)
	This code was orignaly located in `ilObjExercise` and has been moved here for `ilCertificateMigrationJob` More...

Public Member Functions inherited from ilCertificateAdapter
	__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 Attributes
	$object

Protected Attributes inherited from ilCertificateAdapter
	$lng

Additional Inherited Members
Protected Member Functions inherited from ilCertificateAdapter
	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...

Detailed Description

Exercise certificate adapter.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

Definition at line 33 of file class.ilExerciseCertificateAdapter.php.

Constructor & Destructor Documentation

◆ __construct()

ilExerciseCertificateAdapter::__construct ( $object )

ilTestCertificateAdapter contructor

Parameters

object $object A reference to a test object

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

    {
        $this->object = $object;
        parent::__construct();
    }

References $object.

Member Function Documentation

◆ addAdditionalFormElements()

ilExerciseCertificateAdapter::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 from ilCertificateAdapter.

Definition at line 135 of file class.ilExerciseCertificateAdapter.php.

    {
        $visibility = new ilRadioGroupInputGUI($this->lng->txt("certificate_visibility"), "certificate_visibility");
        $visibility->addOption(new ilRadioOption($this->lng->txt("certificate_visibility_always"), 0));
        $visibility->addOption(new ilRadioOption($this->lng->txt("certificate_visibility_passed_exercise"), 1));
        $visibility->addOption(new ilRadioOption($this->lng->txt("certificate_visibility_never"), 2));
        $visibility->setValue($form_fields["certificate_visibility"]);
        if (count($_POST)) {
            $visibility->checkInput();
        }
        $form->addItem($visibility);
    }

References $_POST, and $form.

◆ addFormFieldsFromObject()

ilExerciseCertificateAdapter::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 from ilCertificateAdapter.

Definition at line 153 of file class.ilExerciseCertificateAdapter.php.

    {
        $form_fields["certificate_visibility"] = $this->object->getCertificateVisibility();
    }

◆ addFormFieldsFromPOST()

ilExerciseCertificateAdapter::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 from ilCertificateAdapter.

Definition at line 148 of file class.ilExerciseCertificateAdapter.php.

    {
        $form_fields["certificate_visibility"] = $_POST["certificate_visibility"];
    }

References $_POST.

◆ getAdapterType()

ilExerciseCertificateAdapter::getAdapterType ( )

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 from ilCertificateAdapter.

Definition at line 169 of file class.ilExerciseCertificateAdapter.php.

    {
        return "exc";
    }

◆ getCertificateID()

ilExerciseCertificateAdapter::getCertificateID ( )

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 from ilCertificateAdapter.

Definition at line 180 of file class.ilExerciseCertificateAdapter.php.

    {
        return $this->object->getId();
    }

◆ getCertificatePath()

ilExerciseCertificateAdapter::getCertificatePath ( )

Returns the certificate path (with a trailing path separator)

Returns: string The certificate path

Reimplemented from ilCertificateAdapter.

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

    {
        return CLIENT_WEB_DIR . "/exercise/certificates/" . $this->object->getId() . "/";
    }

◆ getCertificateVariablesDescription()

ilExerciseCertificateAdapter::getCertificateVariablesDescription ( )

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 from ilCertificateAdapter.

Definition at line 115 of file class.ilExerciseCertificateAdapter.php.

    {
        $vars = $this->getBaseVariablesDescription(false);
        $vars["RESULT_PASSED"] = $this->lng->txt("certificate_ph_passed_exercise");
        $vars["RESULT_MARK"] = $this->lng->txt("certificate_ph_mark");
        $vars["EXERCISE_TITLE"] = $this->lng->txt("certificate_ph_exercisetitle");
                
        $template = new ilTemplate("tpl.certificate_edit.html", true, true, "Modules/Exercise");
        $template->setCurrentBlock("items");
        foreach ($vars as $id => $caption) {
            $template->setVariable("ID", $id);
            $template->setVariable("TXT", $caption);
            $template->parseCurrentBlock();
        }
 
        $template->setVariable("PH_INTRODUCTION", $this->lng->txt("certificate_ph_introduction"));
 
        return $template->get();
    }

References $id, $template, and ilCertificateAdapter\getBaseVariablesDescription().

Here is the call graph for this function:

◆ getCertificateVariablesForPresentation()

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

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 from ilCertificateAdapter.

Definition at line 86 of file class.ilExerciseCertificateAdapter.php.

    {
        $user_id = $params["user_id"];
        
        include_once 'Services/Tracking/classes/class.ilLPMarks.php';
        $mark = ilLPMarks::_lookupMark($user_id, $this->object->getId());
        include_once 'Modules/Exercise/classes/class.ilExerciseMembers.php';
        $status = ilExerciseMembers::_lookupStatus($this->object->getId(), $user_id);
        
        $user_data = ilObjUser::_lookupFields($user_id);
        $completion_date = $this->getUserCompletionDate($user_id);
        
        $vars = $this->getBaseVariablesForPresentation($user_data, null, $completion_date);
        $vars["RESULT_PASSED"] = ilUtil::prepareFormOutput($this->lng->txt("exc_" . $status));
        $vars["RESULT_MARK"] = ilUtil::prepareFormOutput($mark);
        $vars["EXERCISE_TITLE"] = ilUtil::prepareFormOutput($this->object->getTitle());
        
        foreach ($vars as $id => $caption) {
            $insert_tags["[" . $id . "]"] = $caption;
        }
        return $insert_tags;
    }

References $id, PHPMailer\PHPMailer\$params, ilObjUser\_lookupFields(), ilLPMarks\_lookupMark(), ilExerciseMembers\_lookupStatus(), ilCertificateAdapter\getBaseVariablesForPresentation(), ilCertificateAdapter\getUserCompletionDate(), and ilUtil\prepareFormOutput().

Here is the call graph for this function:

◆ getCertificateVariablesForPreview()

ilExerciseCertificateAdapter::getCertificateVariablesForPreview ( )

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 from ilCertificateAdapter.

Definition at line 64 of file class.ilExerciseCertificateAdapter.php.

    {
        $vars = $this->getBaseVariablesForPreview(false);
        $vars["RESULT_PASSED"] = ilUtil::prepareFormOutput($this->lng->txt("certificate_var_result_passed"));
        $vars["RESULT_MARK"] = ilUtil::prepareFormOutput($this->lng->txt("certificate_var_result_mark_short"));
        $vars["EXERCISE_TITLE"] = ilUtil::prepareFormOutput($this->object->getTitle());
        
        $insert_tags = array();
        foreach ($vars as $id => $caption) {
            $insert_tags["[" . $id . "]"] = $caption;
        }
        return $insert_tags;
    }

References $id, ilCertificateAdapter\getBaseVariablesForPreview(), and ilUtil\prepareFormOutput().

Here is the call graph for this function:

◆ hasUserCertificate()

ilExerciseCertificateAdapter::hasUserCertificate ( int $userId )

This code was orignaly located in ilObjExercise and has been moved here for ilCertificateMigrationJob

Parameters

int	$objectId
int	$userId

Returns: bool

Definition at line 193 of file class.ilExerciseCertificateAdapter.php.

    {
        // show certificate?
        if (ilCertificate::isActive() && ilCertificate::isObjectActive($this->object->getId())) {
            $certificate_visible = $this->object->getCertificateVisibility();
            // if not never
            if ($certificate_visible != 2) {
                // if passed only
                $status = ilExerciseMembers::_lookupStatus($this->object->getId(), $userId);
                if ($certificate_visible == 1 && $status == "passed") {
                    return true;
                }
 
                // always (excluding notgraded)
                elseif ($certificate_visible == 0 && $status != "notgraded") {
                    return true;
                }
            }
        }
 
        return false;
    }

References ilExerciseMembers\_lookupStatus(), ilCertificate\isActive(), and ilCertificate\isObjectActive().

Here is the call graph for this function:

◆ saveFormFields()

ilExerciseCertificateAdapter::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 from ilCertificateAdapter.

Definition at line 158 of file class.ilExerciseCertificateAdapter.php.

    {
        $this->object->saveCertificateVisibility($form_fields["certificate_visibility"]);
    }

Field Documentation

◆ $object

ilExerciseCertificateAdapter::$object

protected

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

Referenced by __construct().

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

Modules/Exercise/classes/class.ilExerciseCertificateAdapter.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAdditionalFormElements()

◆ addFormFieldsFromObject()

◆ addFormFieldsFromPOST()

◆ getAdapterType()

◆ getCertificateID()

◆ getCertificatePath()

◆ getCertificateVariablesDescription()

◆ getCertificateVariablesForPresentation()

◆ getCertificateVariablesForPreview()

◆ hasUserCertificate()

◆ saveFormFields()

Field Documentation

◆ $object