ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilCourseCertificateAdapter Class Reference

Test certificate adapter. More...

+ Inheritance diagram for ilCourseCertificateAdapter:
+ Collaboration diagram for ilCourseCertificateAdapter:

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

Static Public Member Functions

static _preloadListData ($a_usr_ids, $a_obj_ids)
 Get certificate/passed status for all given objects and users. More...
 
static _hasUserCertificate ($a_usr_id, $a_obj_id)
 Check if user has certificate for course. More...
 

Protected Attributes

 $object
 

Static Protected Attributes

static $has_certificate = array()
 

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

Test 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
class.ilTestCertificateAdapter.php 30898 2011-09-29 12:47:24Z jluetzen

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

Constructor & Destructor Documentation

◆ __construct()

ilCourseCertificateAdapter::__construct ( $object)

ilTestCertificateAdapter contructor

Parameters
object$objectA reference to a test object

Definition at line 43 of file class.ilCourseCertificateAdapter.php.

44 {
45 global $lng;
46 $this->object =& $object;
47 $lng->loadLanguageModule('certificate');
48 }
global $lng
Definition: privfeed.php:40

References $lng, and $object.

Member Function Documentation

◆ _hasUserCertificate()

static ilCourseCertificateAdapter::_hasUserCertificate (   $a_usr_id,
  $a_obj_id 
)
static

Check if user has certificate for course.

Used in ilObjCourseListGUI

Parameters
int$a_usr_id
int$a_obj_id
Returns
bool

Definition at line 215 of file class.ilCourseCertificateAdapter.php.

216 {
217 self::_preloadListData($a_usr_id, $a_obj_id);
218
219 if (isset(self::$has_certificate[$a_usr_id][$a_obj_id]))
220 {
221 return self::$has_certificate[$a_usr_id][$a_obj_id];
222 }
223 return false;
224 }
static _preloadListData($a_usr_ids, $a_obj_ids)
Get certificate/passed status for all given objects and users.

References _preloadListData().

Referenced by ilCourseVerificationTableGUI\getItems(), and ilObjCourseListGUI\getProperties().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _preloadListData()

static ilCourseCertificateAdapter::_preloadListData (   $a_usr_ids,
  $a_obj_ids 
)
static

Get certificate/passed status for all given objects and users.

Used in ilObjCourseAccess for ilObjCourseListGUI

Parameters
array$a_usr_ids
array$a_obj_ids

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

170 {
171 global $ilDB;
172
173 if (!is_array($a_usr_ids))
174 {
175 $a_usr_ids = array($a_usr_ids);
176 }
177 if (!is_array($a_obj_ids))
178 {
179 $a_obj_ids = array($a_obj_ids);
180 }
181 foreach ($a_usr_ids as $usr_id)
182 {
183 foreach ($a_obj_ids as $obj_id)
184 {
185 self::$has_certificate[$usr_id][$obj_id] = false;
186 }
187 }
188
189 include_once "Services/Certificate/classes/class.ilCertificate.php";
191 {
192 $obj_active = ilCertificate::areObjectsActive($a_obj_ids);
193
194 include_once 'Modules/Course/classes/class.ilCourseParticipants.php';
195 $data = ilCourseParticipants::getPassedUsersForObjects($a_obj_ids, $a_usr_ids);
196 foreach($data as $rec)
197 {
198 if($obj_active[$rec["obj_id"]])
199 {
200 self::$has_certificate[$rec["usr_id"]][$rec["obj_id"]] = true;
201 }
202 }
203 }
204 }
static areObjectsActive(array $a_obj_ids)
static getPassedUsersForObjects(array $a_obj_ids, array $a_usr_ids)
$data
global $ilDB

References $data, $ilDB, ilCertificate\areObjectsActive(), ilCourseParticipants\getPassedUsersForObjects(), and ilCertificate\isActive().

Referenced by _hasUserCertificate(), ilObjCourseAccess\_preloadData(), and ilCourseVerificationTableGUI\getItems().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getAdapterType()

ilCourseCertificateAdapter::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 145 of file class.ilCourseCertificateAdapter.php.

146 {
147 return "course";
148 }

◆ getCertificateID()

ilCourseCertificateAdapter::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 156 of file class.ilCourseCertificateAdapter.php.

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

◆ getCertificatePath()

ilCourseCertificateAdapter::getCertificatePath ( )

Returns the certificate path (with a trailing path separator)

Returns
string The certificate path

Reimplemented from ilCertificateAdapter.

Definition at line 55 of file class.ilCourseCertificateAdapter.php.

56 {
57 return CLIENT_WEB_DIR . "/course/certificates/" . $this->object->getId() . "/";
58 }

◆ getCertificateVariablesDescription()

ilCourseCertificateAdapter::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 118 of file class.ilCourseCertificateAdapter.php.

119 {
120 global $lng;
121
122 $vars = $this->getBaseVariablesDescription(false);
123 $vars["COURSE_TITLE"] = $lng->txt("crs_title");
124
125 $template = new ilTemplate("tpl.il_as_tst_certificate_edit.html", TRUE, TRUE, "Modules/Test");
126 $template->setCurrentBlock("items");
127 foreach($vars as $id => $caption)
128 {
129 $template->setVariable("ID", $id);
130 $template->setVariable("TXT", $caption);
131 $template->parseCurrentBlock();
132 }
133
134 $template->setVariable("PH_INTRODUCTION", $lng->txt("certificate_ph_introduction"));
135
136 return $template->get();
137 }
getBaseVariablesDescription($a_enable_last_access=true, $a_enable_completion_date=true)
Get variable descriptions.
special template class to simplify handling of ITX/PEAR

References $lng, and ilCertificateAdapter\getBaseVariablesDescription().

+ Here is the call graph for this function:

◆ getCertificateVariablesForPresentation()

ilCourseCertificateAdapter::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$paramsAn array of parameters to calculate the certificate parameter values
Returns
array The certificate variables

Reimplemented from ilCertificateAdapter.

Definition at line 89 of file class.ilCourseCertificateAdapter.php.

90 {
91 global $lng;
92
93 $user_id = $params["user_id"];
94
95 include_once './Services/User/classes/class.ilObjUser.php';
96 $user_data = ilObjUser::_lookupFields($user_id);
97
98 include_once './Modules/Course/classes/class.ilCourseParticipants.php';
99 $completion_date = ilCourseParticipants::getDateTimeOfPassed($this->object->getId(), $user_id);
100
101 $vars = $this->getBaseVariablesForPresentation($user_data, null, $completion_date);
102 $vars["COURSE_TITLE"] = ilUtil::prepareFormOutput($this->object->getTitle());
103
104 $insert_tags = array();
105 foreach($vars as $id => $caption)
106 {
107 $insert_tags["[".$id."]"] = $caption;
108 }
109 return $insert_tags;
110 }
getBaseVariablesForPresentation($a_user_data, $a_last_access=null, $a_completion_date=false)
Get variable values.
static getDateTimeOfPassed($a_obj_id, $a_usr_id)
_lookupFields($a_user_id)
lookup fields (deprecated; use more specific methods instead)
static prepareFormOutput($a_str, $a_strip=false)
prepares string output for html forms @access public
$params
Definition: example_049.php:96

References $lng, $params, ilObjUser\_lookupFields(), ilCertificateAdapter\getBaseVariablesForPresentation(), ilCourseParticipants\getDateTimeOfPassed(), and ilUtil\prepareFormOutput().

+ Here is the call graph for this function:

◆ getCertificateVariablesForPreview()

ilCourseCertificateAdapter::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 66 of file class.ilCourseCertificateAdapter.php.

67 {
68 global $lng;
69
70 $vars = $this->getBaseVariablesForPreview(false);
71 $vars["COURSE_TITLE"] = ilUtil::prepareFormOutput($this->object->getTitle());
72
73 $insert_tags = array();
74 foreach($vars as $id => $caption)
75 {
76 $insert_tags["[".$id."]"] = $caption;
77 }
78 return $insert_tags;
79 }
getBaseVariablesForPreview($a_enable_last_access=true, $a_enable_completion_date=true)
Get variable dummys.

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

+ Here is the call graph for this function:

Field Documentation

◆ $has_certificate

ilCourseCertificateAdapter::$has_certificate = array()
staticprotected

Definition at line 36 of file class.ilCourseCertificateAdapter.php.

◆ $object

ilCourseCertificateAdapter::$object
protected

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

Referenced by __construct().


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