Collaboration diagram for ilMailAddressbookGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	checkInput ($addr_id=0)
	Check user's input. More...

	confirmDelete ()
	Confirm delete entry. More...

	performDelete ()
	Delete entry. More...

	cancel ()
	Cancel action. More...

	mailToUsers ()

	search ()

	lookupUsersAsync ()

	lookupAddressbookAsync ()

	lookupEmailsAsync ()

	showSubTabs ()

	activateTab ($a_id)

	setAddressbookFilter ()

	resetAddressbookFilter ()

Data Fields
	$ctrl = null

Private Attributes
	$tpl = null

	$lng = null

	$tabs_gui = null

	$umail = null

	$abook = null

Detailed Description

Author: Jens Conze

Version: $Id$

ilMailAddressbookGUI: ilMailSearchCoursesGUI, ilMailSearchGroupsGUI, ilMailingListsGUI ilMailAddressbookGUI: ilMailFormGUI

Definition at line 20 of file class.ilMailAddressbookGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilMailAddressbookGUI::__construct ( )

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

References $ilCtrl, $ilUser, $lng, and $tpl.

         {
                 global $tpl, $ilCtrl, $lng, $ilUser, $ilTabs;
 
                 $this->tpl = $tpl;
                 $this->ctrl = $ilCtrl;
                 $this->lng = $lng;
                 $this->tabs_gui =& $ilTabs;
                 
                 $this->ctrl->saveParameter($this, "mobj_id");
 
                 $this->umail = new ilFormatMail($ilUser->getId());
                 $this->abook = new ilAddressbook($ilUser->getId());
         }

Member Function Documentation

◆ activateTab()

ilMailAddressbookGUI::activateTab ( $a_id )

Definition at line 771 of file class.ilMailAddressbookGUI.php.

Referenced by executeCommand().

         {
                 if($this->has_sub_tabs)
                 {               
                         $this->tabs_gui->activateSubTab($a_id);
                 }
                 else
                 {
                         $this->tabs_gui->activateTab($a_id);
                 }
         }

Here is the caller graph for this function:

◆ cancel()

ilMailAddressbookGUI::cancel ( )

Cancel action.

Definition at line 268 of file class.ilMailAddressbookGUI.php.

References $_GET, $_POST, $ilSetting, $lng, ilUtil\prepareFormOutput(), and ilTextInputGUI\setValue().

         {
                 $this->showAddressbook();
         }

Here is the call graph for this function:

◆ checkInput()

ilMailAddressbookGUI::checkInput ( $addr_id = 0 )

Check user's input.

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

References $_GET, $_POST, $_SESSION, $ilSetting, $lng, ilObjUser\_lookupId(), ilUtil\is_email(), ilUtil\sendInfo(), and ilUtil\stripSlashes().

         {
                 // check if user login and e-mail-address are empty 
                 if (!strcmp(trim($_POST["login"]), "") &&
                         !strcmp(trim($_POST["email"]), ""))
                 {
                         ilUtil::sendInfo($this->lng->txt("mail_enter_login_or_email_addr"));
                         $error = true;
                 }
                 else if ($_POST["login"] != "" && 
                                  !(ilObjUser::_lookupId(ilUtil::stripSlashes($_POST["login"]))))
                 {
                         ilUtil::sendInfo($this->lng->txt("mail_enter_valid_login"));
                         $error = true;
                 }
                 else if ($_POST["email"] &&
                                  !(ilUtil::is_email($_POST["email"])))
                 {
                         ilUtil::sendInfo($this->lng->txt("mail_enter_valid_email_addr"));
                         $error = true;
                 }
 
                 if (($this->existingEntry = $this->abook->checkEntryByLogin(ilUtil::stripSlashes($_POST["login"]))) > 0 &&
                         (($this->existingEntry != $addr_id && $addr_id > 0) || !$addr_id))
                 {
                         ilUtil::sendInfo($this->lng->txt("mail_entry_exists"));
                         $error = true;
                 }
 
                 return $error ? false : true; 
         }

Here is the call graph for this function:

◆ confirmDelete()

ilMailAddressbookGUI::confirmDelete ( )

Confirm delete entry.

Definition at line 199 of file class.ilMailAddressbookGUI.php.

References $_GET, $_POST, $lng, and ilUtil\sendInfo().

         {
                 global $lng;
                 
                 $addr_ids = ((int)$_GET['addr_id']) ? array((int)$_GET['addr_id']) : $_POST['addr_id'];
                 
                 if (!$addr_ids)
                 {
                         ilUtil::sendInfo($this->lng->txt('mail_select_one_entry'));
                         $this->showAddressbook();                       
                         return true;
                 }
                 
                 include_once("Services/Utilities/classes/class.ilConfirmationGUI.php");
                 $c_gui = new ilConfirmationGUI();
                 
                 // set confirm/cancel commands
                 $c_gui->setFormAction($this->ctrl->getFormAction($this, "performDelete"));
                 $c_gui->setHeaderText($this->lng->txt("mail_sure_delete_entry"));
                 $c_gui->setCancel($this->lng->txt("cancel"), "showAddressbook");
                 $c_gui->setConfirm($this->lng->txt("confirm"), "performDelete");
 
                 // add items to delete
                 foreach($addr_ids as $addr_id)
                 {
                         $entry = $this->abook->getEntry($addr_id);
                         $c_gui->addItem("addr_id[]", $addr_id, $entry["login"] ? $entry["login"] : $entry["email"]);
                 }
                 
                 $this->tpl->setTitle($this->lng->txt("mail_addressbook"));
                 $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.mail_addressbook.html", "Services/Contact");
                 $this->tpl->setVariable('DELETE_CONFIRMATION', $c_gui->getHTML());
                 
                 $this->tpl->show();
                 
                 return true;
         }

Here is the call graph for this function:

◆ executeCommand()

ilMailAddressbookGUI::executeCommand ( )

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

References $cmd, $ilUser, activateTab(), and showSubTabs().

         {
                 global $ilUser;
                 $this->showSubTabs();
 
                 $forward_class = $this->ctrl->getNextClass($this);
                 
                 // delete all stored maildata
                 $this->umail->savePostData($ilUser->getId(), array(), '', '', '', '', '', '', '', '');
                 
                 switch($forward_class)
                 {
                         case 'ilmailformgui':
                                 include_once 'Services/Mail/classes/class.ilMailFormGUI.php';
                                 $this->ctrl->forwardCommand(new ilMailFormGUI());
                                 break;
 
                         case 'ilmailsearchcoursesgui':
                                 include_once 'Services/Contact/classes/class.ilMailSearchCoursesGUI.php';
 
                                 $this->activateTab('mail_my_courses');
 
                                 $this->ctrl->setReturn($this, "showAddressbook");
                                 $this->ctrl->forwardCommand(new ilMailSearchCoursesGUI());
                                 break;
 
                         case 'ilmailsearchgroupsgui':
                                 include_once 'Services/Contact/classes/class.ilMailSearchGroupsGUI.php';
 
                                 $this->activateTab('mail_my_groups');
 
                                 $this->ctrl->setReturn($this, "showAddressbook");
                                 $this->ctrl->forwardCommand(new ilMailSearchGroupsGUI());
                                 break;
                         
                         case 'ilmailinglistsgui':
                                 include_once 'Services/Contact/classes/class.ilMailingListsGUI.php';
 
                                 $this->activateTab('mail_my_mailing_lists');
 
                                 $this->ctrl->setReturn($this, "showAddressbook");
                                 $this->ctrl->forwardCommand(new ilMailingListsGUI());
                                 break;
 
                         default:
                                 $this->activateTab('mail_my_entries');
 
                                 if (!($cmd = $this->ctrl->getCmd()))
                                 {
                                         $cmd = "showAddressbook";
                                 }
 
                                 $this->$cmd();
                                 break;
                 }
                 return true;
         }

Here is the call graph for this function:

◆ lookupAddressbookAsync()

ilMailAddressbookGUI::lookupAddressbookAsync ( )

Definition at line 722 of file class.ilMailAddressbookGUI.php.

References $_REQUEST, $result, ilJsonUtil\encode(), and exit.

         {
                 include_once 'Services/JSON/classes/class.ilJsonUtil.php';
                 include_once 'Services/Contact/classes/class.ilMailAddressbook.php';
 
                 $search = "%" . $_REQUEST["term"] . "%";
                 $mailAdrBookObj = new ilMailAddressbook();
                 $result = $mailAdrBookObj->getAddressbookAsync($search, $_REQUEST["term"]);
 
                 echo ilJsonUtil::encode($result);
                 exit;
         }

Here is the call graph for this function:

◆ lookupEmailsAsync()

ilMailAddressbookGUI::lookupEmailsAsync ( )

Definition at line 735 of file class.ilMailAddressbookGUI.php.

References $_REQUEST, $result, ilJsonUtil\encode(), and exit.

         {
                 include_once 'Services/JSON/classes/class.ilJsonUtil.php';
                 include_once 'Services/Contact/classes/class.ilMailAddressbook.php';
 
                 $search = "%" . $_REQUEST["term"] . "%";
                 $mailAdrBookObj = new ilMailAddressbook();
                 $result = $mailAdrBookObj->getEmailsAsync($search, $_REQUEST["term"]);
 
                 echo ilJsonUtil::encode($result);
                 exit;
         }

Here is the call graph for this function:

◆ lookupUsersAsync()

ilMailAddressbookGUI::lookupUsersAsync ( )

Definition at line 709 of file class.ilMailAddressbookGUI.php.

References $_REQUEST, $result, ilJsonUtil\encode(), and exit.

         {
             include_once 'Services/JSON/classes/class.ilJsonUtil.php';
             include_once 'Services/Contact/classes/class.ilMailAddressbook.php';
 
             $search = "%" . $_REQUEST["term"] . "%";
             $mailAdrBookObj = new ilMailAddressbook();
             $result = $mailAdrBookObj->getUsersAsync($search, $_REQUEST["term"]);
 
             echo ilJsonUtil::encode($result);
             exit;
         }

Here is the call graph for this function:

◆ mailToUsers()

ilMailAddressbookGUI::mailToUsers ( )

Definition at line 333 of file class.ilMailAddressbookGUI.php.

References $_GET, $_POST, $ilUser, ilUtil\redirect(), and ilUtil\sendInfo().

         {
                 global $ilUser;
 
                 if ($_GET['addr_id'] && is_array($_GET['addr_id']))
                         $addr_ids = $_GET['addr_id'];
                 else if ((int)$_GET['addr_id'])
                         $addr_ids = array((int)$_GET['addr_id']);
                 else if ($_POST['addr_id'] && is_array($_POST['addr_id']))
                         $addr_ids = $_POST['addr_id'];
                 else if ((int)$_POST['addr_id'])
                         $addr_ids = array((int)$_POST['addr_id']);
 
 //              $addr_ids = ((int)$_GET['addr_id']) ? array((int)$_GET['addr_id']) : $_POST['addr_id'];
                 
                 if (!$addr_ids)
                 {
                         ilUtil::sendInfo($this->lng->txt('mail_select_one_entry'));
                         $this->showAddressbook();                       
                         return true;
                 }
                 
                 $mail_data = $this->umail->getSavedData();              
                 if(!is_array($mail_data))
                 {
                         $this->umail->savePostData($ilUser->getId(), array(), '', '', '', '', '', '', '', '');
                 }       
                 
                 $members = array();     
                 foreach ($addr_ids as $addr_id)
                 {
                         $entry = $this->abook->getEntry($addr_id);
                         
                         if(strlen($entry['login']) && !$this->umail->doesRecipientStillExists($entry['login'], $mail_data['rcp_to'])) {
                                 $members[] = $entry['login'];
                         } else if(strlen($entry['email']) && !$this->umail->doesRecipientStillExists($entry['email'], $mail_data['rcp_to'])) {
                                 $members[] = $entry['email'];
                         }
                 }
                 
                 if(count($members))
                 {
                         $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_type'],
                                 $mail_data['m_email'],
                                 $mail_data['m_subject'],
                                 $mail_data['m_message'],
                                 $mail_data['use_placeholders']
                         );
                 }
 
                 ilUtil::redirect("ilias.php?baseClass=ilMailGUI&type=search_res");
         }

Here is the call graph for this function:

◆ performDelete()

ilMailAddressbookGUI::performDelete ( )

Delete entry.

Definition at line 240 of file class.ilMailAddressbookGUI.php.

References $_POST, $lng, and ilUtil\sendInfo().

         {
                 global $lng;
                 
                 if (is_array($_POST['addr_id']))
                 {                       
                         if ($this->abook->deleteEntries($_POST['addr_id']))
                         {
                                 ilUtil::sendInfo($lng->txt("mail_deleted_entry"));
                         }
                         else
                         {
                                 ilUtil::sendInfo($lng->txt("mail_delete_error"));
                         }
                 }
                 else
                 {
                         ilUtil::sendInfo($lng->txt("mail_delete_error"));
                 }
                 
                 $this->showAddressbook();
         
                 return true;    
         }

Here is the call graph for this function:

◆ resetAddressbookFilter()

ilMailAddressbookGUI::resetAddressbookFilter ( )

Definition at line 791 of file class.ilMailAddressbookGUI.php.

         {
                 $table = new ilAddressbookTableGUI($this, 'showAddressbook');
                 $table->resetOffset();
                 $table->resetFilter();
                 $this->showAddressbook();
         }

◆ search()

ilMailAddressbookGUI::search ( )

Definition at line 393 of file class.ilMailAddressbookGUI.php.

References $_GET, $_POST, $_SESSION, $ilCtrl, $ilSetting, $ilUser, $lng, $options, $ref_id, $tpl, ilLink\_getStaticLink(), ilChatroom\byRoomId(), ilChatroom\checkPermissionsOfUser(), ilChatroom\lookupPrivateRoomTitle(), ilUtil\sendFailure(), ilUtil\sendSuccess(), and ilSelectInputGUI\setOptions().

         {
                 $_SESSION['addr_search'] = $_POST['search_qry'];
                 
                 $this->showAddressbook();
                 
                 return true;
         }

Here is the call graph for this function:

◆ setAddressbookFilter()

ilMailAddressbookGUI::setAddressbookFilter ( )

Definition at line 783 of file class.ilMailAddressbookGUI.php.

         {
                 $table = new ilAddressbookTableGUI($this, 'showAddressbook');
                 $table->resetOffset();
                 $table->writeFilterToSession();
                 $this->showAddressbook();
         }

◆ showSubTabs()

ilMailAddressbookGUI::showSubTabs ( )

Definition at line 748 of file class.ilMailAddressbookGUI.php.

Referenced by executeCommand().

         {
                 global $ilHelp;
                 
                 if($this->tabs_gui->hasTabs())
                 {               
                         $this->tabs_gui->addSubTab('mail_my_entries', $this->lng->txt('mail_my_entries'), $this->ctrl->getLinkTarget($this));
                         $this->tabs_gui->addSubTab('mail_my_mailing_lists', $this->lng->txt('mail_my_mailing_lists'), $this->ctrl->getLinkTargetByClass('ilmailinglistsgui'));
                         $this->tabs_gui->addSubTab('mail_my_courses', $this->lng->txt('mail_my_courses'), $this->ctrl->getLinkTargetByClass('ilmailsearchcoursesgui'));
                         $this->tabs_gui->addSubTab('mail_my_groups', $this->lng->txt('mail_my_groups'), $this->ctrl->getLinkTargetByClass('ilmailsearchgroupsgui'));
                         $this->has_sub_tabs = true;                     
                 }
                 else
                 {
                         $ilHelp->setScreenIdComponent("contacts");
                         
                         $this->tabs_gui->addTab('mail_my_entries', $this->lng->txt('mail_my_entries'), $this->ctrl->getLinkTarget($this));
                         $this->tabs_gui->addTab('mail_my_mailing_lists', $this->lng->txt('mail_my_mailing_lists'), $this->ctrl->getLinkTargetByClass('ilmailinglistsgui'));
                         $this->tabs_gui->addTab('mail_my_courses', $this->lng->txt('mail_my_courses'), $this->ctrl->getLinkTargetByClass('ilmailsearchcoursesgui'));
                         $this->tabs_gui->addTab('mail_my_groups', $this->lng->txt('mail_my_groups'), $this->ctrl->getLinkTargetByClass('ilmailsearchgroupsgui'));
                 }
         }