ilSessionMailTemplateParticipantContext Class Reference

Inheritance diagram for ilSessionMailTemplateParticipantContext:

Collaboration diagram for ilSessionMailTemplateParticipantContext:

Public Member Functions
	getId ()
	getTitle ()
	getDescription ()
	resolveSpecificPlaceholder (string $placeholder_id, array $context_parameters, ilObjUser $recipient=null, bool $html_markup=false)
	{ Parameters string $placeholder_id array $context_parameters ilObjUser | null $recipient bool $html_markup Returns string } More...
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 = 'sess_context_participant_manual'

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

Member Function Documentation

getDescription()

ilSessionMailTemplateParticipantContext::getDescription

(

)

Returns

string

Reimplemented from ilMailTemplateContext.

Definition at line 40 of file class.ilSessionMailTemplateParticipantContext.php.

                                     : string
    {
        global $DIC;
 
        $lng = $DIC['lng'];
        $lng->loadLanguageModule('sess');
 
        return $lng->txt('sess_mail_context_participant_info');
    }

References $DIC, and $lng.

getId()

ilSessionMailTemplateParticipantContext::getId

(

)

Returns

string

Reimplemented from ilMailTemplateContext.

Definition at line 19 of file class.ilSessionMailTemplateParticipantContext.php.

                            : string
    {
        return self::ID;
    }

References ID.

getTitle()

ilSessionMailTemplateParticipantContext::getTitle

(

)

Returns

string

Reimplemented from ilMailTemplateContext.

Definition at line 27 of file class.ilSessionMailTemplateParticipantContext.php.

                               : string
    {
        global $DIC;
 
        $lng = $DIC['lng'];
 
        $lng->loadLanguageModule('sess');
        return $lng->txt('sess_mail_context_participant_title');
    }

References $DIC, and $lng.

resolveSpecificPlaceholder()

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

{

Parameters

string	$placeholder_id
array	$context_parameters
ilObjUser | null	$recipient
bool	$html_markup

Returns

string

}

Reimplemented from ilMailTemplateContext.

Definition at line 95 of file class.ilSessionMailTemplateParticipantContext.php.

      : string {
        global $DIC;
 
        $ilObjDataCache = $DIC['ilObjDataCache'];
        $obj_id = $ilObjDataCache->lookupObjId($context_parameters['ref_id']);
        $sess_data = ilObjSession::lookupSession($obj_id);
        $sess_app = ilSessionAppointment::_lookupAppointment($obj_id);
 
 
        switch ($placeholder_id) {
            case 'sess_title':
                return $ilObjDataCache->lookupTitle($obj_id);
            case 'sess_appointment':
                return ilSessionAppointment::_appointmentToString($sess_app['start'], $sess_app['end'], $sess_app['fullday']);
            case 'sess_location':
                return $sess_data['location'];
            case 'sess_details':
                return $sess_data['details'];
        }
 
        return '';
    }

Field Documentation

ID

const ilSessionMailTemplateParticipantContext::ID = 'sess_context_participant_manual'

Definition at line 14 of file class.ilSessionMailTemplateParticipantContext.php.

Referenced by ilMailMemberSearchGUI\generateContextArray(), getId(), and ilSessionMembershipGUI\getMailContextOptions().

---

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

• Modules/Session/classes/class.ilSessionMailTemplateParticipantContext.php