Inheritance diagram for ilDataCollectionMailNotification:

Collaboration diagram for ilDataCollectionMailNotification:

Public Member Functions
	addRecipient (int $a_rcp)

	getActor ()

	setActor (int $actor)

	getRecord ()

	setRecord (ilDclBaseRecordModel $record)

	send ()

Public Member Functions inherited from ilMailNotification
	__construct (protected bool $is_in_wsp=false)

	setType (int $a_type)

	getType ()

	setSender (int $a_usr_id)

	getSender ()

	setRecipients (array $a_rcp)

	getRecipients ()

	setAttachments (array $a_att)

	getAttachments ()

	setLangModules (array $a_modules)

	getUserLanguage (int $a_usr_id)

	setRefId (int $a_id)

	getRefId ()

	getObjId ()

	setObjId (int $a_obj_id)

	getObjType ()

	setAdditionalInformation (array $a_info)

	getAdditionalInformation ()

	sendMail (array $a_rcp, bool $a_parse_recipients=true)

	getBlockBorder ()

Data Fields
const	TYPE_RECORD_CREATE = 1

const	TYPE_RECORD_UPDATE = 2

const	TYPE_RECORD_DELETE = 3

Data Fields inherited from ilMailNotification
final const	SUBJECT_TITLE_LENGTH = 60

Protected Member Functions
	appendBody (string $a_body)

Protected Member Functions inherited from ilMailNotification
	setSubject (string $a_subject)

	getSubject ()

	setBody (string $a_body)

	appendBody (string $a_body)

	getBody ()

	initLanguage (int $a_usr_id)

	initLanguageByIso2Code (string $a_code='')

	setLanguage (ilLanguage $a_language)

	getLanguage ()

	getLanguageText (string $a_keyword)

	getObjectTitle (bool $a_shorten=false)

	initMail ()

	getMail ()

	createPermanentLink (array $a_params=[], string $a_append='')

	userToString (int $a_usr_id)

	isRefIdAccessible (int $a_user_id, int $a_ref_id, string $a_permission="read")

Private Member Functions
	getAction (ilLanguage $lng)

Private Attributes
int	$actor

ilDclBaseRecordModel	$record

Additional Inherited Members
Protected Attributes inherited from ilMailNotification
int	$type

int	$sender

ilMail	$mail = null

string	$subject = ''

string	$body = ''

array	$attachments = []

ilLanguage	$language

array	$lang_modules = []

array	$recipients = []

int	$ref_id

int	$obj_id = 0

string	$obj_type = ''

array	$additional_info = []

ilWorkspaceTree	$wsp_tree

ilWorkspaceAccessHandler	$wsp_access_handler

Detailed Description

Definition at line 21 of file class.ilDataCollectionMailNotification.php.

Member Function Documentation

◆ addRecipient()

ilDataCollectionMailNotification::addRecipient ( int $a_rcp )

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

                                             : void
     {
         $this->recipients[] = $a_rcp;
     }

◆ appendBody()

ilDataCollectionMailNotification::appendBody ( string $a_body )

protected

Definition at line 120 of file class.ilDataCollectionMailNotification.php.

Referenced by send().

                                                  : string
     {
         return parent::appendBody($a_body . "\n\n");
     }

Here is the caller graph for this function:

◆ getAction()

ilDataCollectionMailNotification::getAction ( ilLanguage $lng )

private

Definition at line 106 of file class.ilDataCollectionMailNotification.php.

References ilMailNotification\getType(), and ilLanguage\txt().

Referenced by send().

                                                : string
     {
         switch ($this->getType()) {
             case self::TYPE_RECORD_CREATE:
                 return $lng->txt('dcl_change_notification_dcl_new_record');
             case self::TYPE_RECORD_UPDATE:
                 return $lng->txt('dcl_change_notification_dcl_update_record');
             case self::TYPE_RECORD_DELETE:
                 return $lng->txt('dcl_change_notification_dcl_delete_record');
             default:
                 return '';
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActor()

ilDataCollectionMailNotification::getActor ( )

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

References $actor.

                               : int
     {
         return $this->actor;
     }

◆ getRecord()

ilDataCollectionMailNotification::getRecord ( )

Definition at line 45 of file class.ilDataCollectionMailNotification.php.

References $record.

                                : ilDclBaseRecordModel
     {
         return $this->record;
     }

◆ send()

ilDataCollectionMailNotification::send ( )

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

References $lng, $user_id, ilLanguageFactory\_getLanguageOfUser(), ilObject\_lookupTitle(), appendBody(), getAction(), ilMailNotification\getMail(), ilUserUtil\getNamePresentation(), ilMailNotification\getObjId(), ilMailNotification\getRefId(), ilMail\getSalutation(), ilMailNotification\initMail(), ilMailNotification\sendMail(), ilMailNotification\setBody(), and ilMailNotification\setSubject().

                           : void
     {
         $title = ilObject::_lookupTitle($this->getObjId());
         $actor = ilUserUtil::getNamePresentation($this->actor);
         $table = $this->record->getTable()->getTitle();
         $link = ilLink::_getLink($this->getRefId());
         foreach ($this->recipients as $user_id) {
             $views = $this->record->getTable()->getVisibleTableViews($user_id);
             $visible_ids = [];
             foreach ($views as $view) {
                 foreach ($view->getVisibleFields() as $field) {
                     $visible_ids[] = $field->getId();
                 }
             }
             $visible_ids = array_unique($visible_ids);
             $lng = ilLanguageFactory::_getLanguageOfUser($user_id);
             $lng->loadLanguageModule('dcl');
 
             $this->initMail();
             $this->setSubject(sprintf($lng->txt('dcl_change_notification_subject'), $title));
 
             $this->setBody('');
             $this->appendBody(ilMail::getSalutation($user_id, $lng));
             $this->appendBody($this->getAction($lng));
             $this->appendBody($lng->txt('obj_dcl') . ": $title");
             $this->appendBody($lng->txt('dcl_table') . ": $table");
             if ($visible_ids !== []) {
                 $message = $lng->txt('dcl_record') . ":\n";
                 $message .= "------------------------------------\n";
                 foreach ($this->record->getTable()->getFields() as $field) {
                     if (in_array($field->getId(), $visible_ids)) {
                         $value = '-undefined-';
                         if ($field->isStandardField()) {
                             $value = $this->record->getStandardFieldPlainText($field->getId());
                         } elseif ($record_field = $this->record->getRecordField((int) $field->getId())) {
                             $value = $record_field->getPlainText();
                         }
                         $message .= $field->getTitle() . ': ' . $value . "\n";
                     }
                 }
                 $message .= "------------------------------------";
                 $this->appendBody($message);
             }
 
             $this->appendBody($lng->txt('dcl_changed_by') . ": $actor");
             $this->appendBody($lng->txt('dcl_change_notification_link') . ": $link");
             $this->getMail()->appendInstallationSignature(true);
             $this->sendMail([$user_id]);
         }
     }

Here is the call graph for this function:

◆ setActor()

ilDataCollectionMailNotification::setActor ( int $actor )

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

References $actor.

                                         : void
     {
         $this->actor = $actor;
     }

◆ setRecord()

ilDataCollectionMailNotification::setRecord ( ilDclBaseRecordModel $record )

Definition at line 50 of file class.ilDataCollectionMailNotification.php.

References $record.

                                                            : void
     {
         $this->record = $record;
     }

Field Documentation

◆ $actor

int ilDataCollectionMailNotification::$actor

private

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

Referenced by getActor(), and setActor().

◆ $record

ilDclBaseRecordModel ilDataCollectionMailNotification::$record

private

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

Referenced by getRecord(), and setRecord().

◆ TYPE_RECORD_CREATE

const ilDataCollectionMailNotification::TYPE_RECORD_CREATE = 1

Definition at line 23 of file class.ilDataCollectionMailNotification.php.

Referenced by ilDclRecordEditGUI\save().

◆ TYPE_RECORD_DELETE

const ilDataCollectionMailNotification::TYPE_RECORD_DELETE = 3

Definition at line 25 of file class.ilDataCollectionMailNotification.php.

Referenced by ilDclBaseRecordModel\doDelete().

◆ TYPE_RECORD_UPDATE

const ilDataCollectionMailNotification::TYPE_RECORD_UPDATE = 2

Definition at line 24 of file class.ilDataCollectionMailNotification.php.

Referenced by ilDclBaseRecordModel\doUpdate().

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

components/ILIAS/DataCollection/classes/class.ilDataCollectionMailNotification.php

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addRecipient()

◆ appendBody()

◆ getAction()

◆ getActor()

◆ getRecord()

◆ send()

◆ setActor()

◆ setRecord()

Field Documentation

◆ $actor

◆ $record

◆ TYPE_RECORD_CREATE

◆ TYPE_RECORD_DELETE

◆ TYPE_RECORD_UPDATE