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\components\OrgUnit\ARHelper\BaseCommands
	getParentGui ()

	setParentGui (BaseCommands $parent_gui)

	executeCommand ()

	addSubTabs ()

Data Fields
const	SUBTAB_ASSIGNMENTS = 'user_assignments'

const	SUBTAB_ASSIGNMENTS_RECURSIVE = 'user_assignments_recursive'

const	CMD_ASSIGNMENTS_RECURSIVE = 'assignmentsRecursive'

const	CMD_REMOVE_CONFIRM = 'confirmRemove'

const	CMD_REMOVE = 'remove'

const	CMD_REMOVE_RECURSIVELY_CONFIRM = 'confirmRemoveRecursively'

const	CMD_REMOVE_RECURSIVE = "removeRecursive"

const	CMD_SHOW_LP = 'showLearningProgress'

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

const	CMD_DEFAULT_PERMISSIONS = "defaultPermissions"

const	CMD_ADD = "add"

const	CMD_CREATE = "create"

const	CMD_EDIT = "edit"

const	CMD_UPDATE = "update"

const	CMD_CONFIRM = "confirm"

const	CMD_DELETE = "delete"

const	CMD_CANCEL = "cancel"

const	AR_ID = "arid"

Protected Member Functions
	index ()

	assignmentsRecursive ()

	confirmRemove (bool $recursive=false)

	confirmRemoveRecursively ()

	remove ()

	removeRecursive ()

	showLearningProgress ()

	getStaffTable (ilOrgUnitPosition $position, array $orgu_ids, bool $recursive=false)

	getPositionAndUserIdFromTableQuery ()

	cancel ()

Protected Member Functions inherited from ILIAS\components\OrgUnit\ARHelper\BaseCommands
	__construct (protected array $query_namespace=['orgu', 'posedit'])

	index ()

	getPossibleNextClasses ()

	getActiveTabId ()

	cancel ()

	setContent (string $html)

	pushSubTab (string $subtab_id, string $url)

	activeSubTab (string $subtab_id)

	getParentRefId ()

	getRowIdFromQuery ()

Private Attributes
ilToolbarGUI	$toolbar

ilOrgUnitPositionDBRepository	$positionRepo

ilOrgUnitUserAssignmentDBRepository	$assignmentRepo

Additional Inherited Members
Protected Attributes inherited from ILIAS\components\OrgUnit\ARHelper\BaseCommands
ilLanguage	$lng

ilCtrl	$ctrl

ilAccess	$access

ILIAS HTTP Services	$http

ilGlobalTemplateInterface	$tpl

BaseCommands	$parent_gui = null

URLBuilder	$url_builder

URLBuilderToken	$action_token = null

URLBuilderToken	$row_id_token

DataFactory	$data_factory

Refinery	$refinery

ServerRequestInterface	$request

ILIAS HTTP Wrapper ArrayBasedRequestWrapper	$query

UIFactory	$ui_factory

UIRenderer	$ui_renderer

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 ilOrgUnitUserAssignmentGUI: ilRepositorySearchGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilOrgUnitUserAssignmentGUI::__construct ( )

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

References $DIC, $dic, ILIAS\GlobalScreen\Provider\__construct(), ilOrgUnitLocalDIC\dic(), and ILIAS\Repository\toolbar().

     {
         parent::__construct(['orgu', 'staff']);
 
         global $DIC;
         $this->toolbar = $DIC->toolbar();
 
         $dic = \ilOrgUnitLocalDIC::dic();
         $this->positionRepo = $dic["repo.Positions"];
         $this->assignmentRepo = $dic["repo.UserAssignments"];
     }

Here is the call graph for this function:

Member Function Documentation

◆ addStaff()

ilOrgUnitUserAssignmentGUI::addStaff ( )

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

References $user_id, ilObjUser\_lookupId(), ILIAS\Repository\access(), ilOrgUnitPosition\CORE_POSITION_EMPLOYEE, ILIAS\Repository\ctrl(), ILIAS\components\OrgUnit\ARHelper\BaseCommands\getParentRefId(), ILIAS\Repository\int(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                               : void
     {
         if (!$this->access->checkAccess("write", "", $this->getParentRefId())) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->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->tpl->setOnScreenMessage('failure', $this->lng->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 === 0 || !$this->positionRepo->getSingle($position_id, 'id')) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("user_not_found"), true);
             $this->ctrl->redirect($this, self::CMD_INDEX);
         }
         foreach ($user_ids as $user_id) {
             $assignment = $this->assignmentRepo->get($user_id, $position_id, $this->getParentRefId());
         }
 
         $this->tpl->setOnScreenMessage('success', $this->lng->txt("users_successfuly_added"), true);
         $this->ctrl->redirect($this, self::CMD_INDEX);
     }

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 351 of file class.ilOrgUnitUserAssignmentGUI.php.

References $user_id, ILIAS\Repository\access(), ilOrgUnitPosition\CORE_POSITION_EMPLOYEE, ILIAS\Repository\ctrl(), ILIAS\components\OrgUnit\ARHelper\BaseCommands\getParentRefId(), ILIAS\Repository\int(), and ILIAS\Repository\lng().

                                                                                   : void
     {
         if (!$this->access->checkAccess("write", "", $this->getParentRefId())) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("permission_denied"), true);
             $this->ctrl->redirect($this, self::CMD_INDEX);
         }
 
         if (!count($user_ids)) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("user_not_found"), true);
             $this->ctrl->redirect($this, self::CMD_INDEX);
         }
 
         $position_id = (int) ($user_type ?? ilOrgUnitPosition::CORE_POSITION_EMPLOYEE);
 
         if ($position_id === 0 || !$this->positionRepo->getSingle($position_id, 'id')) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("user_not_found"), true);
             $this->ctrl->redirect($this, self::CMD_INDEX);
         }
         foreach ($user_ids as $user_id) {
             $assignment = $this->assignmentRepo->get($user_id, $position_id, $this->getParentRefId());
         }
 
         $this->tpl->setOnScreenMessage('success', $this->lng->txt("users_successfuly_added"), true);
         $this->ctrl->redirect($this, self::CMD_INDEX);
     }

Here is the call graph for this function:

◆ addSubTabs()

ilOrgUnitUserAssignmentGUI::addSubTabs ( )

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

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

Referenced by assignmentsRecursive(), and index().

                                 : 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
                                                                    ));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assignmentsRecursive()

ilOrgUnitUserAssignmentGUI::assignmentsRecursive ( )

protected

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

References $ref_id, ilObjOrgUnitAccess\_checkAccessStaff(), ilObjOrgUnitAccess\_checkAccessStaffRec(), ilObjOrgUnitTree\_getInstance(), ILIAS\components\OrgUnit\ARHelper\BaseCommands\activeSubTab(), addSubTabs(), ILIAS\components\OrgUnit\ARHelper\BaseCommands\getParentRefId(), ilObjOrgUnit\getRootOrgRefId(), getStaffTable(), ILIAS\Repository\int(), and ILIAS\components\OrgUnit\ARHelper\BaseCommands\setContent().

Referenced by removeRecursive().

                                              : void
     {
         $this->addSubTabs();
         $this->activeSubTab(self::SUBTAB_ASSIGNMENTS_RECURSIVE);
 
         $orgu_ref_id = $this->getParentRefId();
         $orgu_tree = ilObjOrgUnitTree::_getInstance();
         $permission_access_staff_recursive = [];
         // maybe any parent gives us recursive permission
         (int) $root = (int) ilObjOrgUnit::getRootOrgRefId();
         $parent = (int) $orgu_tree->getParent($orgu_ref_id);
 
         while ($parent !== $root) {
             if (ilObjOrgUnitAccess::_checkAccessStaffRec($parent)) {
                 array_merge(
                     $permission_access_staff_recursive = $permission_access_staff_recursive,
                     $orgu_tree->getAllChildren($parent)
                 );
             }
             $parent = (int) $orgu_tree->getParent($parent);
         }
 
         foreach ($orgu_tree->getAllChildren($orgu_ref_id) as $ref_id) {
             $recursive = in_array($ref_id, $permission_access_staff_recursive);
             if (!$recursive) {
                 // ok, so no permission from above, lets check local permissions
                 if (true || ilObjOrgUnitAccess::_checkAccessStaffRec($ref_id)) {
                     // update recursive permissions
                     $permission_access_staff_recursive = array_merge(
                         $permission_access_staff_recursive,
                         $orgu_tree->getAllChildren($ref_id)
                     );
                 } elseif (!ilObjOrgUnitAccess::_checkAccessStaff($ref_id)) {
                     // skip orgus in which one may not view the staff
                     continue;
                 }
             }
         }
 
         $tables = [];
         foreach ($this->positionRepo->getPositionsForOrgUnit($this->getParentRefId()) as $ilOrgUnitPosition) {
             $tables[] = $this->getStaffTable($ilOrgUnitPosition, $permission_access_staff_recursive, true);
         }
         $this->setContent($this->ui_renderer->render($tables));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cancel()

ilOrgUnitUserAssignmentGUI::cancel ( )

protected

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

References ILIAS\Repository\ctrl().

Referenced by remove().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmRemove()

ilOrgUnitUserAssignmentGUI::confirmRemove ( bool $recursive = false )

protected

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

References $id, ilObjUser\_lookupLogin(), exit, getPositionAndUserIdFromTableQuery(), and ILIAS\Repository\lng().

Referenced by confirmRemoveRecursively().

                                                              : void
     {
         list($position_id, $usr_id) = $this->getPositionAndUserIdFromTableQuery();
 
         $id = implode('_', [(string) $position_id, (string) $usr_id]);
         $usr_name = ilObjUser::_lookupLogin($usr_id);
         $pos_name = $this->positionRepo->getSingle($position_id, 'id')->getTitle();
 
         $item = $this->ui_factory->modal()->interruptiveItem()
             ->keyValue($id, $usr_name, $pos_name);
 
         $del_command = $recursive ? self::CMD_REMOVE_RECURSIVE : self::CMD_REMOVE;
         $action = $this->url_builder
             ->withParameter($this->row_id_token, $id)
             ->withParameter($this->action_token, $del_command)
             ->buildURI()->__toString();
 
         echo($this->ui_renderer->renderAsync([
             $this->ui_factory->modal()->interruptive(
                 $this->lng->txt('remove_user'),
                 sprintf($this->lng->txt('msg_confirm_remove_user'), $pos_name),
                 $action
             )->withAffectedItems([$item])
         ]));
         exit();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmRemoveRecursively()

ilOrgUnitUserAssignmentGUI::confirmRemoveRecursively ( )

protected

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

References confirmRemove().

                                                  : void
     {
         $this->confirmRemove(true);
     }

Here is the call graph for this function:

◆ executeCommand()

ilOrgUnitUserAssignmentGUI::executeCommand ( )

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

References $r, ilObjOrgUnitAccess\_checkAccessPositions(), ilObjOrgUnitAccess\_checkAccessStaff(), addStaff(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

                                     : void
     {
         if (
             !ilObjOrgUnitAccess::_checkAccessPositions(
                 (int) filter_input(INPUT_GET, "ref_id", FILTER_SANITIZE_NUMBER_INT)
             )
             &&
             !ilObjOrgUnitAccess::_checkAccessStaff(
                 (int) filter_input(INPUT_GET, "ref_id", FILTER_SANITIZE_NUMBER_INT)
             )
         ) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->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;
         }
     }

Here is the call graph for this function:

◆ getPositionAndUserIdFromTableQuery()

ilOrgUnitUserAssignmentGUI::getPositionAndUserIdFromTableQuery ( )

protected

Returns: array<int, int> position_id, user_id

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

References $id, and ILIAS\Repository\refinery().

Referenced by confirmRemove(), remove(), removeRecursive(), and showLearningProgress().

                                                            : array
     {
         if ($this->query->has($this->row_id_token->getName())) {
             return $this->query->retrieve(
                 $this->row_id_token->getName(),
                 $this->refinery->custom()->transformation(
                     function ($v) {
                         $id = is_array($v) ? array_shift($v) : $v;
                         return array_map('intval', explode('_', $id));
                     }
                 )
             );
         }
         throw new \Exception('no position/user id in query');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStaffTable()

ilOrgUnitUserAssignmentGUI::getStaffTable	(	ilOrgUnitPosition	$position,
		array	$orgu_ids,
		bool	$recursive = `false`
	)

protected

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

References $id, ILIAS\components\OrgUnit\ARHelper\BaseCommands\$row_id_token, ILIAS\Repository\access(), ilOrgUnitPosition\getId(), ILIAS\components\OrgUnit\ARHelper\BaseCommands\getParentRefId(), ilOrgUnitPosition\getTitle(), and ILIAS\Repository\lng().

Referenced by assignmentsRecursive(), and index().

      : Table\Data {
         $columns = [
             'login' => $this->ui_factory->table()->column()->text($this->lng->txt("login")),
             'firstname' => $this->ui_factory->table()->column()->text($this->lng->txt("firstname")),
             'lastname' => $this->ui_factory->table()->column()->text($this->lng->txt("lastname")),
             'active' => $this->ui_factory->table()->column()->boolean(
                 $this->lng->txt("active"),
                 $this->ui_factory->symbol()->icon()->custom('assets/images/standard/icon_ok.svg', '', 'small'),
                 $this->ui_factory->symbol()->icon()->custom('assets/images/standard/icon_not_ok.svg', '', 'small')
             )->withIsOptional(true, false),
         ];
 
         $remove_cmd = self::CMD_REMOVE_CONFIRM;
         if ($recursive) {
             $remove_cmd = self::CMD_REMOVE_RECURSIVELY_CONFIRM;
             $columns['orgu_title'] = $this->ui_factory->table()->column()->text($this->lng->txt("obj_orgu"));
         }
 
         $actions = [
             'remove' => $this->ui_factory->table()->action()->single(
                 $this->lng->txt('remove'),
                 $this->url_builder->withParameter($this->action_token, $remove_cmd),
                 $this->row_id_token
             )->withAsync(),
 
             'show_learning_progress' => $this->ui_factory->table()->action()->single(
                 $this->lng->txt('show_learning_progress'),
                 $this->url_builder->withParameter($this->action_token, self::CMD_SHOW_LP),
                 $this->row_id_token
             ),
         ];
 
         $lp_visible = array_filter(
             $orgu_ids,
             fn($id) => $this->access->checkAccess("view_learning_progress", "", $id)
         );
 
         return $this->ui_factory->table()
             ->data($this->assignmentRepo, $position->getTitle(), $columns)
             ->withId(implode('.', ['orgustaff',$this->getParentRefId(),$position->getId()]))
             ->withActions($actions)
             ->withAdditionalParameters([
                 'position_id' => $position->getId(),
                 'orgu_ids' => $orgu_ids,
                 'lp_visible_ref_ids' => $lp_visible,
                 'write_access' => $this->access->checkAccess("write", "", $this->getParentRefId())
             ])
             ->withRequest($this->request);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ index()

ilOrgUnitUserAssignmentGUI::index ( )

protected

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

References ILIAS\Repository\access(), ILIAS\components\OrgUnit\ARHelper\BaseCommands\activeSubTab(), addSubTabs(), ILIAS\Repository\ctrl(), ilRepositorySearchGUI\fillAutoCompleteToolbar(), ILIAS\components\OrgUnit\ARHelper\BaseCommands\getParentRefId(), getStaffTable(), ILIAS\Repository\lng(), ILIAS\components\OrgUnit\ARHelper\BaseCommands\setContent(), and ILIAS\Repository\toolbar().

                               : void
     {
         $this->addSubTabs();
         $this->activeSubTab(self::SUBTAB_ASSIGNMENTS);
 
         $types = $this->positionRepo->getArray('id', 'title');
         $this->ctrl->setParameterByClass(ilRepositorySearchGUI::class, 'addusertype', 'staff');
 
         if ($this->access->checkAccess("write", "", $this->getParentRefId())) {
             ilRepositorySearchGUI::fillAutoCompleteToolbar($this, $this->toolbar, array(
                 'auto_complete_name' => $this->lng->txt('user'),
                 'user_type' => $types,
                 'submit_name' => $this->lng->txt('add'),
             ));
         }
 
         $tables = [];
         foreach ($this->positionRepo->getPositionsForOrgUnit($this->getParentRefId()) as $ilOrgUnitPosition) {
             $tables[] = $this->getStaffTable($ilOrgUnitPosition, [$this->getParentRefId()], false);
         }
         $this->setContent($this->ui_renderer->render($tables));
     }

Here is the call graph for this function:

◆ remove()

ilOrgUnitUserAssignmentGUI::remove ( )

protected

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

References cancel(), ILIAS\Repository\ctrl(), ILIAS\components\OrgUnit\ARHelper\BaseCommands\getParentRefId(), getPositionAndUserIdFromTableQuery(), and ILIAS\Repository\lng().

                                : void
     {
         list($position_id, $usr_id) = $this->getPositionAndUserIdFromTableQuery();
 
         $assignment = $this->assignmentRepo->find(
             $usr_id,
             $position_id,
             $this->getParentRefId()
         );
         if (!$assignment) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("user_not_found_to_delete"), true);
             $this->ctrl->redirect($this, self::CMD_INDEX);
         }
         $this->assignmentRepo->delete($assignment);
 
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('remove_successful'), true);
         $this->cancel();
     }

Here is the call graph for this function:

◆ removeRecursive()

ilOrgUnitUserAssignmentGUI::removeRecursive ( )

protected

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

References assignmentsRecursive(), getPositionAndUserIdFromTableQuery(), and ILIAS\Repository\lng().

                                         : void
     {
         list($position_id, $usr_id) = $this->getPositionAndUserIdFromTableQuery();
         $assignments = $this->assignmentRepo->getByUserAndPosition($usr_id, $position_id);
         foreach ($assignments as $assignment) {
             $this->assignmentRepo->delete($assignment);
         }
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('remove_successful'), true);
         $this->assignmentsRecursive();
     }

Here is the call graph for this function:

◆ showLearningProgress()

ilOrgUnitUserAssignmentGUI::showLearningProgress ( )

protected

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

References ILIAS\Repository\ctrl(), and getPositionAndUserIdFromTableQuery().

                                              : void
     {
         list($position_id, $usr_id) = $this->getPositionAndUserIdFromTableQuery();
         $this->ctrl->setParameterByClass(ilLearningProgressGUI::class, 'obj_id', $usr_id);
         $target = $this->ctrl->getLinkTargetByClass(ilLearningProgressGUI::class, "");
         $this->ctrl->redirectToURL($target);
     }