Inheritance diagram for ILIAS\Portfolio\Notification\SharedNotification:

Collaboration diagram for ILIAS\Portfolio\Notification\SharedNotification:

Public Member Functions
	__construct ()

	setSharedToObjectIds (array $a_val)

	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 ()

Protected Member Functions
	appendObjectInformation ()

	initLanguage (int $a_usr_id)

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")

Protected Attributes
array	$shared_to_obj_ids = []

ilObjUser	$user

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

Additional Inherited Members
Data Fields inherited from ilMailNotification
final const	SUBJECT_TITLE_LENGTH = 60

Detailed Description

Definition at line 23 of file SharedNotification.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Portfolio\Notification\SharedNotification::__construct ( )

Definition at line 28 of file SharedNotification.php.

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), and ILIAS\Repository\user().

     {
         global $DIC;
         $this->user = $DIC->user();
         parent::__construct();
     }

Here is the call graph for this function:

Member Function Documentation

◆ appendObjectInformation()

ILIAS\Portfolio\Notification\SharedNotification::appendObjectInformation ( )

protected

Definition at line 72 of file SharedNotification.php.

References ilMailNotification\$obj_id, ilMailNotification\$type, ilObject\_lookupTitle(), ilObject\_lookupType(), ilMailNotification\appendBody(), ilMailNotification\getLanguage(), ilUserUtil\getNamePresentation(), ilWorkspaceAccessGUI\PERMISSION_ALL, ilWorkspaceAccessGUI\PERMISSION_ALL_PASSWORD, and ilWorkspaceAccessGUI\PERMISSION_REGISTERED.

Referenced by ILIAS\Portfolio\Notification\SharedNotification\send().

                                                 : void
     {
         $users = [];
         foreach ($this->shared_to_obj_ids as $obj_id) {
             $type = \ilObject::_lookupType($obj_id);
             switch ($type) {
                 case "crs":
                 case "grp":
                     $this->appendBody("\n\n" . $this->getLanguage()->txt("obj_" . $type) . ": " .
                         \ilObject::_lookupTitle($obj_id));
                     break;
                 case "usr":
                     $users[] = \ilUserUtil::getNamePresentation($obj_id);
                     break;
             }
         }
         if (count($users) > 1) {
             $this->appendBody("\n\n" . $this->getLanguage()->txt("users") . ": ");
             $this->appendBody("\n" . implode("\n", $users));
         }
         if (count($users) === 1) {
             $this->appendBody("\n\n" . $this->getLanguage()->txt("user") . ": " . current($users));
         }
         if (in_array(\ilWorkspaceAccessGUI::PERMISSION_REGISTERED, $this->shared_to_obj_ids, true)) {
             $this->appendBody("\n\n" . $this->getLanguage()->txt("wsp_set_permission_registered"));
         }
         if (in_array(\ilWorkspaceAccessGUI::PERMISSION_ALL, $this->shared_to_obj_ids, true)) {
             $this->appendBody("\n\n" . $this->getLanguage()->txt("wsp_set_permission_all"));
         }
         if (in_array(\ilWorkspaceAccessGUI::PERMISSION_ALL_PASSWORD, $this->shared_to_obj_ids, true)) {
             $this->appendBody("\n\n" . $this->getLanguage()->txt("wsp_set_permission_all_password"));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initLanguage()

ILIAS\Portfolio\Notification\SharedNotification::initLanguage ( int $a_usr_id )

protected

Definition at line 106 of file SharedNotification.php.

References ilMailNotification\getLanguage().

Referenced by ILIAS\Portfolio\Notification\SharedNotification\send().

                                                   : void
     {
         parent::initLanguage($a_usr_id);
         $this->getLanguage()->loadLanguageModule('prtf');
         $this->getLanguage()->loadLanguageModule('wsp');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ send()

ILIAS\Portfolio\Notification\SharedNotification::send ( )

Definition at line 40 of file SharedNotification.php.

                           : bool
     {
         $rcp = $this->user->getId();
 
         $this->initLanguage($rcp);
         $this->initMail();
         $this->setSubject(
             sprintf(
                 $this->getLanguageText('prtf_successfully_shared_prtf'),
                 $this->getObjectTitle(true)
             )
         );
         $this->setBody(\ilMail::getSalutation($rcp, $this->getLanguage()));
         $this->appendBody("\n\n");
         $this->appendBody(
             sprintf(
                 $this->getLanguageText('prtf_successfully_shared_prtf_body'),
                 $this->getObjectTitle(false)
             )
         );
         $this->appendObjectInformation();
         $this->appendBody("\n\n");
         $this->appendBody($this->getLanguageText('prtf_permanent_link'));
         $this->appendBody("\n");
         $this->appendBody(\ilLink::_getStaticLink($this->getObjId(), "prtf"));
         $this->getMail()->appendInstallationSignature(true);
 
         $this->sendMail(array($rcp));
 
         return true;
     }

Here is the call graph for this function:

◆ setSharedToObjectIds()

ILIAS\Portfolio\Notification\SharedNotification::setSharedToObjectIds ( array $a_val )

Definition at line 35 of file SharedNotification.php.

                                                       : void
     {
         $this->shared_to_obj_ids = $a_val;
     }

Field Documentation

◆ $shared_to_obj_ids

array ILIAS\Portfolio\Notification\SharedNotification::$shared_to_obj_ids = []

protected

Definition at line 25 of file SharedNotification.php.

◆ $user

ilObjUser ILIAS\Portfolio\Notification\SharedNotification::$user

protected

Definition at line 26 of file SharedNotification.php.

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

Modules/Portfolio/Notification/SharedNotification.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ appendObjectInformation()

◆ initLanguage()

◆ send()

◆ setSharedToObjectIds()

Field Documentation

◆ $shared_to_obj_ids

◆ $user