SCORM certificate adapter. More...

Inheritance diagram for ilSCORMCertificateAdapter:

Collaboration diagram for ilSCORMCertificateAdapter:

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

	getCertificateFilename ($params=array())
	Set the name of the certificate file This method will be called when the certificate will be generated. 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...

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

Public Member Functions inherited from ilCertificateAdapter
	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...

	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

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

SCORM certificate adapter.

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 33 of file class.ilSCORMCertificateAdapter.php.

Constructor & Destructor Documentation

◆ __construct()

ilSCORMCertificateAdapter::__construct ( & $object )

ilSCORMCertificateAdapter contructor

Parameters

object $object A reference to a test object

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

References $object.

         {
                 $this->object =& $object;
         }

Member Function Documentation

◆ addAdditionalFormElements()

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

Definition at line 263 of file class.ilSCORMCertificateAdapter.php.

References $_POST, $lng, ilFormPropertyGUI\setInfo(), ilFormPropertyGUI\setRequired(), and ilStr\subStr().

         {
                 global $lng;
                 $short_name = new ilTextInputGUI($lng->txt("certificate_short_name"), "short_name");
                 $short_name->setRequired(TRUE);
                 require_once "./Services/Utilities/classes/class.ilStr.php";
                 $short_name->setValue(strlen($form_fields["short_name"]) ? $form_fields["short_name"] : ilStr::subStr($this->object->getTitle(), 0, 30));
                 $short_name->setSize(30);
                 if (strlen($form_fields["short_name"])) {
                         $short_name->setInfo(str_replace("[SHORT_TITLE]", $form_fields["short_name"], $lng->txt("certificate_short_name_description")));
                 } else {
                         $short_name->setInfo($lng->txt("certificate_short_name_description"));
                 }
                 if (count($_POST)) $short_name->checkInput();
                 $form->addItem($short_name);
 
                 $visibility = new ilCheckboxInputGUI($lng->txt("certificate_enabled_scorm"), "certificate_enabled_scorm");
                 $visibility->setInfo($lng->txt("certificate_enabled_scorm_introduction"));
                 $visibility->setValue(1);
                 if ($form_fields["certificate_enabled_scorm"])
                 {
                         $visibility->setChecked(TRUE);
                 }
                 if (count($_POST)) $visibility->checkInput();
                 $form->addItem($visibility);
         }

Here is the call graph for this function:

◆ addFormFieldsFromObject()

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

Definition at line 312 of file class.ilSCORMCertificateAdapter.php.

References $ilSetting.

         {
                 global $ilSetting;
                 $scormSetting = new ilSetting("scorm");
                 $form_fields["certificate_enabled_scorm"] = $scormSetting->get("certificate_" . $this->object->getId());
                 $form_fields["short_name"] = $scormSetting->get("certificate_short_name_" . $this->object->getId());
         }

◆ addFormFieldsFromPOST()

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

Definition at line 298 of file class.ilSCORMCertificateAdapter.php.

References $_POST.

         {
                 $form_fields["certificate_enabled_scorm"] = $_POST["certificate_enabled_scorm"];
                 $form_fields["short_name"] = $_POST["short_name"];
         }

◆ deleteCertificate()

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

Definition at line 388 of file class.ilSCORMCertificateAdapter.php.

References $ilSetting.

         {
                 global $ilSetting;
                 $scormSetting = new ilSetting("scorm");
                 $scormSetting->delete("certificate_" . $this->object->getId());
         }

◆ getAdapterType()

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

Definition at line 341 of file class.ilSCORMCertificateAdapter.php.

         {
                 return "scorm";
         }

◆ getCertificateFilename()

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

Definition at line 363 of file class.ilSCORMCertificateAdapter.php.

References $ilSetting, and $lng.

         {
                 global $lng;
                 
                 $basename = parent::getCertificateFilename($params);
                 
                 $user_data = $params["user_data"];
                 if (!is_array($user_data))
                 {
                         global $ilSetting;
                         $scormSetting = new ilSetting("scorm");
                         $short_title = $scormSetting->get("certificate_short_name_" . $this->object->getId());
                         return strftime("%y%m%d", time()) . "_" . $lng->txt("certificate_var_user_lastname") . "_" . $short_title . "_" . $basename;
                 }
                 else
                 {
                         return strftime("%y%m%d", time()) . "_" . $user_data["lastname"] . "_" . $params["short_title"] . "_.$basename";
                 }
         }

◆ getCertificateID()

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

Definition at line 352 of file class.ilSCORMCertificateAdapter.php.

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

◆ getCertificatePath()

ilSCORMCertificateAdapter::getCertificatePath ( )

Returns the certificate path (with a trailing path separator)

Returns: string The certificate path

Definition at line 52 of file class.ilSCORMCertificateAdapter.php.

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

◆ getCertificateVariablesDescription()

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

Definition at line 186 of file class.ilSCORMCertificateAdapter.php.

References $lng, ilCertificateAdapter\getBaseVariablesDescription(), and ilObjectLP\getInstance().

         {
                 global $lng;
                 
                 $vars = $this->getBaseVariablesDescription();
                 $vars["SCORM_TITLE"] = $lng->txt("certificate_ph_scormtitle");
                 $vars["SCORM_POINTS"] = $lng->txt("certificate_ph_scormpoints");
                 $vars["SCORM_POINTS_MAX"] = $lng->txt("certificate_ph_scormmaxpoints");
                 
                 $template = new ilTemplate("tpl.certificate_edit.html", TRUE, TRUE, "Modules/ScormAicc");               
                 $template->setCurrentBlock("items");
                 foreach($vars as $id => $caption)
                 {
                         $template->setVariable("ID", $id);
                         $template->setVariable("TXT", $caption);
                         $template->parseCurrentBlock();
                 }
 
                 $template->setVariable("PH_INTRODUCTION", $lng->txt("certificate_ph_introduction"));
 
                 include_once 'Services/Object/classes/class.ilObjectLP.php';
                 $olp = ilObjectLP::getInstance($this->object->getId());
                 $collection = $olp->getCollectionInstance();
                 if($collection)
                 {
                         $items = $collection->getPossibleItems();
                 }
 
                 if(!$items) {
                         $template->setCurrentBlock('NO_SCO');
                         $template->setVariable('PH_NO_SCO',$lng->txt('certificate_ph_no_sco'));
                         $template->parseCurrentBlock();
                 }
                 else {
                         $template->setCurrentBlock('SCOS');
                         $template->setVariable('PH_SCOS',$lng->txt('certificate_ph_scos'));
                         $template->parseCurrentBlock();
                         $template->setCurrentBlock('SCO_HEADER');
                         $template->setVariable('PH_TITLE_SCO',$lng->txt('certificate_ph_title_sco'));
                         //$template->setVariable('PH_PH',$lng->txt('certificate_ph_ph'));
                         $template->setVariable('PH_SCO_TITLE',$lng->txt('certificate_ph_sco_title'));
                         $template->setVariable('PH_SCO_POINTS_RAW',$lng->txt('certificate_ph_sco_points_raw'));
                         $template->setVariable('PH_SCO_POINTS_MAX',$lng->txt('certificate_ph_sco_points_max'));
                         $template->setVariable('PH_SCO_POINTS_SCALED',$lng->txt('certificate_ph_sco_points_scaled'));
                         $template->parseCurrentBlock();
                 }
 
                 if($collection)
                 {
                         $counter=0;
                         foreach($items as $item_id => $sahs_item)
                         {
                                 if($collection->isAssignedEntry($item_id)) {
                                         $template->setCurrentBlock("SCO");
                                         $template->setVariable('SCO_TITLE',$sahs_item['title']);
                                         $template->setVariable('PH_SCO_TITLE','[SCO_T_'.$counter.']');
                                         $template->setVariable('PH_SCO_POINTS_RAW','[SCO_P_'.$counter.']');
                                         $template->setVariable('PH_SCO_POINTS_MAX','[SCO_PM_'.$counter.']');
                                         $template->setVariable('PH_SCO_POINTS_SCALED','[SCO_PP_'.$counter.']');
                                         $template->parseCurrentBlock();
                                         $counter++;
                                 }
                         }
                 }
 
                 return $template->get();
         }

Here is the call graph for this function:

◆ getCertificateVariablesForPresentation()

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

Definition at line 107 of file class.ilSCORMCertificateAdapter.php.

References $ilUser, $lng, ilCertificateAdapter\getBaseVariablesForPresentation(), ilObjectLP\getInstance(), ilCertificateAdapter\getUserCompletionDate(), and ilUtil\prepareFormOutput().

         {
                 global $lng,$ilUser;
                 
                 $lng->loadLanguageModule('certificate');
                                 
                 $points = $this->object->getPointsInPercent();
                 $txtPoints = "";
                 if (is_null($points))
                 {
                         $txtPoints = $lng->txt("certificate_points_notavailable");
                 }
                 else
                 {
                         $txtPoints = number_format($points, 1, $lng->txt("lang_sep_decimal"), $lng->txt("lang_sep_thousand")) . " %";
                 }               
                 
                 $max_points = $this->object->getMaxPoints();
                 $txtMaxPoints = '';
                 if (is_null($max_points))
                 {
                         $txtMaxPoints = $lng->txt("certificate_points_notavailable");
                 }
                 else
                 {
                         if($max_points != floor($max_points))
                         {
                                 $txtMaxPoints = number_format($max_points, 1, $lng->txt("lang_sep_decimal"), $lng->txt("lang_sep_thousand"));
                         }
                         else
                         {
                                 $txtMaxPoints = $max_points;
                         }
                 }
                 
                 $user_data = $params["user_data"];
                 $completion_date = $this->getUserCompletionDate($user_data["usr_id"]);          
                 
                 $vars = $this->getBaseVariablesForPresentation($user_data, $params["last_access"], $completion_date);           
                 $vars["SCORM_TITLE"] = ilUtil::prepareFormOutput($this->object->getTitle());
                 $vars["SCORM_POINTS"] = $txtPoints;
                 $vars["SCORM_POINTS_MAX"] = $txtMaxPoints;
                 
                 foreach($vars as $id => $caption)
                 {
                         $insert_tags["[".$id."]"] = $caption;
                 }
                 
                 include_once 'Services/Object/classes/class.ilObjectLP.php';
                 $olp = ilObjectLP::getInstance($this->object->getId());
                 $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'];//." getId=".$this->object->getId()." item_id=".$item_id." user_id=".$ilUser->getId()
                                         $a_scores = $collection->getScoresForUserAndCP_Node_Id($item_id, $ilUser->getId());
                                         if ($a_scores["raw"] == null) $insert_tags['[SCO_P_'.$counter.']'] = $lng->txt("certificate_points_notavailable");
                                         else $insert_tags['[SCO_P_'.$counter.']'] = number_format($a_scores["raw"], 1, $lng->txt("lang_sep_decimal"), $lng->txt("lang_sep_thousand"));
                                         if ($a_scores["max"] == null) $insert_tags['[SCO_PM_'.$counter.']'] = $lng->txt("certificate_points_notavailable");
                                         else $insert_tags['[SCO_PM_'.$counter.']'] = number_format($a_scores["max"], 1, $lng->txt("lang_sep_decimal"), $lng->txt("lang_sep_thousand"));
                                         if ($a_scores["scaled"] == null) $insert_tags['[SCO_PP_'.$counter.']'] = $lng->txt("certificate_points_notavailable");
                                         else $insert_tags['[SCO_PP_'.$counter.']'] = number_format(($a_scores["scaled"]*100), 1, $lng->txt("lang_sep_decimal"), $lng->txt("lang_sep_thousand")) . " %";
                                         $counter++;
                                 }
                         }
                 }
 
                 return $insert_tags;
         }

Here is the call graph for this function:

◆ getCertificateVariablesForPreview()

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

Definition at line 63 of file class.ilSCORMCertificateAdapter.php.

References $lng, ilCertificateAdapter\getBaseVariablesForPreview(), ilObjectLP\getInstance(), and ilUtil\prepareFormOutput().

         {
                 global $lng;
                 
                 $vars = $this->getBaseVariablesForPreview();
                 $vars["SCORM_TITLE"] = ilUtil::prepareFormOutput($this->object->getTitle());
                 $vars["SCORM_POINTS"] = number_format(80.7, 1, $lng->txt("lang_sep_decimal"), $lng->txt("lang_sep_thousand")) . " %";
                 $vars["SCORM_POINTS_MAX"] = number_format(90, 0, $lng->txt("lang_sep_decimal"), $lng->txt("lang_sep_thousand"));
                 
                 $insert_tags = array();
                 foreach($vars as $id => $caption)
                 {
                         $insert_tags["[".$id."]"] = $caption;
                 }               
 
                 include_once 'Services/Object/classes/class.ilObjectLP.php';
                 $olp = ilObjectLP::getInstance($this->object->getId());
                 $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, $lng->txt("lang_sep_decimal"), $lng->txt("lang_sep_thousand"));
                                         $insert_tags['[SCO_PM_'.$counter.']'] = number_format(90.9, 1, $lng->txt("lang_sep_decimal"), $lng->txt("lang_sep_thousand"));
                                         $insert_tags['[SCO_PP_'.$counter.']'] = number_format(33.3333, 1, $lng->txt("lang_sep_decimal"), $lng->txt("lang_sep_thousand")) . " %";
                                         $counter++;
                                 }
                         }
                 }
 
                 return $insert_tags;
         }

Here is the call graph for this function:

◆ getUserIdForParams()

ilSCORMCertificateAdapter::getUserIdForParams ( $a_params )

Get user id for params.

Parameters

Definition at line 401 of file class.ilSCORMCertificateAdapter.php.

         {
                 return $a_params["user_data"]["usr_id"];
         }

◆ saveFormFields()

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

Definition at line 327 of file class.ilSCORMCertificateAdapter.php.

References $ilSetting.

         {
                 global $ilSetting;
                 $scormSetting = new ilSetting("scorm");
                 $scormSetting->set("certificate_" . $this->object->getId(), $form_fields["certificate_enabled_scorm"]);
                 $scormSetting->set("certificate_short_name_" . $this->object->getId(), $form_fields["short_name"]);
         }

Field Documentation

◆ $object

ilSCORMCertificateAdapter::$object

protected

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

Referenced by __construct().

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

Modules/ScormAicc/classes/class.ilSCORMCertificateAdapter.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAdditionalFormElements()

◆ addFormFieldsFromObject()

◆ addFormFieldsFromPOST()

◆ deleteCertificate()

◆ getAdapterType()

◆ getCertificateFilename()

◆ getCertificateID()

◆ getCertificatePath()

◆ getCertificateVariablesDescription()

◆ getCertificateVariablesForPresentation()

◆ getCertificateVariablesForPreview()

◆ getUserIdForParams()

◆ saveFormFields()

Field Documentation

◆ $object