ILIAS  release_7 Revision v7.30-3-g800a261c036
All Data Structures Namespaces Files Functions Variables Modules Pages
ilCourseMailTemplateMemberContext Class Reference
+ Inheritance diagram for ilCourseMailTemplateMemberContext:
+ Collaboration diagram for ilCourseMailTemplateMemberContext:

Public Member Functions

 getId ()
 
 getTitle ()
 
 getDescription ()
 
- Public Member Functions inherited from ilMailTemplateContext
 __construct (OrgUnitUserService $orgUnitUserService=null, ilMailEnvironmentHelper $envHelper=null, ilMailUserHelper $usernameHelper=null, ilMailLanguageHelper $languageHelper=null)
 ilMailTemplateContext constructor. More...
 
 getLanguage ()
 
 getId ()
 Returns a unique (in the context of mail template contexts) id. More...
 
 getTitle ()
 Returns a translated title (depending on the current language) which is displayed in the user interface. More...
 
 getDescription ()
 Returns a translated description (depending on the current language) which is displayed in the user interface. More...
 
 getPlaceholders ()
 Return an array of placeholders. More...
 
 getSpecificPlaceholders ()
 Return an array of placeholders. More...
 
 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 = 'crs_context_member_manual'
 

Static Protected Attributes

static $periodInfoByObjIdCache = []
 

Private Member Functions

 getCachedPeriodByObjId (int $objId)
 

Additional Inherited Members

- Protected Member Functions inherited from ilMailTemplateContext
 initLanguage (ilObjUser $user)
 
 initLanguageByIso2Code (string $isoCode)
 
- Protected Attributes inherited from ilMailTemplateContext
 $language
 
 $envHelper
 
 $languageHelper
 
 $userHelper
 
 $orgUnitUserService
 

Detailed Description

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

Member Function Documentation

◆ getCachedPeriodByObjId()

ilCourseMailTemplateMemberContext::getCachedPeriodByObjId ( int  $objId)
private
Parameters
int$objId
Returns
array|null

Definition at line 100 of file class.ilCourseMailTemplateMemberContext.php.

References $DIC, $objId, ilLink\_getLink(), ilDatePresentation\formatDate(), ilObjCourseAccess\lookupPeriodInfo(), ilMailTemplateContext\resolveSpecificPlaceholder(), ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

101  {
102  if (!array_key_exists($objId, self::$periodInfoByObjIdCache)) {
103  self::$periodInfoByObjIdCache[$objId] = ilObjCourseAccess::lookupPeriodInfo($objId);
104  }
105 
106  return self::$periodInfoByObjIdCache[$objId];
107  }
static lookupPeriodInfo($a_obj_id)
Lookup course period info.
$objId
Definition: xapitoken.php:39
+ Here is the call graph for this function:

◆ getDescription()

ilCourseMailTemplateMemberContext::getDescription ( )
Returns
string

Definition at line 44 of file class.ilCourseMailTemplateMemberContext.php.

References $DIC, $lng, and ilMailTemplateContext\getSpecificPlaceholders().

44  : string
45  {
46  global $DIC;
47 
48  $lng = $DIC['lng'];
49 
50  $lng->loadLanguageModule('crs');
51 
52  return $lng->txt('crs_mail_context_member_info');
53  }
$lng
global $DIC
Definition: goto.php:24
+ Here is the call graph for this function:

◆ getId()

ilCourseMailTemplateMemberContext::getId ( )
Returns
string

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

22  : string
23  {
24  return self::ID;
25  }

◆ getTitle()

ilCourseMailTemplateMemberContext::getTitle ( )
Returns
string

Definition at line 30 of file class.ilCourseMailTemplateMemberContext.php.

References $DIC, and $lng.

30  : string
31  {
32  global $DIC;
33 
34  $lng = $DIC['lng'];
35 
36  $lng->loadLanguageModule('crs');
37 
38  return $lng->txt('crs_mail_context_member_title');
39  }
$lng
global $DIC
Definition: goto.php:24

Field Documentation

◆ $periodInfoByObjIdCache

ilCourseMailTemplateMemberContext::$periodInfoByObjIdCache = []
staticprotected

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

◆ ID

const ilCourseMailTemplateMemberContext::ID = 'crs_context_member_manual'

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