Collaboration diagram for ilMailAddressbookGUI:

Public Member Functions
	__construct ()
	executeCommand ()
	checkInput ($addr_id=0)
	Check user's input.
	saveEntry ()
	Save/edit entry.
	confirmDelete ()
	Confirm delete entry.
	performDelete ()
	Delete entry.
	cancel ()
	Cancel action.
	showAddressForm ()
	mailToUsers ()
	search ()
	showAddressbook ()
	Show user's addressbook.
	lookupAddressbookAsync ()
	showSubTabs ()
	activateTab ($a_id)

Private Attributes
	$tpl = null
	$ctrl = 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

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

ilMailAddressbookGUI::activateTab ( $a_id )

Definition at line 824 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:

ilMailAddressbookGUI::cancel ( )

Cancel action.

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

References showAddressbook().

        {
                $this->showAddressbook();
        }

Here is the call graph for this function:

ilMailAddressbookGUI::checkInput ( $addr_id = 0 )

Check user's input.

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

References $_POST, ilObjUser\_lookupId(), ilUtil\is_email(), ilUtil\sendInfo(), and ilUtil\stripSlashes().

Referenced by saveEntry().

        {
                // 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:

Here is the caller graph for this function:

ilMailAddressbookGUI::confirmDelete ( )

Confirm delete entry.

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

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

        {
                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:

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:

ilMailAddressbookGUI::lookupAddressbookAsync ( )

Definition at line 780 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"] . "%";
            $result = array();
            
            if( !$search )
            {
                echo ilJsonUtil::encode($result);
                exit;
            }
            $mailAdrBookObj = new ilMailAddressbook;
            $result = $mailAdrBookObj->getAddressbookAsync($search);
            echo ilJsonUtil::encode($result);
            exit;
        }

Here is the call graph for this function:

ilMailAddressbookGUI::mailToUsers ( )

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

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

        {
                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:

ilMailAddressbookGUI::performDelete ( )

Delete entry.

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

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

        {
                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:

ilMailAddressbookGUI::saveEntry ( )

Save/edit entry.

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

References $_GET, $_POST, $_SESSION, $lng, checkInput(), ilUtil\sendInfo(), showAddressbook(), showAddressForm(), and ilUtil\stripSlashes().

        {
                global $lng;
                
                if ($this->checkInput($_GET["addr_id"]))
                {
                        if ($_GET["addr_id"])
                        {
                                $this->abook->updateEntry(ilUtil::stripSlashes($_GET["addr_id"]),
                                                                                ilUtil::stripSlashes($_POST["login"]),
                                                                                ilUtil::stripSlashes($_POST["firstname"]),
                                                                                ilUtil::stripSlashes($_POST["lastname"]),
                                                                                ilUtil::stripSlashes($_POST["email"]));
                                ilUtil::sendInfo($lng->txt("mail_entry_changed"));
                        }
                        else
                        {
                                $this->abook->addEntry(ilUtil::stripSlashes($_POST["login"]),
                                                                           ilUtil::stripSlashes($_POST["firstname"]),
                                                                           ilUtil::stripSlashes($_POST["lastname"]),
                                                                           ilUtil::stripSlashes($_POST["email"]));
                                ilUtil::sendInfo($lng->txt("mail_entry_added"));
                        }
                        
                        unset($_SESSION['addr_search']);
                        
                        $this->showAddressbook();
                }
                else
                {
                        $this->showAddressForm();
                }
                
                return true;
        }

Here is the call graph for this function:

ilMailAddressbookGUI::search ( )

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

References $_POST, $_SESSION, and showAddressbook().

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

Here is the call graph for this function:

ilMailAddressbookGUI::showAddressbook ( )

Show user's addressbook.

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

References $_GET, $_SESSION, $ilCtrl, $ilUser, $lng, $result, ilUtil\formCheckbox(), ilUtil\prepareFormOutput(), and ilTextInputGUI\setDataSource().

Referenced by cancel(), confirmDelete(), mailToUsers(), performDelete(), saveEntry(), and search().

        {
            global $rbacsystem, $lng, $ilUser, $ilCtrl, $ilias;
                $this->tpl->setTitle($this->lng->txt("mail_addressbook"));              
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.mail_addressbook.html", "Services/Contact");                
            // check if current user may send mails
            include_once "Services/Mail/classes/class.ilMail.php";
            $mail = new ilMail($_SESSION["AccountId"]);
            $mailing_allowed = $rbacsystem->checkAccess('internal_mail',$mail->getMailObjectReferenceId());
            // searchbox
            include_once('./Services/Form/classes/class.ilPropertyFormGUI.php');
            $searchform = new ilPropertyFormGUI();
            $searchform->setFormAction($this->ctrl->getFormAction($this, "saveEntry"));
            $dsDataLink = $ilCtrl->getLinkTarget($this, 'lookupAddressbookAsync', '', true, false);
            $inp = new ilTextInputGUI($this->lng->txt('search_for'), 'search_qry');
            $inp->setDataSource($dsDataLink);
            $searchform->addItem($inp);
            $searchform->addCommandButton('search', $this->lng->txt("send"));
            $this->tpl->setVariable('SEARCHFORM', $searchform->getHtml());
            $this->tpl->setVariable('ACTION', $this->ctrl->getFormAction($this, "saveEntry"));
            $this->tpl->setVariable("TXT_SEARCH_FOR",$this->lng->txt("search_for"));
            $this->tpl->setVariable("BUTTON_SEARCH",$this->lng->txt("send"));
            if (strlen(trim($_SESSION["addr_search"])) > 0)
            {
                $this->tpl->setVariable("VALUE_SEARCH_FOR", ilUtil::prepareFormOutput(trim($_SESSION["addr_search"]), true));
            }
            $tbl = new ilAddressbookTableGUI($this);
            $tbl->setTitle($lng->txt("mail_addr_entries"));
            $tbl->setRowTemplate("tpl.mail_addressbook_row.html", "Services/Contact");
            $tbl->setDefaultOrderField('login');
            $result = array();
            $this->abook->setSearchQuery($_SESSION['addr_search']);
            $entries = $this->abook->getEntries();
            $tbl->addColumn('', 'check', '10%', true);
            $tbl->addColumn($this->lng->txt('login'), 'login', '20%');
            $tbl->addColumn($this->lng->txt('firstname'), 'firstname', '20%');
            $tbl->addColumn($this->lng->txt('lastname'), 'lastname', '20%');
            $tbl->addColumn($this->lng->txt('email'), 'email', '20%');
            $tbl->addColumn($this->lng->txt('actions'), '', '10%');
            include_once("./Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
            if (count($entries))
            {
                $tbl->enable('select_all');
                $tbl->setSelectAllCheckbox('addr_id');
                $chatSettings = new ilSetting('chatroom');
                $chat_active = $chatSettings->get("chat_enabled", false);
                $counter = 0;
                
                foreach ($entries as $entry)
                {
                    $result[$counter]['check'] = ilUtil::formCheckbox(0, 'addr_id[]', $entry["addr_id"]);
                    $this->ctrl->setParameter($this, 'addr_id',  $entry['addr_id']);
                        $result[$counter]['login'] = '';
                        if($entry["login"] != "")
                        {
                                if($mailing_allowed)
                                {
                                        $result[$counter]['login_linked_link'] = $this->ctrl->getLinkTarget($this, 'mailToUsers');
                                        $result[$counter]['login']             = $result[$counter]['login_linked_login'] = $entry["login"];
                                }
                                else
                                {
                                        $result[$counter]['login'] = $result[$counter]['login_unliked'] = $entry["login"];
                                }
                        }
                        $result[$counter]['firstname'] = $entry["firstname"];
                        $result[$counter]['lastname']  = $entry["lastname"];
                        if($_GET["baseClass"] == "ilMailGUI" && $rbacsystem->checkAccess("smtp_mail", $this->umail->getMailObjectReferenceId()))
                        {
                                $result[$counter]['email']             = $result[$counter]['email_linked_email'] = $entry["email"];
                                $result[$counter]['email_linked_link'] = $this->ctrl->getLinkTarget($this, "mailToUsers");
                        }
                        else
                        {
                                $result[$counter]['email'] = $result[$counter]['email_unlinked'] = $entry["email"];
                        }
                    $current_selection_list = new ilAdvancedSelectionListGUI();
                    $current_selection_list->setListTitle($this->lng->txt("actions"));
                    $current_selection_list->setId("act_".$counter);
                    $current_selection_list->addItem($this->lng->txt("edit"), '', $this->ctrl->getLinkTarget($this, "showAddressForm"));
                    if ($mailing_allowed)
                        $current_selection_list->addItem($this->lng->txt("send_mail_to"), '', $this->ctrl->getLinkTarget($this, "mailToUsers"));
                    $current_selection_list->addItem($this->lng->txt("delete"), '', $this->ctrl->getLinkTarget($this, "confirmDelete"));
                    if ($chat_active)
                        $current_selection_list->addItem($this->lng->txt("invite_to_chat"), '', $this->ctrl->getLinkTarget($this, "inviteToChat"));
                    $this->ctrl->clearParameters($this);
                    $result[$counter]['COMMAND_SELECTION_LIST'] = $current_selection_list->getHTML();
                    ++$counter;
                }
                if ($mailing_allowed)
                    $tbl->addMultiCommand('mailToUsers', $this->lng->txt('send_mail_to'));
                $tbl->addMultiCommand('confirmDelete', $this->lng->txt('delete'));
                if ($chat_active)
                    $tbl->addMultiCommand('inviteToChat', $this->lng->txt('invite_to_chat'));
            }
            else
            {
                $tbl->disable('header');
                $tbl->disable('footer');
                $tbl->setNoEntriesText($this->lng->txt('mail_search_no'));
            }
            $tbl->setData($result);
            $tbl->addCommandButton('showAddressForm', $this->lng->txt('add'));
            $this->tpl->setVariable('TABLE', $tbl->getHTML());
            $this->tpl->show();
            unset($_SESSION['addr_search']);
            return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMailAddressbookGUI::showAddressForm ( )

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

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

Referenced by saveEntry().

        {
                global $rbacsystem, $lng, $ilUser;
                $this->tpl->setTitle($this->lng->txt("mail_addressbook"));              
                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.mail_addressbook_form.html", "Services/Contact");
                
                include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();                
                $form->setTitle($_GET['addr_id'] ? $lng->txt("mail_edit_entry") : $lng->txt("mail_new_entry")); 
                
                if ($_GET['addr_id'])
                {
                        $this->ctrl->setParameter($this, 'addr_id', $_GET['addr_id']);
                }
                
                $entry = $this->abook->getEntry($_GET['addr_id']);
                $form->setFormAction($this->ctrl->getFormAction($this, "saveEntry"));
                
                $formItem = new ilTextInputGUI($this->lng->txt("username"), "login");
                $formItem->setValue(isset($_POST['login']) ? ilUtil::prepareFormOutput($_POST['login'], true) : ilUtil::prepareFormOutput($entry['login']));
                $form->addItem($formItem);
                
                $formItem = new ilTextInputGUI($this->lng->txt("firstname"), "firstname");
                $formItem->setValue(isset($_POST['firstname']) ? ilUtil::prepareFormOutput($_POST['firstname'], true) : ilUtil::prepareFormOutput($entry['firstname']));
                $form->addItem($formItem);
                
                $formItem = new ilTextInputGUI($this->lng->txt("lastname"), "lastname");
                $formItem->setValue(isset($_POST['lastname']) ? ilUtil::prepareFormOutput($_POST['lastname'], true) : ilUtil::prepareFormOutput($entry['lastname']));
                $form->addItem($formItem);
                
                $formItem = new ilTextInputGUI($this->lng->txt("email"), "email");
                $formItem->setValue(isset($_POST['email']) ? ilUtil::prepareFormOutput($_POST['email'], true) : ilUtil::prepareFormOutput($entry['email']));
                $form->addItem($formItem);
                
                $form->addCommandButton('saveEntry',$this->lng->txt('save'));
                $form->addCommandButton('cancel',$this->lng->txt('cancel'));
                
                $this->tpl->setVariable('FORM', $form->getHTML());
                
                $this->tpl->show();
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilMailAddressbookGUI::showSubTabs ( )

Definition at line 801 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'));
                }
        }