Collaboration diagram for ilMailSearchCoursesGUI:

Public Member Functions
	__construct ($wsp_access_handler=null, $wsp_node_id=null)

	executeCommand ()

	mail ()

	mailCourses ()

	mailMembers ()

	cancel ()
	Cancel action. More...

	showMembers ()
	Show course members. More...

	share ()

Protected Member Functions
	addPermission ($a_obj_ids)

Protected Attributes
	$tpl

	$ctrl

	$lng

	$user

	$error

	$rbacsystem

	$rbacreview

	$tree

	$cache

	$umail

	$mailing_allowed

	$rerfinery

Private Member Functions
	getContext ()

Detailed Description

Author: Jens Conze

Version: $Id$ ilMailSearchCoursesGUI: ilBuddySystemGUI

Definition at line 16 of file class.ilMailSearchCoursesGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilMailSearchCoursesGUI::__construct	(	$wsp_access_handler = `null`,
		$wsp_node_id = `null`
	)

Definition at line 75 of file class.ilMailSearchCoursesGUI.php.

References $DIC, and user().

     {
         global $DIC;
 
         $this->tpl = $DIC['tpl'];
         $this->ctrl = $DIC['ilCtrl'];
         $this->lng = $DIC['lng'];
         $this->user = $DIC['ilUser'];
         $this->error = $DIC['ilErr'];
         $this->rbacsystem = $DIC['rbacsystem'];
         $this->rbacreview = $DIC['rbacreview'];
         $this->tree = $DIC['tree'];
         $this->cache = $DIC['ilObjDataCache'];
         $this->refinery = $DIC->refinery();
 
         // personal workspace
         $this->wsp_access_handler = $wsp_access_handler;
         $this->wsp_node_id = $wsp_node_id;
 
         // check if current user may send mails
         include_once "Services/Mail/classes/class.ilMail.php";
         $mail = new ilMail($this->user->getId());
         $this->mailing_allowed = $this->rbacsystem->checkAccess('internal_mail', $mail->getMailObjectReferenceId());
 
         $this->ctrl->saveParameter($this, "mobj_id");
         $this->ctrl->saveParameter($this, "ref");
 
         $this->umail = new ilFormatMail($this->user->getId());
     }

Here is the call graph for this function:

Member Function Documentation

◆ addPermission()

ilMailSearchCoursesGUI::addPermission ( $a_obj_ids )

protected

Definition at line 574 of file class.ilMailSearchCoursesGUI.php.

Referenced by share().

     {
         if (!is_array($a_obj_ids)) {
             $a_obj_ids = array($a_obj_ids);
         }
         
         $existing = $this->wsp_access_handler->getPermissions($this->wsp_node_id);
         $added = false;
         foreach ($a_obj_ids as $object_id) {
             if (!in_array($object_id, $existing)) {
                 $added = $this->wsp_access_handler->addPermission($this->wsp_node_id, $object_id);
             }
         }
         
         if ($added) {
             ilUtil::sendSuccess($this->lng->txt("wsp_share_success"), true);
         }
         $this->ctrl->redirectByClass("ilworkspaceaccessgui", "share");
     }

Here is the caller graph for this function:

◆ cancel()

ilMailSearchCoursesGUI::cancel ( )

Cancel action.

Definition at line 298 of file class.ilMailSearchCoursesGUI.php.

References $_GET, $data, ilObject\_getAllReferences(), ilCourseParticipants\_getInstanceByObjId(), ilParticipants\_getMembershipByType(), ilObject\_hasUntrashedReference(), ilObjUser\_lookupActive(), ilParticipants\canSendMailToMembers(), getContext(), ilObjectFactory\getInstanceByObjId(), ilMailGlobalServices\getMailObjectRefId(), and user().

     {
         if ($_GET["view"] == "mycourses" &&
             $_GET["ref"] == "mail") {
             $this->ctrl->returnToParent($this);
         } else {
             $this->showMyCourses();
         }
     }

Here is the call graph for this function:

◆ executeCommand()

ilMailSearchCoursesGUI::executeCommand ( )

Definition at line 121 of file class.ilMailSearchCoursesGUI.php.

References ilBuddySystem\getInstance().

     {
         $forward_class = $this->ctrl->getNextClass($this);
         switch ($forward_class) {
             case 'ilbuddysystemgui':
                 if (!ilBuddySystem::getInstance()->isEnabled()) {
                     $this->error->raiseError($this->lng->txt('msg_no_perm_read'), $this->error->MESSAGE);
                 }
 
                 require_once 'Services/Contact/BuddySystem/classes/class.ilBuddySystemGUI.php';
                 $this->ctrl->saveParameter($this, 'search_crs');
                 $this->ctrl->setReturn($this, 'showMembers');
                 $this->ctrl->forwardCommand(new ilBuddySystemGUI());
                 break;
 
             default:
                 if (!($cmd = $this->ctrl->getCmd())) {
                     $cmd = "showMyCourses";
                 }
 
                 $this->$cmd();
                 break;
         }
         return true;
     }

Here is the call graph for this function:

◆ getContext()

ilMailSearchCoursesGUI::getContext ( )

private

Definition at line 105 of file class.ilMailSearchCoursesGUI.php.

References $_GET, and $context.

Referenced by cancel().

                                   : string
     {
         $context = 'mail';
         if (isset($_GET['ref'])) {
             $always = $context;
             $context = $this->refinery->byTrying([
                 $this->refinery->kindlyTo()->string(),
                 $this->refinery->custom()->transformation(static function ($value) use ($always) {
                     return $always;
                 }),
             ])->transform($_GET['ref']);
         }
 
         return $context;
     }

Here is the caller graph for this function:

◆ mail()

ilMailSearchCoursesGUI::mail ( )

Definition at line 147 of file class.ilMailSearchCoursesGUI.php.

References $_GET, $_POST, mailCourses(), mailMembers(), ilUtil\sendInfo(), and showMembers().

     {
         if ($_GET["view"] == "mycourses") {
             $ids = ((int) $_GET['search_crs']) ? array((int) $_GET['search_crs']) : $_POST['search_crs'];
             
             if ($ids) {
                 $this->mailCourses();
             } else {
                 ilUtil::sendInfo($this->lng->txt("mail_select_course"));
                 $this->showMyCourses();
             }
         } elseif ($_GET["view"] == "crs_members") {
             $ids = ((int) $_GET['search_members']) ? array((int) $_GET['search_members']) : $_POST['search_members'];
             if ($ids) {
                 $this->mailMembers();
             } else {
                 ilUtil::sendInfo($this->lng->txt("mail_select_one_entry"));
                 $this->showMembers();
             }
         } else {
             $this->showMyCourses();
         }
     }

Here is the call graph for this function:

◆ mailCourses()

ilMailSearchCoursesGUI::mailCourses ( )

Definition at line 171 of file class.ilMailSearchCoursesGUI.php.

References $_GET, $_POST, ilObject\_getAllReferences(), ilParticipants\canSendMailToMembers(), ilMailGlobalServices\getMailObjectRefId(), ilUtil\redirect(), and user().

Referenced by mail().

     {
         $members = array();
 
         if (!is_array($old_mail_data = $this->umail->getSavedData())) {
             $this->umail->savePostData(
                 $this->user->getId(),
                 array(),
                 "",
                 "",
                 "",
                 "",
                 "",
                 "",
                 "",
                 ""
             );
         }
 
         require_once './Services/Object/classes/class.ilObject.php';
         require_once 'Services/Mail/classes/Address/Type/class.ilMailRoleAddressType.php';
         $ids = ((int) $_GET['search_crs']) ? array((int) $_GET['search_crs']) : $_POST['search_crs'];
         
         foreach ($ids as $crs_id) {
             $ref_ids = ilObject::_getAllReferences($crs_id);
 
             foreach ($ref_ids as $ref_id) {
                 $roles = $this->rbacreview->getAssignableChildRoles($ref_id);
                 $can_send_mails = ilParticipants::canSendMailToMembers(
                     (int) $ref_id,
                     $this->user->getId(),
                     ilMailGlobalServices::getMailObjectRefId()
                 );
                 if (!$can_send_mails) {
                     continue;
                 }
 
                 foreach ($roles as $role) {
                     if (substr($role['title'], 0, 14) == 'il_crs_member_' ||
                         substr($role['title'], 0, 13) == 'il_crs_tutor_' ||
                         substr($role['title'], 0, 13) == 'il_crs_admin_') {
                         if (isset($old_mail_data['rcp_to']) &&
                            trim($old_mail_data['rcp_to']) != '') {
                             $rcpt = (new \ilRoleMailboxAddress($role['obj_id']))->value();
                             if (!$this->umail->existsRecipient($rcpt, (string) $old_mail_data['rcp_to'])) {
                                 array_push($members, $rcpt);
                             }
                         } else {
                             array_push($members, (new \ilRoleMailboxAddress($role['obj_id']))->value());
                         }
                     }
                 }
             }
         }
         
         if (count($members)) {
             $mail_data = $this->umail->appendSearchResult($members, 'to');
         } else {
             $mail_data = $this->umail->getSavedData();
         }
 
         $this->umail->savePostData(
             $mail_data["user_id"],
             $mail_data["attachments"],
             $mail_data["rcp_to"],
             $mail_data["rcp_cc"],
             $mail_data["rcp_bcc"],
             $mail_data["m_email"],
             $mail_data["m_subject"],
             $mail_data["m_message"],
             $mail_data["use_placeholders"],
             $mail_data['tpl_ctx_id'],
             $mail_data['tpl_ctx_params']
         );
 
         #$this->ctrl->returnToParent($this);
         ilUtil::redirect("ilias.php?baseClass=ilMailGUI&type=search_res");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mailMembers()

ilMailSearchCoursesGUI::mailMembers ( )

Definition at line 250 of file class.ilMailSearchCoursesGUI.php.

References $_GET, $_POST, $login, ilObjUser\_lookupLogin(), ilUtil\redirect(), and user().

Referenced by mail().

     {
         $members = array();
 
         if (!is_array($this->umail->getSavedData())) {
             $this->umail->savePostData(
                 $this->user->getId(),
                 array(),
                 "",
                 "",
                 "",
                 "",
                 "",
                 "",
                 "",
                 ""
             );
         }
     
         $ids = ((int) $_GET['search_members']) ? array((int) $_GET['search_members']) : $_POST['search_members'];
         
         foreach ($ids as $member) {
             $login = ilObjUser::_lookupLogin($member);
             array_push($members, $login);
         }
         $mail_data = $this->umail->appendSearchResult($members, "to");
 
         $this->umail->savePostData(
             $mail_data["user_id"],
             $mail_data["attachments"],
             $mail_data["rcp_to"],
             $mail_data["rcp_cc"],
             $mail_data["rcp_bcc"],
             $mail_data["m_email"],
             $mail_data["m_subject"],
             $mail_data["m_message"],
             $mail_data["use_placeholders"],
             $mail_data['tpl_ctx_id'],
             $mail_data['tpl_ctx_params']
         );
 
         #$this->ctrl->returnToParent($this);
         ilUtil::redirect("ilias.php?baseClass=ilMailGUI&type=search_res");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ share()

ilMailSearchCoursesGUI::share ( )

Definition at line 548 of file class.ilMailSearchCoursesGUI.php.

References $_GET, addPermission(), ilUtil\sendInfo(), and showMembers().

     {
         if ($_GET["view"] == "mycourses") {
             $ids = $_REQUEST["search_crs"];
             if (!is_array($ids) && $ids !== "") {
                 $ids = [$ids];
             }
             if (is_array($ids) && sizeof($ids)) {
                 $this->addPermission($ids);
             } else {
                 ilUtil::sendInfo($this->lng->txt("mail_select_course"));
                 $this->showMyCourses();
             }
         } elseif ($_GET["view"] == "crs_members") {
             $ids = $_REQUEST["search_members"];
             if (is_array($ids) && sizeof($ids)) {
                 $this->addPermission($ids);
             } else {
                 ilUtil::sendInfo($this->lng->txt("mail_select_one_entry"));
                 $this->showMembers();
             }
         } else {
             $this->showMyCourses();
         }
     }

Here is the call graph for this function:

◆ showMembers()

ilMailSearchCoursesGUI::showMembers ( )

Show course members.

Definition at line 441 of file class.ilMailSearchCoursesGUI.php.

References $_GET, $_POST, $_SESSION, $context, $login, $name, ilObjUser\_lookupLogin(), ilObjUser\_lookupName(), ilObjUser\_lookupPref(), ilUtil\_sortIds(), ilStr\convertUpperCamelCaseToUnderscoreCase(), ilBuddySystem\getInstance(), ilBuddyList\getInstanceByGlobalUser(), ilObjectFactory\getInstanceByObjId(), ilUtil\sendInfo(), and user().

Referenced by mail(), and share().

     {
         include_once 'Modules/Course/classes/class.ilCourseParticipants.php';
 
         if ($_GET["search_crs"] != "") {
             $_POST["search_crs"] = explode(",", $_GET["search_crs"]);
             $_GET["search_crs"] = "";
         } elseif ($_SESSION["search_crs"] != "") {
             $_POST["search_crs"] = explode(",", $_SESSION["search_crs"]);
             $_SESSION["search_crs"] = "";
         }
 
         if (is_array($_POST['search_crs'])) {
             $_POST['search_crs'] = array_filter(array_map('intval', $_POST['search_crs']));
         }
 
         if (!is_array($_POST["search_crs"]) ||
             count($_POST["search_crs"]) == 0) {
             ilUtil::sendInfo($this->lng->txt("mail_select_course"));
             $this->showMyCourses();
         } else {
             foreach ($_POST['search_crs'] as $crs_id) {
                 $oTmpCrs = ilObjectFactory::getInstanceByObjId($crs_id);
                 if ($oTmpCrs->getShowMembers() == $oTmpCrs->SHOW_MEMBERS_DISABLED) {
                     unset($_POST['search_crs']);
                     ilUtil::sendInfo($this->lng->txt('mail_crs_list_members_not_available_for_at_least_one_crs'));
                     return $this->showMyCourses();
                 }
                 unset($oTmpCrs);
             }
 
             $this->tpl->setTitle($this->lng->txt("mail_addressbook"));
         
             $this->ctrl->setParameter($this, "view", "crs_members");
             if ($_GET["ref"] != "") {
                 $this->ctrl->setParameter($this, "ref", $_GET["ref"]);
             }
             if (is_array($_POST["search_crs"])) {
                 $this->ctrl->setParameter($this, "search_crs", implode(",", $_POST["search_crs"]));
             }
             $this->tpl->setVariable("ACTION", $this->ctrl->getFormAction($this));
             $this->ctrl->clearParameters($this);
 
             $this->lng->loadLanguageModule('crs');
             include_once 'Services/Contact/classes/class.ilMailSearchCoursesMembersTableGUI.php';
             $context = $_GET["ref"] ? $_GET["ref"] : "mail";
             $table = new ilMailSearchCoursesMembersTableGUI($this, 'crs', $context, $_POST["search_crs"]);
             $tableData = array();
             $searchTpl = new ilTemplate('tpl.mail_search_template.html', true, true, 'Services/Contact');
             foreach ($_POST["search_crs"] as $crs_id) {
                 $members_obj = ilCourseParticipants::_getinstanceByObjId($crs_id);
                 $tmp_members = $members_obj->getParticipants();
                 $course_members = ilUtil::_sortIds($tmp_members, 'usr_data', 'lastname', 'usr_id');
 
                 foreach ($course_members as $member) {
                     $tmp_usr = new ilObjUser($member);
                     if (!$tmp_usr->getActive()) {
                         continue;
                     }
 
                     $name = ilObjUser::_lookupName($member);
                     $login = ilObjUser::_lookupLogin($member);
     
                     $fullname = "";
                     if (in_array(ilObjUser::_lookupPref($member, 'public_profile'), array("g", 'y'))) {
                         $fullname = $name['lastname'] . ', ' . $name['firstname'];
                     }
 
                     $rowData = array(
                         'members_id' => $member,
                         'members_login' => $login,
                         'members_name' => $fullname,
                         'members_crs_grp' => $this->cache->lookupTitle($crs_id),
                         'search_crs' => $crs_id
                     );
 
                     if ('mail' == $context && ilBuddySystem::getInstance()->isEnabled()) {
                         $relation = ilBuddyList::getInstanceByGlobalUser()->getRelationByUserId($member);
                         $state_name = ilStr::convertUpperCamelCaseToUnderscoreCase($relation->getState()->getName());
                         $rowData['status'] = '';
                         if ($member != $this->user->getId()) {
                             if ($relation->isOwnedByActor()) {
                                 $rowData['status'] = $this->lng->txt('buddy_bs_state_' . $state_name . '_a');
                             } else {
                                 $rowData['status'] = $this->lng->txt('buddy_bs_state_' . $state_name . '_p');
                             }
                         }
                     }
 
                     $tableData[] = $rowData;
                 }
             }
             $table->setData($tableData);
 
             if (count($tableData)) {
                 $searchTpl->setVariable("TXT_MARKED_ENTRIES", $this->lng->txt("marked_entries"));
             }
 
             $searchTpl->setVariable('TABLE', $table->getHtml());
             $this->tpl->setContent($searchTpl->get());
             
             if ($_GET["ref"] != "wsp") {
                 $this->tpl->printToStdout();
             }
         }
     }