ilSurveyRaterGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilSurveyRaterGUI:

Public Member Functions
	__construct (ilSurveyParticipantsGUI $parent, ilObjSurvey $survey)
	executeCommand ()
	initOptionSelectForm ()
	doAutoComplete ()
	addRater (ilPropertyFormGUI $form)
	mailRaters (ilPropertyFormGUI $a_form=null)
	initMailRatersForm (int $appr_id, array $rec_ids)
	mailRatersAction ()
	addExternalRater (ilPropertyFormGUI $form)
	addFromSearch (array $user_ids)

Protected Member Functions
	cancel ()
	add (ilPropertyFormGUI $form=null)
	continue ()

Protected Attributes
ILIAS Survey Editing EditingGUIRequest	$edit_request
ilCtrl	$ctrl
ilLanguage	$lng
ILIAS DI UIServices	$ui
ILIAS Refinery Factory	$refinery
ilGlobalTemplateInterface	$main_tpl
ilSurveyParticipantsGUI	$parent
ilObjSurvey	$survey
ilObjUser	$user
ilAccessHandler	$access
ilTabsGUI	$tabs

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de ilSurveyRaterGUI: ilRepositorySearchGUI

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

Constructor & Destructor Documentation

__construct()

ilSurveyRaterGUI::__construct	(	ilSurveyParticipantsGUI	$parent,
		ilObjSurvey	$survey
	)

Definition at line 39 of file class.ilSurveyRaterGUI.php.

References $DIC, $parent, $survey, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

      {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->ui = $DIC->ui();
        $this->refinery = $DIC->refinery();
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->parent = $parent;
        $this->survey = $survey;
        $this->user = $DIC->user();
        $this->access = $DIC->access();
        $this->tabs = $DIC->tabs();

        $this->ctrl->saveParameter($this, "appr_id");
        $this->edit_request = $DIC->survey()
            ->internal()
            ->gui()
            ->editing()
            ->request();
    }

Here is the call graph for this function:

Member Function Documentation

add()

ilSurveyRaterGUI::add ( ilPropertyFormGUI  $form = null )

protected

Definition at line 108 of file class.ilSurveyRaterGUI.php.

References $main_tpl, initOptionSelectForm(), and ilGlobalTemplateInterface\setContent().

Referenced by continue().

     : void {
        $form_html = (!is_null($form))
            ? $form->getHTML()
            : $this->initOptionSelectForm()->getHTML();
        $main_tpl = $this->main_tpl;
        $main_tpl->setContent($form_html);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addExternalRater()

ilSurveyRaterGUI::addExternalRater

(

ilPropertyFormGUI

$form

)

Definition at line 408 of file class.ilSurveyRaterGUI.php.

References ILIAS\Repository\ctrl(), and ilPropertyFormGUI\getInput().

Referenced by continue().

                                                             : void
    {
        $appr_id = $this->edit_request->getAppraiseeId();

        if (!$appr_id) {
            $this->ctrl->redirect($this, "listAppraisees");
        }

        $this->ctrl->setParameter($this, "appr_id", $appr_id);

        $code_id = $this->parent->addCodeForExternal(
            $form->getInput("email"),
            $form->getInput("lname"),
            $form->getInput("fname")
        );

        $this->survey->addRater($appr_id, 0, $code_id);

        $this->ctrl->setParameter($this->parent, "appr_id", $appr_id);
        if ($code_id > 0) {
            $this->ctrl->setParameter($this, "rater_id", "a" . $code_id);
            $this->ctrl->redirect($this, "mailRaters");
        }
        $this->ctrl->redirect($this->parent, "editRaters");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addFromSearch()

ilSurveyRaterGUI::addFromSearch

(

array

$user_ids

)

Definition at line 434 of file class.ilSurveyRaterGUI.php.

References $access, $user, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

     : void {
        // check access
        $ilAccess = $this->access;
        $ilUser = $this->user;

        $user_id = 0;

        $appr_id = $this->parent->handleRatersAccess();

        foreach ($user_ids as $user_id) {
            if ($user_id > 0) {
                if ($ilAccess->checkAccess("write", "", $this->survey->getRefId()) ||
                    $this->survey->get360SelfEvaluation() ||
                    $user_id != $ilUser->getId()) {
                    if ($appr_id != $user_id) {
                        $this->survey->addRater($appr_id, $user_id);
                        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt("settings_saved"), true);
                    } else {
                        $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt("svy_appraisses_cannot_be_raters"), true);
                        $user_id = 0;
                    }
                }
            }
        }

        $user_str = implode(";", array_map(static function ($u): string {
            return "u" . $u;
        }, $user_ids));

        $this->ctrl->setParameter($this->parent, "appr_id", $appr_id);
        if ($user_id > 0) {
            $this->ctrl->setParameter($this, "rater_id", $user_str);
            $this->ctrl->redirect($this, "mailRaters");
        }
        $this->ctrl->redirect($this->parent, "editRaters");
    }

Here is the call graph for this function:

addRater()

ilSurveyRaterGUI::addRater

(

ilPropertyFormGUI

$form

)

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

References $access, $user, ilObjUser\_lookupId(), ILIAS\Repository\ctrl(), ilPropertyFormGUI\getInput(), and ILIAS\Repository\lng().

Referenced by continue().

                                                     : void
    {
        // check access
        $ilAccess = $this->access;
        $ilUser = $this->user;

        $appr_id = $this->parent->handleRatersAccess();
        $user = $form->getInput("user");
        $user_id = ilObjUser::_lookupId($user);
        if ($user_id > 0) {
            if ($ilAccess->checkAccess("write", "", $this->survey->getRefId()) ||
                $this->survey->get360SelfEvaluation() ||
                $user_id !== $ilUser->getId()) {
                if ($appr_id !== $user_id) {
                    $this->survey->addRater($appr_id, $user_id);
                    $this->main_tpl->setOnScreenMessage('success', $this->lng->txt("settings_saved"), true);
                } else {
                    $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt("svy_appraisses_cannot_be_raters"), true);
                    $user_id = 0;
                }
            }
        } else {
            $this->main_tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt("svy_user_not_found") . " (" . $user . ")",
                true
            );
        }

        $this->ctrl->setParameter($this->parent, "appr_id", $appr_id);
        if ($user_id > 0) {
            $this->ctrl->setParameter($this, "rater_id", "u" . $user_id);
            $this->ctrl->redirect($this, "mailRaters");
        }
        $this->ctrl->redirect($this->parent, "editRaters");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cancel()

ilSurveyRaterGUI::cancel ( )

protected

Definition at line 103 of file class.ilSurveyRaterGUI.php.

References ILIAS\Repository\ctrl().

                               : void
    {
        $this->ctrl->redirect($this->parent, "editRaters");
    }

Here is the call graph for this function:

continue()

ilSurveyRaterGUI::continue ( )

protected

Definition at line 198 of file class.ilSurveyRaterGUI.php.

References add(), addExternalRater(), addRater(), ILIAS\Repository\ctrl(), and initOptionSelectForm().

                                 : void
    {
        $form = $this->initOptionSelectForm();
        if ($form->checkInput()) {
            switch ($form->getInput("type")) {
                case "direct":
                    $this->addRater($form);
                    break;

                case "external":
                    $this->addExternalRater($form);
                    break;

                case "search":
                    $this->ctrl->redirectByClass("ilrepositorysearchgui", "");
                    break;
            }
        } else {
            $form->setValuesByPost();
            $this->add($form);
        }
    }

Here is the call graph for this function:

doAutoComplete()

ilSurveyRaterGUI::doAutoComplete

(

)

Definition at line 179 of file class.ilSurveyRaterGUI.php.

References exit, ilUserAutoComplete\MAX_ENTRIES, and ilUserAutoComplete\PRIVACY_MODE_RESPECT_USER_SETTING.

                                    : void
    {
        $fields = array('login','firstname','lastname','email');

        $auto = new ilUserAutoComplete();
        $auto->setSearchFields($fields);
        $auto->setResultField('login');
        $auto->enableFieldSearchableCheck(true);
        $auto->setMoreLinkAvailable(true);
        $auto->setPrivacyMode(ilUserAutoComplete::PRIVACY_MODE_RESPECT_USER_SETTING);

        if ($this->edit_request->getFetchAll()) {
            $auto->setLimit(ilUserAutoComplete::MAX_ENTRIES);
        }

        echo $auto->getList($this->edit_request->getTerm());
        exit();
    }

executeCommand()

ilSurveyRaterGUI::executeCommand

(

)

Definition at line 64 of file class.ilSurveyRaterGUI.php.

References $ctrl, ILIAS\Repository\ctrl(), and ilCtrl\getNextClass().

                                    : void
    {
        $ctrl = $this->ctrl;

        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd("add");

        switch ($next_class) {
            case 'ilrepositorysearchgui':
                $rep_search = new ilRepositorySearchGUI();

                $this->ctrl->setParameter($this, "rate360", 1);
                $this->ctrl->saveParameter($this, "appr_id");

                $rep_search->setCallback(
                    $this,
                    'addFromSearch',
                    array()
                );

                // Set tabs
                $this->ctrl->setReturn($this, 'add');
                $this->ctrl->forwardCommand($rep_search);
                break;

            default:
                if (in_array($cmd, ["add",
                                    "doAutoComplete",
                                    "continue",
                                    "mailRaters",
                                    "mailRatersAction",
                                    "cancel"
                ])) {
                    $this->$cmd();
                }
                break;
        }
    }

Here is the call graph for this function:

initMailRatersForm()

ilSurveyRaterGUI::initMailRatersForm	(	int	$appr_id,
		array	$rec_ids
	)

Definition at line 267 of file class.ilSurveyRaterGUI.php.

References ILIAS\LTI\ToolProvider\$key, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setRequired().

Referenced by mailRatersAction().

     : ilPropertyFormGUI {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, "mailRatersAction"));
        $form->setTitle($this->lng->txt('compose'));

        $all_data = $this->survey->getRatersData($appr_id);

        $rec_data = array();
        foreach ($rec_ids as $rec_id) {
            if (isset($all_data[$rec_id])) {
                $rec_data[] = $all_data[$rec_id]["lastname"] . ", " .
                    $all_data[$rec_id]["firstname"] .
                    " (" . $all_data[$rec_id]["email"] . ")";
            }
        }
        sort($rec_data);
        $rec = new ilCustomInputGUI($this->lng->txt('recipients'));
        $rec->setHtml(implode("<br />", $rec_data));
        $form->addItem($rec);

        $subject = new ilTextInputGUI($this->lng->txt('subject'), 'subject');
        $subject->setSize(50);
        $subject->setRequired(true);
        $form->addItem($subject);

        $existingdata = $this->survey->getExternalCodeRecipients();
        $existingcolumns = array();
        if (count($existingdata)) {
            $first = array_shift($existingdata);
            foreach ($first as $key => $value) {
                if (strcmp($key, 'code') !== 0 && strcmp($key, 'email') !== 0 && strcmp($key, 'sent') !== 0) {
                    $existingcolumns[] = '[' . $key . ']';
                }
            }
        }

        $mailmessage_u = new ilTextAreaInputGUI($this->lng->txt('survey_360_rater_message_content_registered'), 'message_u');
        $mailmessage_u->setRequired(true);
        $mailmessage_u->setCols(80);
        $mailmessage_u->setRows(10);
        $form->addItem($mailmessage_u);

        $mailmessage_a = new ilTextAreaInputGUI($this->lng->txt('survey_360_rater_message_content_anonymous'), 'message_a');
        $mailmessage_a->setRequired(true);
        $mailmessage_a->setCols(80);
        $mailmessage_a->setRows(10);
        $mailmessage_a->setInfo(sprintf($this->lng->txt('message_content_info'), implode(', ', $existingcolumns)));
        $form->addItem($mailmessage_a);

        $recf = new ilHiddenInputGUI("rtr_id");
        $recf->setValue(implode(";", $rec_ids));
        $form->addItem($recf);

        $form->addCommandButton("mailRatersAction", $this->lng->txt("send"));
        $form->addCommandButton("cancel", $this->lng->txt("svy_dont_send"));

        $subject->setValue(sprintf($this->lng->txt('survey_360_rater_subject_default'), $this->survey->getTitle()));
        $mailmessage_u->setValue($this->lng->txt('survey_360_rater_message_content_registered_default'));
        $mailmessage_a->setValue($this->lng->txt('survey_360_rater_message_content_anonymous_default'));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initOptionSelectForm()

ilSurveyRaterGUI::initOptionSelectForm

(

)

Definition at line 118 of file class.ilSurveyRaterGUI.php.

References $ctrl, $lng, ilSubEnabledFormPropertyGUI\addSubItem(), ILIAS\Repository\lng(), ilFormPropertyGUI\setRequired(), and ilRadioOption\setValue().

Referenced by add(), and continue().

                                          : ilPropertyFormGUI
    {
        $ctrl = $this->ctrl;
        $lng = $this->lng;

        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();

        //
        $radg = new ilRadioGroupInputGUI($lng->txt("svy_type_of_rater"), "type");
        //$radg->setInfo($lng->txt(""));
        //$radg->setValue();
        $op1 = new ilRadioOption($lng->txt("svy_add_internal_user"), "direct", $lng->txt("svy_add_internal_user_info"));
        $radg->addOption($op1);
        $radg->setValue("direct");

        $user = new \ilTextInputGUI($lng->txt("obj_user"), "user");
        $user->setDataSource(
            $ctrl->getLinkTargetByClass(
                "ilsurveyratergui",
                "doAutoComplete",
                "",
                true
            )
        );
        $user->setRequired(true);
        $user->setMulti(false);
        $op1->addSubItem($user);


        $op2 = new ilRadioOption($lng->txt("svy_search_user"), "search", $lng->txt("svy_search_user_info"));
        $radg->addOption($op2);

        $op3 = new ilRadioOption($lng->txt("svy_external_rater"), "external", $lng->txt("svy_external_rater_info"));
        $radg->addOption($op3);

        $email = new ilEMailInputGUI($this->lng->txt("email"), "email");
        $email->setRequired(true);
        $op3->addSubItem($email);

        $lname = new ilTextInputGUI($this->lng->txt("lastname"), "lname");
        $lname->setSize(30);
        $op3->addSubItem($lname);

        $fname = new ilTextInputGUI($this->lng->txt("firstname"), "fname");
        $fname->setSize(30);
        $op3->addSubItem($fname);


        $form->addItem($radg);

        // save and cancel commands
        $form->addCommandButton("continue", $lng->txt("svy_save_and_continue"));
        $form->addCommandButton("cancel", $lng->txt("cancel"));

        $form->setTitle($lng->txt("svy_add_rater"));
        $form->setFormAction($ctrl->getFormAction($this));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

mailRaters()

ilSurveyRaterGUI::mailRaters

(

ilPropertyFormGUI

$a_form = null

)

Definition at line 259 of file class.ilSurveyRaterGUI.php.

References ILIAS\Repository\ctrl().

                                                                : void
    {
        $appr_id = $this->parent->handleRatersAccess();
        $this->ctrl->setParameterByClass("ilSurveyParticipantsGUI", "appr_id", $appr_id);
        $this->ctrl->setParameterByClass("ilSurveyParticipantsGUI", "rater_id", $this->edit_request->getRaterId());
        $this->ctrl->redirectByClass("ilSurveyParticipantsGUI", "mailRaters");
    }

Here is the call graph for this function:

mailRatersAction()

ilSurveyRaterGUI::mailRatersAction

(

)

Definition at line 334 of file class.ilSurveyRaterGUI.php.

References $url, $user, ilLink\_getStaticLink(), ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), initMailRatersForm(), and ILIAS\Repository\lng().

                                      : void
    {
        $ilUser = $this->user;

        $appr_id = $this->parent->handleRatersAccess();
        $this->ctrl->setParameter($this, "appr_id", $appr_id);

        $rec_ids = $this->edit_request->getRaterIds();
        if (count($rec_ids) === 0) {
            $this->ctrl->redirect($this, "editRaters");
        }

        $form = $this->initMailRatersForm($appr_id, $rec_ids);
        if ($form->checkInput()) {
            $txt_u = $form->getInput("message_u");
            $txt_a = $form->getInput("message_a");
            $subj = $form->getInput("subject");

            // #12743
            $sender_id = (trim($ilUser->getEmail()))
                ? $ilUser->getId()
                : ANONYMOUS_USER_ID;

            $all_data = $this->survey->getRatersData($appr_id);
            foreach ($rec_ids as $rec_id) {
                if (isset($all_data[$rec_id])) {
                    $user = $all_data[$rec_id];

                    // anonymous
                    if (strpos($rec_id, "a") === 0) {
                        $mytxt = $txt_a;
                        $url = $user["href"];
                        $rcp = $user["email"];
                    }
                    // reg
                    else {
                        $mytxt = $txt_u;
                        $user["code"] = $this->lng->txt("survey_code_mail_on_demand");
                        $url = ilLink::_getStaticLink($this->survey->getRefId());
                        $rcp = $user["login"]; // #15141
                    }

                    $mytxt = str_replace(
                        ["[lastname]", "[firstname]", "[url]", "[code]"],
                        [$user["lastname"], $user["firstname"], $url, $user["code"]],
                        $mytxt
                    );

                    $mail = new ilMail($sender_id);
                    $mail->enqueue(
                        $rcp, // to
                        "", // cc
                        "", // bcc
                        $subj, // subject
                        $mytxt, // message
                        array() // attachments
                    );

                    $this->survey->set360RaterSent(
                        $appr_id,
                        (strpos($rec_id, "a") === 0) ? 0 : (int) substr($rec_id, 1),
                        (strpos($rec_id, "u") === 0) ? 0 : (int) substr($rec_id, 1)
                    );
                }
            }

            $this->main_tpl->setOnScreenMessage('success', $this->lng->txt("mail_sent"), true);
            $this->ctrl->redirect($this->parent, "editRaters");
        }

        $form->setValuesByPost();
//        $this->mailRatersObject($form);
    }

Here is the call graph for this function:

Field Documentation

$access

ilAccessHandler ilSurveyRaterGUI::$access

protected

Definition at line 36 of file class.ilSurveyRaterGUI.php.

Referenced by addFromSearch(), and addRater().

$ctrl

ilCtrl ilSurveyRaterGUI::$ctrl

protected

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

Referenced by executeCommand(), and initOptionSelectForm().

$edit_request

ILIAS Survey Editing EditingGUIRequest ilSurveyRaterGUI::$edit_request

protected

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

$lng

ilLanguage ilSurveyRaterGUI::$lng

protected

Definition at line 29 of file class.ilSurveyRaterGUI.php.

Referenced by initOptionSelectForm().

$main_tpl

ilGlobalTemplateInterface ilSurveyRaterGUI::$main_tpl

protected

Definition at line 32 of file class.ilSurveyRaterGUI.php.

Referenced by add().

$parent

ilSurveyParticipantsGUI ilSurveyRaterGUI::$parent

protected

Definition at line 33 of file class.ilSurveyRaterGUI.php.

Referenced by __construct().

$refinery

ILIAS Refinery Factory ilSurveyRaterGUI::$refinery

protected

Definition at line 31 of file class.ilSurveyRaterGUI.php.

$survey

ilObjSurvey ilSurveyRaterGUI::$survey

protected

Definition at line 34 of file class.ilSurveyRaterGUI.php.

Referenced by __construct().

$tabs

ilTabsGUI ilSurveyRaterGUI::$tabs

protected

Definition at line 37 of file class.ilSurveyRaterGUI.php.

$ui

ILIAS DI UIServices ilSurveyRaterGUI::$ui

protected

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

$user

ilObjUser ilSurveyRaterGUI::$user

protected

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

Referenced by addFromSearch(), addRater(), and mailRatersAction().

---

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

• Modules/Survey/Participants/class.ilSurveyRaterGUI.php