Class ilObjStudyProgrammeAutoMembershipsGUI. More...

Collaboration diagram for ilObjStudyProgrammeAutoMembershipsGUI:

Public Member Functions
	__construct (public ilGlobalTemplateInterface $tpl, public ilCtrl $ctrl, public ilToolbarGUI $toolbar, public ilLanguage $lng, public Factory $ui_factory, protected MessageBox\Factory $message_box_factory, protected Button\Factory $button_factory, protected Renderer $ui_renderer, protected Psr\Http\Message\ServerRequestInterface $request, protected ilTree $tree, protected ILIAS\HTTP\Wrapper\RequestWrapper $request_wrapper, protected ILIAS\Refinery\Factory $refinery, protected ilRbacReview $rbac_review)

	executeCommand ()

	setRefId (int $prg_ref_id)
	Set ref-id of StudyProgramme before using this GUI. More...

	setParentGUI (ilContainerGUI $a_parent_gui)
	Set this GUI's parent gui. More...

Data Fields
const	CHECKBOX_SOURCE_IDS = 'c_amsids'

ilObjStudyProgramme	$object = null

int	$prg_ref_id

Protected Member Functions
	nextStep ()

	view (bool $profile_not_public=false)
	Render. More...

	save ()

	deleteConfirmation ()

	delete ()

	enable ()
	Enable single entry. More...

	disable ()
	Disable single entry. More...

	getObject ()
	Get current StudyProgramme-object. More...

	getModal (string $source_type=null, int $source_id=null)

	getAsynchModalOutput ()

	getForm (string $source_type=null, ?string $source_id='')

	getSelectionForm (string $selected_source_type, string $selected_source, string $source_type=null, string $source_id=null)

	parseQueryString (string $string)

	getToolbar (Signal $add_cat_signal)
	Setup toolbar. More...

	getItemAction (string $src_id, Signal $signal, bool $is_enabled)

	getUserRepresentation (int $usr_id)

	getTitleRepresentation (ilStudyProgrammeAutoMembershipSource $ams)

	txt (string $code)

Protected Attributes
ilContainerGUI	$parent_gui

Private Attributes
const	ROLEFOLDER_REF_ID = 8

const	F_SOURCE_TYPE = 'f_st'

const	F_SOURCE_ID = 'f_sid'

const	F_ORIGINAL_SOURCE_TYPE = 'f_st_org'

const	F_ORIGINAL_SOURCE_ID = 'f_sid_org'

const	CMD_VIEW = 'view'

const	CMD_SAVE = 'save'

const	CMD_DELETE = 'delete'

const	CMD_DELETE_CONFIRMATION = 'deleteConfirmation'

const	CMD_GET_ASYNC_MODAL_OUTPUT = 'getAsynchModalOutput'

const	CMD_NEXT_STEP = 'nextStep'

const	CMD_ENABLE = 'enable'

const	CMD_DISABLE = 'disable'

const	CMD_PROFILE_NOT_PUBLIC = 'profile_not_public'

Static Private Attributes
static array	$switch_to_ref_id

Detailed Description

Class ilObjStudyProgrammeAutoMembershipsGUI.

Author: : Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

ilObjStudyProgrammeAutoMembershipsGUI: ilPropertyFormGUI, ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjStudyProgrammeAutoMembershipsGUI::__construct	(	public ilGlobalTemplateInterface	$tpl,
		public ilCtrl	$ctrl,
		public ilToolbarGUI	$toolbar,
		public ilLanguage	$lng,
		public Factory	$ui_factory,
		protected MessageBox\Factory	$message_box_factory,
		protected Button\Factory	$button_factory,
		protected Renderer	$ui_renderer,
		protected Psr\Http\Message\ServerRequestInterface	$request,
		protected ilTree	$tree,
		protected ILIAS\HTTP\Wrapper\RequestWrapper	$request_wrapper,
		protected ILIAS\Refinery\Factory	$refinery,
		protected ilRbacReview	$rbac_review
	)

Definition at line 66 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

References ilGlobalTemplateInterface\addJavaScript().

       {
         // Add this js manually here because the modal contains a form that is
         // loaded asynchronously later on, and this JS won't be pulled then for
         // some reason.
         $tpl->addJavaScript("Services/Form/js/Form.js");
     }

Here is the call graph for this function:

Member Function Documentation

◆ delete()

ilObjStudyProgrammeAutoMembershipsGUI::delete ( )

protected

Definition at line 276 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

References $id, ILIAS\Repository\ctrl(), getObject(), and ILIAS\Repository\lng().

                                : void
     {
         $field = self::CHECKBOX_SOURCE_IDS;
         $get = $this->request->getQueryParams();
 
         if (!array_key_exists($field, $get)) {
             $this->tpl->setOnScreenMessage("failure", $this->lng->txt('prg_delete_failure'), true);
             $this->ctrl->redirect($this, self::CMD_VIEW);
         }
 
         $type_ids = base64_decode($get[$field]);
         $type_ids = explode(' ', trim($type_ids));
 
         foreach ($type_ids as $src_id) {
             [$type, $id] = explode('-', $src_id);
             $this->getObject()->deleteAutomaticMembershipSource((string) $type, (int) $id);
         }
 
         $msg = $this->lng->txt('prg_delete_single_success');
         if (count($type_ids) > 1) {
             $msg = $this->lng->txt('prg_delete_success');
         }
 
         $this->tpl->setOnScreenMessage("success", $msg, true);
         $this->ctrl->redirect($this, self::CMD_VIEW);
     }

Here is the call graph for this function:

◆ deleteConfirmation()

ilObjStudyProgrammeAutoMembershipsGUI::deleteConfirmation ( )

protected

Definition at line 237 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

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

                                            : void
     {
         $get = $this->request->getQueryParams();
         $post = $this->request->getParsedBody();
         $field = self::CHECKBOX_SOURCE_IDS;
 
         $field_ids_in_get = array_key_exists($field, $get);
         $field_ids_in_post = array_key_exists($field, $post);
 
         $type_ids = '';
         $msg = '';
         if ($field_ids_in_get) {
             $type_ids = $get[$field];
             $msg = $this->lng->txt('prg_delete_single_confirmation');
         } elseif ($field_ids_in_post) {
             $type_ids = implode(' ', $post[$field]);
             $msg = $this->lng->txt('prg_delete_confirmation');
         } else {
             $this->tpl->setOnScreenMessage("info", $this->lng->txt('prg_delete_nothing_selected'), true);
             $this->ctrl->redirect($this, self::CMD_VIEW);
         }
 
         $type_ids = base64_encode($type_ids);
 
         $this->ctrl->setParameterByClass(self::class, $field, $type_ids);
         $delete = $this->ctrl->getFormActionByClass(self::class, self::CMD_DELETE);
         $cancel = $this->ctrl->getFormActionByClass(self::class, self::CMD_VIEW);
         $this->ctrl->clearParameterByClass(self::class, $field);
 
         $buttons = [
             $this->button_factory->standard($this->lng->txt('prg_confirm_delete'), $delete),
             $this->button_factory->standard($this->lng->txt('prg_cancel'), $cancel)
         ];
 
         $message_box = $this->message_box_factory->confirmation($msg)->withButtons($buttons);
 
         $this->tpl->setContent($this->ui_renderer->render($message_box));
     }

Here is the call graph for this function:

◆ disable()

ilObjStudyProgrammeAutoMembershipsGUI::disable ( )

protected

Disable single entry.

Definition at line 320 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

References $id, ILIAS\Repository\ctrl(), and getObject().

                                 : void
     {
         $get = $this->request->getQueryParams();
         $field = self::CHECKBOX_SOURCE_IDS;
         if (array_key_exists($field, $get)) {
             [$type, $id] = explode('-', $get[$field]);
             $this->getObject()->disableAutomaticMembershipSource((string) $type, (int) $id);
         }
         $this->ctrl->redirect($this, self::CMD_VIEW);
     }

Here is the call graph for this function:

◆ enable()

ilObjStudyProgrammeAutoMembershipsGUI::enable ( )

protected

Enable single entry.

Definition at line 306 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

References $id, ILIAS\Repository\ctrl(), and getObject().

                                : void
     {
         $get = $this->request->getQueryParams();
         $field = self::CHECKBOX_SOURCE_IDS;
         if (array_key_exists($field, $get)) {
             [$type, $id] = explode('-', $get[$field]);
             $this->getObject()->enableAutomaticMembershipSource((string) $type, (int) $id);
         }
         $this->ctrl->redirect($this, self::CMD_VIEW);
     }

Here is the call graph for this function:

◆ executeCommand()

ilObjStudyProgrammeAutoMembershipsGUI::executeCommand ( )

Definition at line 86 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

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

                                     : void
     {
         $cmd = $this->ctrl->getCmd();
         switch ($cmd) {
             case self::CMD_VIEW:
             case self::CMD_DELETE:
             case self::CMD_DELETE_CONFIRMATION:
             case self::CMD_DISABLE:
             case self::CMD_GET_ASYNC_MODAL_OUTPUT:
             case self::CMD_NEXT_STEP:
             case self::CMD_SAVE:
                 $this->$cmd();
                 break;
             case self::CMD_ENABLE:
                 $this->$cmd();
                 $this->ctrl->redirect($this, self::CMD_VIEW);
                 break;
             case self::CMD_PROFILE_NOT_PUBLIC:
                 $this->view(true);
                 break;
             default:
                 throw new ilException("ilObjStudyProgrammeAutoMembershipsGUI: Command not supported: $cmd");
         }
     }

Here is the call graph for this function:

◆ getAsynchModalOutput()

ilObjStudyProgrammeAutoMembershipsGUI::getAsynchModalOutput ( )

protected

Definition at line 375 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

References $id, ILIAS\Repository\ctrl(), exit, getForm(), ILIAS\Repository\refinery(), txt(), and ilStudyProgrammeAutoMembershipSource\TYPE_ORGU.

                                              : void
     {
         $current_src_type = null;
         if ($this->request_wrapper->has(self::F_ORIGINAL_SOURCE_TYPE)) {
             $current_src_type = $this->request_wrapper->retrieve(
                 self::F_ORIGINAL_SOURCE_TYPE,
                 $this->refinery->to()->string()
             );
         }
 
         $current_src_id = null;
         if ($this->request_wrapper->has(self::F_ORIGINAL_SOURCE_ID)) {
             $current_src_id = $this->request_wrapper->retrieve(self::F_ORIGINAL_SOURCE_ID, $this->refinery->to()->string());
         }
 
         $form = $this->getForm($current_src_type, $current_src_id);
         $form_id = "form_" . $form->getId();
 
         $modal = $this->ui_factory->modal()->roundtrip(
             $this->txt('modal_member_auto_select_title'),
             $this->ui_factory->legacy($form->getHtml())
         );
 
         $this->ctrl->setParameter($this, self::F_ORIGINAL_SOURCE_TYPE, $current_src_type);
         $this->ctrl->setParameter($this, self::F_ORIGINAL_SOURCE_ID, $current_src_id);
         $link = $this->ctrl->getLinkTarget($this, "nextStep", "", true);
         $this->ctrl->setParameter($this, self::F_ORIGINAL_SOURCE_TYPE, null);
         $this->ctrl->setParameter($this, self::F_ORIGINAL_SOURCE_ID, null);
 
         $replaceSignal = $modal->getReplaceSignal();
         $signal_id = $replaceSignal->getId();
         $f_selected_type = self::F_SOURCE_TYPE;
         $f_selected_id = self::F_SOURCE_ID;
         $submit = $this->ui_factory->button()->primary($this->txt('search'), "#")
         ->withOnLoadCode(
             function ($id) use ($form_id, $link, $signal_id, $f_selected_type, $f_selected_id) {
                 return
                     "$('#$id').click(function() { 
 
                         var checked = $(\"input[name='$f_selected_type']:checked\"). val();
                         if(checked == 'orgu' || typeof(checked) == \"undefined\") {
                             console.log('$(\'#$form_id\').submit()');
                             document.getElementById('$form_id').submit();
                             return false;
                         }
 
                         var i_value = $(\"input[name='$f_selected_id\" + checked + \"']\"). val();
                         if(i_value == '' || typeof(i_value) == \"undefined\") {
                             document.getElementById('$form_id').submit();
                             return false;
                         }
 
                         n_url = '$link' + '&$f_selected_type=' + checked + '&$f_selected_id=' + i_value;
                         $('#$id').attr(\"onclick\", function(event) {
                             $(this).trigger('$signal_id',
                                 {
                                     'id' : '$signal_id', 'event' : 'click',
                                     'triggerer' : $(this),
                                     'options' : JSON.parse('{\"url\":\"' + n_url + '\"}')
                                 }
                             );
                         });
                         return false;
                     }
                 );";
             }
         );
 
         $modal = $modal->withActionButtons([$submit])
             ->withAdditionalOnLoadCode(
                 function ($id) use ($form) {
                     $selector_post_var = self::F_SOURCE_ID . ilStudyProgrammeAutoMembershipSource::TYPE_ORGU;
                     $js = $form->getItemByPostVar($selector_post_var)->getOnloadCode();
                     return implode(';', $js);
                 }
             );
 
         echo $this->ui_renderer->renderAsync($modal);
         exit;
     }

Here is the call graph for this function:

◆ getForm()

ilObjStudyProgrammeAutoMembershipsGUI::getForm	(	string	$source_type = `null`,
		?string	$source_id = `''`
	)

protected

Definition at line 456 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

References ILIAS\Repository\ctrl(), ilObjOrgUnit\getRootOrgRefId(), txt(), ilStudyProgrammeAutoMembershipSource\TYPE_COURSE, ilStudyProgrammeAutoMembershipSource\TYPE_GROUP, ilStudyProgrammeAutoMembershipSource\TYPE_ORGU, and ilStudyProgrammeAutoMembershipSource\TYPE_ROLE.

Referenced by getAsynchModalOutput(), and save().

                                                                                    : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
 
         if (is_null($source_type)) {
             $source_type = "";
         }
 
         $form->setId(uniqid($source_type . $source_id, true));
         $form->setFormAction($this->ctrl->getFormAction($this, 'save'));
 
         $rgroup = new ilRadioGroupInputGUI($this->txt('membership_source_type'), self::F_SOURCE_TYPE);
         $rgroup->setValue($source_type);
         $form->addItem($rgroup);
 
         $radio_role = new ilRadioOption(
             $this->txt('select_' . ilStudyProgrammeAutoMembershipSource::TYPE_ROLE),
             ilStudyProgrammeAutoMembershipSource::TYPE_ROLE
         );
 
         $ni_role = new ilTextInputGUI(
             $this->txt('label_' . ilStudyProgrammeAutoMembershipSource::TYPE_ROLE),
             self::F_SOURCE_ID . ilStudyProgrammeAutoMembershipSource::TYPE_ROLE
         );
         $radio_role->addSubItem($ni_role);
         $rgroup->addOption($radio_role);
 
         $radio_grp = new ilRadioOption(
             $this->txt('select_' . ilStudyProgrammeAutoMembershipSource::TYPE_GROUP),
             ilStudyProgrammeAutoMembershipSource::TYPE_GROUP
         );
         $ni_grp = new ilTextInputGUI(
             $this->txt('label_' . ilStudyProgrammeAutoMembershipSource::TYPE_GROUP),
             self::F_SOURCE_ID . ilStudyProgrammeAutoMembershipSource::TYPE_GROUP
         );
         $radio_grp->addSubItem($ni_grp);
         $rgroup->addOption($radio_grp);
 
         $radio_crs = new ilRadioOption(
             $this->txt('select_' . ilStudyProgrammeAutoMembershipSource::TYPE_COURSE),
             ilStudyProgrammeAutoMembershipSource::TYPE_COURSE
         );
         $ni_crs = new ilTextInputGUI(
             $this->txt('label_' . ilStudyProgrammeAutoMembershipSource::TYPE_COURSE),
             self::F_SOURCE_ID . ilStudyProgrammeAutoMembershipSource::TYPE_COURSE
         );
         $radio_crs->addSubItem($ni_crs);
         $rgroup->addOption($radio_crs);
 
         $radio_orgu = new ilRadioOption(
             $this->txt('select_' . ilStudyProgrammeAutoMembershipSource::TYPE_ORGU),
             ilStudyProgrammeAutoMembershipSource::TYPE_ORGU
         );
         $orgu = new ilRepositorySelector2InputGUI(
             "",
             self::F_SOURCE_ID . ilStudyProgrammeAutoMembershipSource::TYPE_ORGU,
             false,
             $this
         );
         $orgu->getExplorerGUI()->setSelectableTypes(["orgu"]);
         $orgu->getExplorerGUI()->setTypeWhiteList(["root", "orgu"]);
         $orgu->getExplorerGUI()->setRootId(ilObjOrgUnit::getRootOrgRefId());
         $orgu->getExplorerGUI()->setAjax(false);
         $radio_orgu->addSubItem($orgu);
         $rgroup->addOption($radio_orgu);
         if (
             !is_null($source_type) &&
             !is_null($source_id) &&
             $source_type !== "" &&
             $source_id !== ""
         ) {
             switch ($source_type) {
                 case ilStudyProgrammeAutoMembershipSource::TYPE_ROLE:
                     $ni_role->setValue($source_id);
                     break;
                 case ilStudyProgrammeAutoMembershipSource::TYPE_GROUP:
                     $ni_grp->setValue($source_id);
                     break;
                 case ilStudyProgrammeAutoMembershipSource::TYPE_COURSE:
                     $ni_crs->setValue($source_id);
                     break;
                 case ilStudyProgrammeAutoMembershipSource::TYPE_ORGU:
                     $orgu->setValue($source_id);
                     break;
                 default:
             }
         }
 
         $hi = new ilHiddenInputGUI(self::F_ORIGINAL_SOURCE_TYPE);
         $hi->setValue($source_type);
         $form->addItem($hi);
 
         $hi = new ilHiddenInputGUI(self::F_ORIGINAL_SOURCE_ID);
         $hi->setValue($source_id ?? '');
         $form->addItem($hi);
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItemAction()

ilObjStudyProgrammeAutoMembershipsGUI::getItemAction	(	string	$src_id,
		Signal	$signal,
		bool	$is_enabled
	)

protected

Definition at line 627 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

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

Referenced by view().

      : Dropdown\Standard {
         $items = [];
 
         $items[] = $this->ui_factory->button()->shy($this->txt('edit'), '')
             ->withOnClick($signal);
 
         $this->ctrl->setParameter($this, self::CHECKBOX_SOURCE_IDS, $src_id);
 
         if ($is_enabled) {
             $items[] = $this->ui_factory->button()->shy(
                 $this->txt('deactivate'),
                 $this->ctrl->getLinkTarget($this, self::CMD_DISABLE)
             );
         } else {
             $items[] = $this->ui_factory->button()->shy(
                 $this->txt('activate'),
                 $this->ctrl->getLinkTarget($this, self::CMD_ENABLE)
             );
         }
 
         $items[] = $this->ui_factory->button()->shy(
             $this->txt('delete'),
             $this->ctrl->getLinkTarget($this, self::CMD_DELETE_CONFIRMATION)
         );
 
         $this->ctrl->clearParameters($this);
 
         return $this->ui_factory->dropdown()->standard($items);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getModal()

ilObjStudyProgrammeAutoMembershipsGUI::getModal	(	string	$source_type = `null`,
		int	$source_id = `null`
	)

protected

Definition at line 360 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

References ILIAS\Repository\ctrl().

Referenced by view().

                                                                                   : RoundTrip
     {
         $this->ctrl->setParameter($this, self::F_ORIGINAL_SOURCE_TYPE, $source_type);
         $this->ctrl->setParameter($this, self::F_ORIGINAL_SOURCE_ID, $source_id);
         $link = $this->ctrl->getLinkTarget($this, "getAsynchModalOutput", "", true);
         $this->ctrl->setParameter($this, self::F_ORIGINAL_SOURCE_TYPE, null);
         $this->ctrl->setParameter($this, self::F_ORIGINAL_SOURCE_ID, null);
 
         return $this->ui_factory->modal()->roundtrip(
             '',
             []
         )
         ->withAsyncRenderUrl($link);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObject()

ilObjStudyProgrammeAutoMembershipsGUI::getObject ( )

protected

Get current StudyProgramme-object.

Definition at line 350 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

References $object, $prg_ref_id, ilObjStudyProgramme\getInstanceByRefId(), and ILIAS\Repository\object().

Referenced by delete(), disable(), enable(), save(), and view().

                                   : ilObjStudyProgramme
     {
         if ($this->object === null ||
             $this->object->getRefId() !== $this->prg_ref_id
         ) {
             $this->object = ilObjStudyProgramme::getInstanceByRefId($this->prg_ref_id);
         }
         return $this->object;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSelectionForm()

ilObjStudyProgrammeAutoMembershipsGUI::getSelectionForm	(	string	$selected_source_type,
		string	$selected_source,
		string	$source_type = `null`,
		string	$source_id = `null`
	)

protected

Definition at line 555 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

References ilObject\_lookupDescription(), ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), ILIAS\Repository\int(), parseQueryString(), and txt().

Referenced by nextStep().

      : ilPropertyFormGUI {
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this, "save"));
 
         $query_parser = $this->parseQueryString($selected_source);
         $object_search = new ilLikeObjectSearch($query_parser);
         $object_search->setFilter(array($selected_source_type));
         $entries = $object_search->performSearch()->getEntries();
 
         $rgoup = new ilRadioGroupInputGUI(
             $this->txt("prg_auto_member_select_" . $selected_source_type),
             self::F_SOURCE_ID . $selected_source_type
         );
         $form->addItem($rgoup);
         foreach ($entries as $entry) {
             $obj_id = (int) $entry['obj_id'];
             $title = ilObject::_lookupTitle($obj_id);
             $description = ilObject::_lookupDescription($obj_id);
 
             $option = new ilRadioOption($title, (string) $obj_id, $description);
             $rgoup->addOption($option);
         }
 
         $hi = new ilHiddenInputGUI(self::F_ORIGINAL_SOURCE_TYPE);
         $hi->setValue($source_type ?? '');
         $form->addItem($hi);
 
         $hi = new ilHiddenInputGUI(self::F_ORIGINAL_SOURCE_ID);
         $hi->setValue((string) $source_id);
         $form->addItem($hi);
 
         $hi = new ilHiddenInputGUI(self::F_SOURCE_TYPE);
         $hi->setValue($selected_source_type);
         $form->addItem($hi);
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitleRepresentation()

ilObjStudyProgrammeAutoMembershipsGUI::getTitleRepresentation ( ilStudyProgrammeAutoMembershipSource $ams )

protected

Definition at line 687 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

References Vendor\Package\$c, $path, $url, ilLink\_getStaticLink(), ilObject\_lookupTitle(), ilObject\_lookupType(), ILIAS\Repository\ctrl(), ilStudyProgrammeAutoMembershipSource\getSourceId(), ilStudyProgrammeAutoMembershipSource\getSourceType(), ilStudyProgrammeAutoMembershipSource\TYPE_COURSE, ilStudyProgrammeAutoMembershipSource\TYPE_GROUP, ilStudyProgrammeAutoMembershipSource\TYPE_ORGU, and ilStudyProgrammeAutoMembershipSource\TYPE_ROLE.

Referenced by view().

      : Link\Standard {
         $src_id = $ams->getSourceId();
 
         switch ($ams->getSourceType()) {
             case ilStudyProgrammeAutoMembershipSource::TYPE_ROLE:
                 $title = ilObjRole::_lookupTitle($src_id) ?? "-";
 
                 if($this->rbac_review->isGlobalRole($src_id)) {
                     $parent_ref = self::ROLEFOLDER_REF_ID;
                     $path = ['ilAdministrationGUI'];
                     $this->ctrl->setParameterByClass('ilObjRoleGUI', 'admin_mode', 'settings');
                 } else {
                     $parent_ref = $this->rbac_review->getObjectReferenceOfRole($src_id);
                     $parent_type = ilObject::_lookupType($parent_ref, true);
                     $path = ['ilRepositoryGUI','ilObjCategoryGUI'];
                     if($parent_type == 'orgu') {
                         $path = ['ilAdministrationGUI','ilObjOrgUnitGUI'];
                     }
                     $path[] = 'ilPermissionGUI';
                 }
                 $path[] = 'ilObjRoleGUI';
                 $this->ctrl->setParameterByClass('ilObjRoleGUI', 'ref_id', $parent_ref);
                 $this->ctrl->setParameterByClass('ilObjRoleGUI', 'obj_id', $src_id);
                 $url = $this->ctrl->getLinkTargetByClass($path, 'userassignment');
                 $this->ctrl->clearParametersByClass('ilObjRoleGUI');
                 break;
 
             case ilStudyProgrammeAutoMembershipSource::TYPE_COURSE:
                 $url = ilLink::_getStaticLink($src_id, 'crs');
                 // no break
             case ilStudyProgrammeAutoMembershipSource::TYPE_GROUP:
                 $url = ilLink::_getStaticLink($src_id, 'grp');
                 $hops = array_map(
                     static function (array $c): string {
                         return ilObject::_lookupTitle((int) $c["obj_id"]);
                     },
                     $this->tree->getPathFull($src_id)
                 );
                 $hops = array_slice($hops, 1);
                 $title = implode(' > ', $hops) ?? "-";
                 break;
 
             case ilStudyProgrammeAutoMembershipSource::TYPE_ORGU:
                 $hops = array_map(
                     static function (array $c): string {
                         return ilObject::_lookupTitle((int)$c["obj_id"]);
                     },
                     $this->tree->getPathFull($src_id)
                 );
                 $hops = array_slice($hops, 3);
                 $title = implode(' > ', $hops) ?? "-";
                 $url = ilLink::_getStaticLink($src_id, $ams->getSourceType());
                 break;
             default:
                 throw new LogicException("This should not happen. Forgot a case in the switch?");
         }
 
         return $this->ui_factory->link()->standard($title, $url);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getToolbar()

ilObjStudyProgrammeAutoMembershipsGUI::getToolbar ( Signal $add_cat_signal )

protected

Setup toolbar.

Definition at line 618 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

References ILIAS\Repository\toolbar(), and txt().

Referenced by view().

                                                          : void
     {
         $btn = $this->ui_factory->button()->primary($this->txt('add_automembership_source'), '')
             ->withOnClick($add_cat_signal);
         $this->toolbar->addComponent($btn);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserRepresentation()

ilObjStudyProgrammeAutoMembershipsGUI::getUserRepresentation ( int $usr_id )

protected

Definition at line 661 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

References $url, ilObjUser\_lookupName(), ILIAS\Repository\ctrl(), and ilObjectFactory\getInstanceByObjId().

Referenced by view().

                                                          : ?Link\Standard
     {
         $username = ilObjUser::_lookupName($usr_id);
         if(array_filter($username) === []) {
             return null;
         }
 
         $editor = implode(' ', [
             $username['firstname'],
             $username['lastname'],
             '(' . $username['login'] . ')'
         ]);
 
         $back_url = $this->ctrl->getLinkTarget($this, self::CMD_VIEW);
         $this->ctrl->setParameterByClass('ilPublicUserProfileGUI', 'back_url', urlencode($back_url));
         $this->ctrl->setParameterByClass('ilPublicUserProfileGUI', 'user_id', $usr_id);
         $url = $this->ctrl->getLinkTargetByClass('ilPublicUserProfileGUI', 'view');
 
         $usr = ilObjectFactory::getInstanceByObjId($usr_id);
         if (!$usr->hasPublicProfile()) {
             $url = $this->ctrl->getLinkTarget($this, self::CMD_PROFILE_NOT_PUBLIC);
         }
         return $this->ui_factory->link()->standard($editor, $url);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nextStep()

ilObjStudyProgrammeAutoMembershipsGUI::nextStep ( )

protected

Definition at line 111 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

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

                                  : void
     {
         $current_src_type = null;
         if ($this->request_wrapper->has(self::F_ORIGINAL_SOURCE_TYPE)) {
             $current_src_type = $this->request_wrapper->retrieve(
                 self::F_ORIGINAL_SOURCE_TYPE,
                 $this->refinery->to()->string()
             );
         }
 
         $current_src_id = null;
         if ($this->request_wrapper->has(self::F_ORIGINAL_SOURCE_ID)) {
             $current_src_id = $this->request_wrapper->retrieve(
                 self::F_ORIGINAL_SOURCE_ID,
                 $this->refinery->to()->string()
             );
         }
 
         $selected_src_type = $this->request_wrapper->retrieve(self::F_SOURCE_TYPE, $this->refinery->kindlyTo()->string());
         $selected_src = $this->request_wrapper->retrieve(self::F_SOURCE_ID, $this->refinery->kindlyTo()->string());
 
         $form = $this->getSelectionForm(
             $selected_src_type,
             $selected_src,
             $current_src_type,
             $current_src_id
         );
         $form_id = "form_" . $form->getId();
 
         $modal = $this->ui_factory->modal()->roundtrip(
             $this->txt('modal_member_auto_select_title'),
             $this->ui_factory->legacy($form->getHtml())
         );
 
         $submit = $this->ui_factory->button()->primary($this->txt('add'), "#")->withOnLoadCode(
             function ($id) use ($form_id) {
                 return "$('#$id').click(function() { $('#$form_id').submit(); return false; });";
             }
         );
 
         $modal = $modal->withActionButtons([$submit]);
 
         echo $this->ui_renderer->renderAsync($modal);
         exit;
     }

Here is the call graph for this function:

◆ parseQueryString()

ilObjStudyProgrammeAutoMembershipsGUI::parseQueryString ( string $string )

protected

Returns: ilQueryParser|string

Definition at line 601 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

References ilQueryParser\QP_COMBINATION_AND, and ilUtil\stripSlashes().

Referenced by getSelectionForm().

     {
         $query_parser = new ilQueryParser(ilUtil::stripSlashes($string));
         $query_parser->setCombination(ilQueryParser::QP_COMBINATION_AND);
         $query_parser->setMinWordLength(1);
         $query_parser->setGlobalMinLength(3); // #14768
         $query_parser->parse();
 
         if (!$query_parser->validate()) {
             return $query_parser->getMessage();
         }
         return $query_parser;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilObjStudyProgrammeAutoMembershipsGUI::save ( )

protected

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

References $post, ilObject\_getAllReferences(), ILIAS\Repository\ctrl(), getForm(), getObject(), ILIAS\Repository\int(), and txt().

                              : void
     {
         $form = $this->getForm();
         $form->checkInput();
 
         $post = $this->request->getParsedBody();
         $form->setValuesByArray($post);
         $src_type = $post[self::F_SOURCE_TYPE];
         $src_id = $post[self::F_SOURCE_ID . $src_type];
 
         if (
             (is_null($src_type) || $src_type === "") ||
             (is_null($src_id) || $src_id === 0)
         ) {
             $this->tpl->setOnScreenMessage("failure", $this->txt('no_srctype_or_id'), true);
             $this->ctrl->redirect($this, self::CMD_VIEW);
             return;
         }
 
         if (in_array($src_type, self::$switch_to_ref_id)) {
             $refs = ilObject::_getAllReferences((int) $src_id);
             $src_id = (int) array_shift($refs);
         }
 
         if (
             array_key_exists(self::F_ORIGINAL_SOURCE_TYPE, $post) &&
             array_key_exists(self::F_ORIGINAL_SOURCE_ID, $post)
         ) {
             $this->getObject()->deleteAutomaticMembershipSource(
                 (string) $post[self::F_ORIGINAL_SOURCE_TYPE],
                 (int) $post[self::F_ORIGINAL_SOURCE_ID]
             );
         }
 
         $this->getObject()->storeAutomaticMembershipSource($src_type, (int) $src_id);
         $this->tpl->setOnScreenMessage("success", $this->txt("auto_add_success"), true);
         $this->ctrl->redirect($this, self::CMD_VIEW);
     }

Here is the call graph for this function:

◆ setParentGUI()

ilObjStudyProgrammeAutoMembershipsGUI::setParentGUI ( ilContainerGUI $a_parent_gui )

Set this GUI's parent gui.

Definition at line 342 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

                                                               : void
     {
         $this->parent_gui = $a_parent_gui;
     }

◆ setRefId()

ilObjStudyProgrammeAutoMembershipsGUI::setRefId ( int $prg_ref_id )

Set ref-id of StudyProgramme before using this GUI.

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

References $prg_ref_id.

                                              : void
     {
         $this->prg_ref_id = $prg_ref_id;
     }

◆ txt()

ilObjStudyProgrammeAutoMembershipsGUI::txt ( string $code )

protected

Definition at line 749 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

References ILIAS\Repository\lng().

Referenced by getAsynchModalOutput(), getForm(), getItemAction(), getSelectionForm(), getToolbar(), nextStep(), and save().

                                         : string
     {
         return $this->lng->txt($code);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ view()

ilObjStudyProgrammeAutoMembershipsGUI::view ( bool $profile_not_public = false )

protected

Render.

Definition at line 160 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

References $data, getItemAction(), getModal(), getObject(), getTitleRepresentation(), getToolbar(), getUserRepresentation(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                                                              : void
     {
         if ($profile_not_public) {
             $this->tpl->setOnScreenMessage("info", $this->lng->txt('prg_profile_not_public'));
         }
         $collected_modals = [];
         $modal = $this->getModal();
         $this->getToolbar($modal->getShowSignal());
         $collected_modals[] = $modal;
         $data = [];
         foreach ($this->getObject()->getAutomaticMembershipSources() as $ams) {
             $title = $this->getTitleRepresentation($ams);
             $usr = $this->getUserRepresentation($ams->getLastEditorId()) ?? $this->ui_factory->legacy('-');
             $modal = $this->getModal($ams->getSourceType(), $ams->getSourceId());
             $collected_modals[] = $modal;
 
             $src_id = $ams->getSourceType() . '-' . $ams->getSourceId();
             $actions = $this->getItemAction(
                 $src_id,
                 $modal->getShowSignal(),
                 $ams->isEnabled()
             );
 
             $data[] = [
                 $ams,
                 $this->ui_renderer->render($title),
                 $this->ui_renderer->render($usr),
                 $this->ui_renderer->render($actions)
             ];
         }
         $table = new ilStudyProgrammeAutoMembershipsTableGUI($this, "view", "");
         $table->setData($data);
         $this->tpl->setContent(
             $this->ui_renderer->render($collected_modals)
             . $table->getHTML()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $object

ilObjStudyProgramme ilObjStudyProgrammeAutoMembershipsGUI::$object = null

Definition at line 62 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

Referenced by getObject().

◆ $parent_gui

ilContainerGUI ilObjStudyProgrammeAutoMembershipsGUI::$parent_gui

protected

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

◆ $prg_ref_id

int ilObjStudyProgrammeAutoMembershipsGUI::$prg_ref_id

Definition at line 63 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

Referenced by getObject(), and setRefId().

◆ $switch_to_ref_id

array ilObjStudyProgrammeAutoMembershipsGUI::$switch_to_ref_id

staticprivate

Initial value:

= [
        ilStudyProgrammeAutoMembershipSource::TYPE_COURSE,
        ilStudyProgrammeAutoMembershipSource::TYPE_GROUP
    ]

Definition at line 57 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

◆ CHECKBOX_SOURCE_IDS

const ilObjStudyProgrammeAutoMembershipsGUI::CHECKBOX_SOURCE_IDS = 'c_amsids'

Definition at line 40 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

Referenced by ilStudyProgrammeAutoMembershipsTableGUI\__construct().

◆ CMD_DELETE

const ilObjStudyProgrammeAutoMembershipsGUI::CMD_DELETE = 'delete'

private

Definition at line 49 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

◆ CMD_DELETE_CONFIRMATION

const ilObjStudyProgrammeAutoMembershipsGUI::CMD_DELETE_CONFIRMATION = 'deleteConfirmation'

private

Definition at line 50 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

◆ CMD_DISABLE

const ilObjStudyProgrammeAutoMembershipsGUI::CMD_DISABLE = 'disable'

private

Definition at line 54 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

◆ CMD_ENABLE

const ilObjStudyProgrammeAutoMembershipsGUI::CMD_ENABLE = 'enable'

private

Definition at line 53 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

◆ CMD_GET_ASYNC_MODAL_OUTPUT

const ilObjStudyProgrammeAutoMembershipsGUI::CMD_GET_ASYNC_MODAL_OUTPUT = 'getAsynchModalOutput'

private

Definition at line 51 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

◆ CMD_NEXT_STEP

const ilObjStudyProgrammeAutoMembershipsGUI::CMD_NEXT_STEP = 'nextStep'

private

Definition at line 52 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

◆ CMD_PROFILE_NOT_PUBLIC

const ilObjStudyProgrammeAutoMembershipsGUI::CMD_PROFILE_NOT_PUBLIC = 'profile_not_public'

private

Definition at line 55 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

◆ CMD_SAVE

const ilObjStudyProgrammeAutoMembershipsGUI::CMD_SAVE = 'save'

private

Definition at line 48 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

◆ CMD_VIEW

const ilObjStudyProgrammeAutoMembershipsGUI::CMD_VIEW = 'view'

private

Definition at line 47 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

◆ F_ORIGINAL_SOURCE_ID

const ilObjStudyProgrammeAutoMembershipsGUI::F_ORIGINAL_SOURCE_ID = 'f_sid_org'

private

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

◆ F_ORIGINAL_SOURCE_TYPE

const ilObjStudyProgrammeAutoMembershipsGUI::F_ORIGINAL_SOURCE_TYPE = 'f_st_org'

private

Definition at line 44 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

◆ F_SOURCE_ID

const ilObjStudyProgrammeAutoMembershipsGUI::F_SOURCE_ID = 'f_sid'

private

Definition at line 43 of file class.ilObjStudyProgrammeAutoMembershipsGUI.php.

◆ F_SOURCE_TYPE

const ilObjStudyProgrammeAutoMembershipsGUI::F_SOURCE_TYPE = 'f_st'

private

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

◆ ROLEFOLDER_REF_ID

const ilObjStudyProgrammeAutoMembershipsGUI::ROLEFOLDER_REF_ID = 8

private

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

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

Modules/StudyProgramme/classes/class.ilObjStudyProgrammeAutoMembershipsGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ deleteConfirmation()

◆ disable()

◆ enable()

◆ executeCommand()

◆ getAsynchModalOutput()

◆ getForm()

◆ getItemAction()

◆ getModal()

◆ getObject()

◆ getSelectionForm()

◆ getTitleRepresentation()

◆ getToolbar()

◆ getUserRepresentation()

◆ nextStep()

◆ parseQueryString()

◆ save()

◆ setParentGUI()

◆ setRefId()

◆ txt()

◆ view()

Field Documentation

◆ $object

◆ $parent_gui

◆ $prg_ref_id

◆ $switch_to_ref_id

◆ CHECKBOX_SOURCE_IDS

◆ CMD_DELETE

◆ CMD_DELETE_CONFIRMATION

◆ CMD_DISABLE

◆ CMD_ENABLE

◆ CMD_GET_ASYNC_MODAL_OUTPUT

◆ CMD_NEXT_STEP

◆ CMD_PROFILE_NOT_PUBLIC

◆ CMD_SAVE

◆ CMD_VIEW

◆ F_ORIGINAL_SOURCE_ID

◆ F_ORIGINAL_SOURCE_TYPE

◆ F_SOURCE_ID

◆ F_SOURCE_TYPE

◆ ROLEFOLDER_REF_ID