Class ilOrgUnitUserAssignmentGUI. More...

Inheritance diagram for ilOrgUnitUserAssignmentGUI:

Collaboration diagram for ilOrgUnitUserAssignmentGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	addStaff ()

	addStaffFromSearch (array $user_ids, ?string $user_type=null)

	addSubTabs ()

Public Member Functions inherited from ILIAS\Modules\OrgUnit\ARHelper\BaseCommands
	getParentGui ()

	setParentGui (BaseCommands $parent_gui)

	executeCommand ()

	addSubTabs ()

Data Fields
const	CMD_ASSIGNMENTS_RECURSIVE = 'assignmentsRecursive'

const	SUBTAB_ASSIGNMENTS = 'user_assignments'

const	SUBTAB_ASSIGNMENTS_RECURSIVE = 'user_assignments_recursive'

Data Fields inherited from ILIAS\Modules\OrgUnit\ARHelper\BaseCommands
const	CMD_INDEX = "index"

const	CMD_ADD = "add"

const	CMD_CREATE = "create"

const	CMD_EDIT = "edit"

const	CMD_UPDATE = "update"

const	CMD_CONFIRM = "confirm"

const	CMD_CONFIRM_RECURSIVE = "confirmRecursive"

const	CMD_DELETE = "delete"

const	CMD_DELETE_RECURSIVE = "deleteRecursive"

const	CMD_CANCEL = "cancel"

const	AR_ID = "arid"

Protected Member Functions
	index ()

	assignmentsRecursive ()

	confirm ()

	confirmRecursive ()

	getConfirmationGUI ()

	delete ()

	deleteRecursive ()

	cancel ()

Protected Member Functions inherited from ILIAS\Modules\OrgUnit\ARHelper\BaseCommands
	__construct ()

	index ()

	getPossibleNextClasses ()

	getActiveTabId ()

	cancel ()

	setContent (string $html)

	pushSubTab (string $subtab_id, string $url)

	activeSubTab (string $subtab_id)

	getParentRefId ()

Private Attributes
ilGlobalTemplateInterface	$main_tpl

Services	$http

ilCtrl	$ctrl

ilToolbarGUI	$toolbar

ilAccessHandler	$access

ilLanguage	$language

Additional Inherited Members
Protected Attributes inherited from ILIAS\Modules\OrgUnit\ARHelper\BaseCommands
BaseCommands	$parent_gui = null

Detailed Description

Class ilOrgUnitUserAssignmentGUI.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; dkloepfer; Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch @ilCtrl_Calls ilOrgUnitUserAssignmentGUI: ilRepositorySearchGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilOrgUnitUserAssignmentGUI::__construct ( )

Reimplemented from ILIAS\Modules\OrgUnit\ARHelper\BaseCommands.

Definition at line 42 of file class.ilOrgUnitUserAssignmentGUI.php.

    {
        global $DIC;
 
        parent::__construct();
 
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->http = $DIC->http();
        $this->ctrl = $DIC->ctrl();
        $this->toolbar = $DIC->toolbar();
        $this->access = $DIC->access();
        $this->language = $DIC->language();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Member Function Documentation

◆ addStaff()

ilOrgUnitUserAssignmentGUI::addStaff ( )

Definition at line 207 of file class.ilOrgUnitUserAssignmentGUI.php.

                              : void
    {
        if (!$this->access->checkAccess("write", "", $this->getParentRefId())) {
            $this->main_tpl->setOnScreenMessage('failure', $this->language->txt("permission_denied"), true);
            $this->ctrl->redirect($this, self::CMD_INDEX);
        }
 
        $users = explode(',', $_POST['user_login']);
        $user_ids = array();
        foreach ($users as $user) {
            $user_id = ilObjUser::_lookupId($user);
            if ($user_id) {
                $user_ids[] = $user_id;
            }
        }
 
        if (!count($user_ids)) {
            $this->main_tpl->setOnScreenMessage('failure', $this->language->txt("user_not_found"), true);
            $this->ctrl->redirect($this, self::CMD_INDEX);
        }
 
        $position_id = (int) ($_POST['user_type'] ?? ilOrgUnitPosition::CORE_POSITION_EMPLOYEE);
 
        if (!$position_id && !$position = ilOrgUnitPosition::find($position_id)) {
            $this->main_tpl->setOnScreenMessage('failure', $this->language->txt("user_not_found"), true);
            $this->ctrl->redirect($this, self::CMD_INDEX);
        }
        foreach ($user_ids as $user_id) {
            ilOrgUnitUserAssignment::findOrCreateAssignment($user_id, $position_id, $this->getParentRefId());
        }
 
        $this->main_tpl->setOnScreenMessage('success', $this->language->txt("users_successfuly_added"), true);
        $this->ctrl->redirect($this, self::CMD_INDEX);
    }

References ilObjUser\_lookupId(), ILIAS\Repository\access(), ilOrgUnitPosition\CORE_POSITION_EMPLOYEE, ILIAS\Repository\ctrl(), ilOrgUnitUserAssignment\findOrCreateAssignment(), ILIAS\Modules\OrgUnit\ARHelper\BaseCommands\getParentRefId(), ILIAS\Repository\int(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addStaffFromSearch()

ilOrgUnitUserAssignmentGUI::addStaffFromSearch	(	array	$user_ids,
		?string	$user_type = `null`
	)

Parameters

array<int> $user_ids

Definition at line 245 of file class.ilOrgUnitUserAssignmentGUI.php.

                                                                                  : void
    {
        if (!$this->access->checkAccess("write", "", $this->getParentRefId())) {
            $this->main_tpl->setOnScreenMessage('failure', $this->language->txt("permission_denied"), true);
            $this->ctrl->redirect($this, self::CMD_INDEX);
        }
 
        if (!count($user_ids)) {
            $this->main_tpl->setOnScreenMessage('failure', $this->language->txt("user_not_found"), true);
            $this->ctrl->redirect($this, self::CMD_INDEX);
        }
 
        $position_id = (int) ($user_type ?? ilOrgUnitPosition::CORE_POSITION_EMPLOYEE);
 
        if (!$position_id && !$position = ilOrgUnitPosition::find($position_id)) {
            $this->main_tpl->setOnScreenMessage('failure', $this->language->txt("user_not_found"), true);
            $this->ctrl->redirect($this, self::CMD_INDEX);
        }
        foreach ($user_ids as $user_id) {
            ilOrgUnitUserAssignment::findOrCreateAssignment($user_id, $position_id, $this->getParentRefId());
        }
 
        $this->main_tpl->setOnScreenMessage('success', $this->language->txt("users_successfuly_added"), true);
        $this->ctrl->redirect($this, self::CMD_INDEX);
    }

References ILIAS\Repository\access(), ilOrgUnitPosition\CORE_POSITION_EMPLOYEE, ILIAS\Repository\ctrl(), ilOrgUnitUserAssignment\findOrCreateAssignment(), ILIAS\Modules\OrgUnit\ARHelper\BaseCommands\getParentRefId(), ILIAS\Repository\int(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

◆ addSubTabs()

ilOrgUnitUserAssignmentGUI::addSubTabs ( )

Reimplemented from ILIAS\Modules\OrgUnit\ARHelper\BaseCommands.

Definition at line 271 of file class.ilOrgUnitUserAssignmentGUI.php.

                                : void
    {
        $this->pushSubTab(self::SUBTAB_ASSIGNMENTS, $this->ctrl
                                                         ->getLinkTarget($this, self::CMD_INDEX));
        $this->pushSubTab(self::SUBTAB_ASSIGNMENTS_RECURSIVE, $this->ctrl
                                                                   ->getLinkTarget(
                                                                       $this,
                                                                       self::CMD_ASSIGNMENTS_RECURSIVE
                                                                   ));
    }

References ILIAS\Repository\ctrl(), and ILIAS\Modules\OrgUnit\ARHelper\BaseCommands\pushSubTab().

Referenced by assignmentsRecursive(), and index().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assignmentsRecursive()

ilOrgUnitUserAssignmentGUI::assignmentsRecursive ( )

protected

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

                                             : void
    {
        $this->addSubTabs();
        $this->activeSubTab(self::SUBTAB_ASSIGNMENTS_RECURSIVE);
        // Tables
        $html = '';
        foreach (ilOrgUnitPosition::getActiveForPosition($this->getParentRefId()) as $ilOrgUnitPosition) {
            $ilOrgUnitRecursiveUserAssignmentTableGUI =
                new ilOrgUnitRecursiveUserAssignmentTableGUI(
                    $this,
                    self::CMD_ASSIGNMENTS_RECURSIVE,
                    $ilOrgUnitPosition
                );
            $html .= $ilOrgUnitRecursiveUserAssignmentTableGUI->getHTML();
        }
        $this->setContent($html);
    }

References ILIAS\Modules\OrgUnit\ARHelper\BaseCommands\activeSubTab(), addSubTabs(), ilOrgUnitPosition\getActiveForPosition(), ILIAS\Modules\OrgUnit\ARHelper\BaseCommands\getParentRefId(), and ILIAS\Modules\OrgUnit\ARHelper\BaseCommands\setContent().

Here is the call graph for this function:

◆ cancel()

ilOrgUnitUserAssignmentGUI::cancel ( )

protected

Exceptions

ilCtrlException

Reimplemented from ILIAS\Modules\OrgUnit\ARHelper\BaseCommands.

Definition at line 202 of file class.ilOrgUnitUserAssignmentGUI.php.

                               : void
    {
        $this->ctrl->redirect($this, self::CMD_INDEX);
    }

References ILIAS\Repository\ctrl().

Referenced by delete(), and deleteRecursive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirm()

ilOrgUnitUserAssignmentGUI::confirm ( )

protected

Definition at line 136 of file class.ilOrgUnitUserAssignmentGUI.php.

                                : void
    {
        $confirmation = $this->getConfirmationGUI();
        $confirmation->setConfirm($this->language->txt('remove_user'), self::CMD_DELETE);
 
        $this->setContent($confirmation->getHTML());
    }

References getConfirmationGUI(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Modules\OrgUnit\ARHelper\BaseCommands\setContent().

Here is the call graph for this function:

◆ confirmRecursive()

ilOrgUnitUserAssignmentGUI::confirmRecursive ( )

protected

Definition at line 144 of file class.ilOrgUnitUserAssignmentGUI.php.

                                         : void
    {
        $confirmation = $this->getConfirmationGUI();
        $confirmation->setConfirm($this->language->txt('remove_user'), self::CMD_DELETE_RECURSIVE);
 
        $this->setContent($confirmation->getHTML());
    }

References getConfirmationGUI(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Modules\OrgUnit\ARHelper\BaseCommands\setContent().

Here is the call graph for this function:

◆ delete()

ilOrgUnitUserAssignmentGUI::delete ( )

protected

Definition at line 172 of file class.ilOrgUnitUserAssignmentGUI.php.

                               : void
    {
        $params = $this->http->request()->getQueryParams();
        $usr_id = $_POST['usr_id'];
        $position_id = $params['position_id'];
 
        $ua = ilOrgUnitUserAssignmentQueries::getInstance()->getAssignmentOrFail(
            $usr_id,
            $position_id,
            $this->getParentRefId()
        );
        $ua->delete();
        $this->main_tpl->setOnScreenMessage('success', $this->language->txt('remove_successful'), true);
        $this->cancel();
    }

References $params, cancel(), ilOrgUnitUserAssignmentQueries\getInstance(), ILIAS\Modules\OrgUnit\ARHelper\BaseCommands\getParentRefId(), ILIAS\FileDelivery\http(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

◆ deleteRecursive()

ilOrgUnitUserAssignmentGUI::deleteRecursive ( )

protected

Definition at line 188 of file class.ilOrgUnitUserAssignmentGUI.php.

    {
        $r = $this->http->request();
        $assignments = ilOrgUnitUserAssignmentQueries::getInstance()
            ->getAssignmentsOfUserIdAndPosition((int) $_POST['usr_id'], (int) $r->getQueryParams()['position_id'])
        ;
 
        foreach ($assignments as $assignment) {
            $assignment->delete();
        }
        $this->main_tpl->setOnScreenMessage('success', $this->language->txt('remove_successful'), true);
        $this->cancel();
    }

References cancel(), ilOrgUnitUserAssignmentQueries\getInstance(), ILIAS\FileDelivery\http(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

◆ executeCommand()

ilOrgUnitUserAssignmentGUI::executeCommand ( )

Exceptions

ilCtrlException

Reimplemented from ILIAS\Modules\OrgUnit\ARHelper\BaseCommands.

Definition at line 56 of file class.ilOrgUnitUserAssignmentGUI.php.

                                    : void
    {
        if (!ilObjOrgUnitAccess::_checkAccessPositions((int) filter_input(
            INPUT_GET,
            "ref_id",
            FILTER_SANITIZE_NUMBER_INT
        ))) {
            $this->main_tpl->setOnScreenMessage('failure', $this->language->txt("permission_denied"), true);
            $this->ctrl->redirectByClass(ilObjOrgUnitGUI::class);
        }
 
        $r = $this->http->request();
        switch ($this->ctrl->getNextClass()) {
            case strtolower(ilRepositorySearchGUI::class):
                switch ($this->ctrl->getCmd()) {
                    case 'addUserFromAutoComplete':
                        if ($r->getQueryParams()['addusertype'] == "staff") {
                            $this->addStaff();
                        }
                        break;
                    default:
                        $repo = new ilRepositorySearchGUI();
                        $repo->setCallback($this, 'addStaffFromSearch');
                        $this->ctrl->forwardCommand($repo);
                        break;
                }
                break;
 
            default:
                parent::executeCommand();
                break;
        }
    }

References ilObjOrgUnitAccess\_checkAccessPositions(), addStaff(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

◆ getConfirmationGUI()

ilOrgUnitUserAssignmentGUI::getConfirmationGUI ( )

protected

Definition at line 152 of file class.ilOrgUnitUserAssignmentGUI.php.

                                           : ilConfirmationGUI
    {
        $this->ctrl->saveParameter($this, 'position_id');
        $confirmation = new ilConfirmationGUI();
        $confirmation->setFormAction($this->ctrl->getFormAction($this));
        $confirmation->setCancel($this->language->txt(self::CMD_CANCEL), self::CMD_CANCEL);
 
        $params = $this->http->request()->getQueryParams();
        $usr_id = $params['usr_id'];
        $position_id = $params['position_id'];
 
        $types = ilOrgUnitPosition::getArray('id', 'title');
        $position_title = $types[$position_id];
 
        $confirmation->setHeaderText(sprintf($this->language->txt('msg_confirm_remove_user'), $position_title));
        $confirmation->addItem('usr_id', $usr_id, ilObjUser::_lookupLogin($usr_id));
 
        return $confirmation;
    }

References $params, ilObjUser\_lookupLogin(), ILIAS\Repository\ctrl(), ActiveRecord\getArray(), ILIAS\FileDelivery\http(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by confirm(), and confirmRecursive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ index()

ilOrgUnitUserAssignmentGUI::index ( )

protected

Reimplemented from ILIAS\Modules\OrgUnit\ARHelper\BaseCommands.

Definition at line 90 of file class.ilOrgUnitUserAssignmentGUI.php.

                              : void
    {
        $this->addSubTabs();
        $this->activeSubTab(self::SUBTAB_ASSIGNMENTS);
 
        // Header
        $types = ilOrgUnitPosition::getArray('id', 'title');
        //$types = array();
        $this->ctrl->setParameterByClass(ilRepositorySearchGUI::class, 'addusertype', 'staff');
        ilRepositorySearchGUI::fillAutoCompleteToolbar($this, $this->toolbar, array(
            'auto_complete_name' => $this->language->txt('user'),
            'user_type' => $types,
            'submit_name' => $this->language->txt('add'),
        ));
 
        // Tables
        $html = '';
        foreach (ilOrgUnitPosition::getActiveForPosition($this->getParentRefId()) as $ilOrgUnitPosition) {
            $ilOrgUnitUserAssignmentTableGUI = new ilOrgUnitUserAssignmentTableGUI(
                $this,
                self::CMD_INDEX,
                $ilOrgUnitPosition
            );
            $html .= $ilOrgUnitUserAssignmentTableGUI->getHTML();
        }
        $this->setContent($html);
    }