ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
ilExcMailTemplateSubmitReminderContext Class Reference

Handles exercise Submit reminder mail placeholders If all contexts are using the same placeholders,constructor etc. More...

+ Inheritance diagram for ilExcMailTemplateSubmitReminderContext:
+ Collaboration diagram for ilExcMailTemplateSubmitReminderContext:

Public Member Functions

 getId ()
 
 getTitle ()
 
 getDescription ()
 
 getSpecificPlaceholders ()
 
 resolveSpecificPlaceholder (string $placeholder_id, array $context_parameters, ilObjUser $recipient=null, bool $html_markup=false)
 
- Public Member Functions inherited from ilMailTemplateContext
 __construct (OrgUnitUserService $orgUnitUserService=null, ilMailEnvironmentHelper $envHelper=null, ilMailUserHelper $usernameHelper=null, ilMailLanguageHelper $languageHelper=null)
 
 getLanguage ()
 
 getId ()
 
 getTitle ()
 
 getDescription ()
 
 getPlaceholders ()
 
 getSpecificPlaceholders ()
 
 resolveSpecificPlaceholder (string $placeholder_id, array $context_parameters, ilObjUser $recipient=null, bool $html_markup=false)
 
 resolvePlaceholder (string $placeholder_id, array $context_parameters, ilObjUser $recipient=null, bool $html_markup=false)
 

Data Fields

const ID = 'exc_context_submit_rmd'
 

Protected Attributes

ilLanguage $lng
 
ilObjectDataCache $obj_data_cache
 
- Protected Attributes inherited from ilMailTemplateContext
ilLanguage $language
 
ilMailEnvironmentHelper $envHelper
 
ilMailLanguageHelper $languageHelper
 
ilMailUserHelper $userHelper
 
OrgUnitUserService $orgUnitUserService
 

Additional Inherited Members

- Protected Member Functions inherited from ilMailTemplateContext
 initLanguage (ilObjUser $user)
 
 initLanguageByIso2Code (string $isoCode)
 

Detailed Description

Handles exercise Submit reminder mail placeholders If all contexts are using the same placeholders,constructor etc.

todo: create base class.

Author
Jesús López lopez.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 28 of file class.ilExcMailTemplateSubmitReminderContext.php.

Member Function Documentation

◆ getDescription()

ilExcMailTemplateSubmitReminderContext::getDescription ( )

Definition at line 71 of file class.ilExcMailTemplateSubmitReminderContext.php.

References $lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

71  : string
72  {
73  $lng = $this->lng;
74 
75  $lng->loadLanguageModule('exc');
76 
77  return $lng->txt('exc_mail_context_submit_reminder_info');
78  }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
loadLanguageModule(string $a_module)
Load language module.
+ Here is the call graph for this function:

◆ getId()

ilExcMailTemplateSubmitReminderContext::getId ( )

Definition at line 57 of file class.ilExcMailTemplateSubmitReminderContext.php.

57  : string
58  {
59  return self::ID;
60  }

◆ getSpecificPlaceholders()

ilExcMailTemplateSubmitReminderContext::getSpecificPlaceholders ( )

Definition at line 80 of file class.ilExcMailTemplateSubmitReminderContext.php.

References $lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

80  : array
81  {
82  $lng = $this->lng;
83  $lng->loadLanguageModule('exc');
84 
85  $placeholders = array();
86 
87  $placeholders['ass_title'] = array(
88  'placeholder' => 'ASSIGNMENT_TITLE',
89  'label' => $lng->txt('exc_mail_context_reminder_assignment_title')
90  );
91  $placeholders['exc_title'] = array(
92  'placeholder' => 'EXERCISE_TITLE',
93  'label' => $lng->txt('exc_mail_context_reminder_exercise_title')
94  );
95 
96  $placeholders['ass_link'] = array(
97  'placeholder' => 'ASSIGNMENT_LINK',
98  'label' => $lng->txt('perma_link')
99  );
100 
101  return $placeholders;
102  }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
loadLanguageModule(string $a_module)
Load language module.
+ Here is the call graph for this function:

◆ getTitle()

ilExcMailTemplateSubmitReminderContext::getTitle ( )

Definition at line 62 of file class.ilExcMailTemplateSubmitReminderContext.php.

References $lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

62  : string
63  {
64  $lng = $this->lng;
65 
66  $lng->loadLanguageModule('exc');
67 
68  return $lng->txt('exc_mail_context_submit_reminder_title');
69  }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
loadLanguageModule(string $a_module)
Load language module.
+ Here is the call graph for this function:

◆ resolveSpecificPlaceholder()

ilExcMailTemplateSubmitReminderContext::resolveSpecificPlaceholder ( string  $placeholder_id,
array  $context_parameters,
ilObjUser  $recipient = null,
bool  $html_markup = false 
)

Definition at line 104 of file class.ilExcMailTemplateSubmitReminderContext.php.

References $obj_data_cache, ilLink\_getLink(), and ilExAssignment\lookupTitle().

109  : string {
110  $ilObjDataCache = $this->obj_data_cache;
111 
112  if ($placeholder_id == 'ass_title') {
113  return ilExAssignment::lookupTitle((int) $context_parameters["ass_id"]);
114  } else {
115  if ($placeholder_id == 'exc_title') {
116  return $ilObjDataCache->lookupTitle((int) $context_parameters["exc_id"]);
117  } else {
118  if ($placeholder_id == 'ass_link') {
119  return ilLink::_getLink(
120  $context_parameters["exc_ref"],
121  "exc",
122  array(),
123  "_" . $context_parameters["ass_id"]
124  );
125  }
126  }
127  }
128 
129  return '';
130  }
static lookupTitle(int $a_id)
+ Here is the call graph for this function:

Field Documentation

◆ $lng

ilLanguage ilExcMailTemplateSubmitReminderContext::$lng
protected

◆ $obj_data_cache

ilObjectDataCache ilExcMailTemplateSubmitReminderContext::$obj_data_cache
protected

◆ ID

const ilExcMailTemplateSubmitReminderContext::ID = 'exc_context_submit_rmd'

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