Class ilObjStudyProgrammeAutoCategoriesGUI. More...

Collaboration diagram for ilObjStudyProgrammeAutoCategoriesGUI:

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

	executeCommand ()

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

Data Fields
const	CHECKBOX_CATEGORY_REF_IDS = 'c_catids'

ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilToolbarGUI	$toolbar

ilLanguage	$lng

int	$prg_ref_id

ilObjStudyProgramme	$object = null

ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$ui_renderer

Protected Member Functions
	view (bool $profile_not_public=false)
	Render. More...

	save ()
	Store data from (modal-)form. More...

	deleteConfirmation ()

	delete ()

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

	getModal (int $current_ref_id=null)

	getAsyncModalOutput ()

	getForm (?int $current_ref_id=null)

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

	getItemAction (int $cat_ref_id, Signal $signal)

	getUserRepresentation (int $usr_id)

	getItemPath (int $cat_ref_id)

Protected Attributes
MessageBox Factory	$message_box_factory

Button Factory	$button_factory

Psr Http Message ServerRequestInterface	$request

ilTree	$tree

ILIAS HTTP Wrapper RequestWrapper	$request_wrapper

ILIAS Refinery Factory	$refinery

Private Attributes
const	F_CATEGORY_REF = 'f_cr'

const	F_CATEGORY_ORIGINAL_REF = 'f_cr_org'

const	CMD_VIEW = 'view'

const	CMD_SAVE = 'save'

const	CMD_GET_ASYNC_MODAL = 'getAsyncModalOutput'

const	CMD_DELETE = 'delete'

const	CMD_DELETE_CONFIRMATION = 'deleteConfirmation'

const	CMD_PROFILE_NOT_PUBLIC = 'profile_not_public'

Detailed Description

Class ilObjStudyProgrammeAutoCategoriesGUI.

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

@ilCtrl_Calls ilObjStudyProgrammeAutoCategoriesGUI: ilPropertyFormGUI

Definition at line 38 of file class.ilObjStudyProgrammeAutoCategoriesGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjStudyProgrammeAutoCategoriesGUI::__construct	(	ilGlobalTemplateInterface	$tpl,
		ilCtrl	$ilCtrl,
		ilToolbarGUI	$ilToolbar,
		ilLanguage	$lng,
		Factory	$ui_factory,
		MessageBox\Factory	$message_box_factory,
		Button\Factory	$button_factory,
		Renderer	$ui_renderer,
		Psr\Http\Message\ServerRequestInterface	$request,
		ilTree	$tree,
		ILIAS\HTTP\Wrapper\RequestWrapper	$request_wrapper,
		ILIAS\Refinery\Factory	$refinery
	)

Definition at line 67 of file class.ilObjStudyProgrammeAutoCategoriesGUI.php.

      {
        $this->tpl = $tpl;
        $this->ctrl = $ilCtrl;
        $this->toolbar = $ilToolbar;
        $this->lng = $lng;
        $this->ui_factory = $ui_factory;
        $this->message_box_factory = $message_box_factory;
        $this->button_factory = $button_factory;
        $this->ui_renderer = $ui_renderer;
        $this->request = $request;
        $this->tree = $tree;
        $this->request_wrapper = $request_wrapper;
        $this->refinery = $refinery;
    }

References $button_factory, $lng, $message_box_factory, $refinery, $request, $request_wrapper, $tpl, $tree, $ui_factory, $ui_renderer, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Member Function Documentation

◆ delete()

ilObjStudyProgrammeAutoCategoriesGUI::delete ( )

protected

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

                               : void
    {
        $field = self::CHECKBOX_CATEGORY_REF_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);
        }
 
        $cat_ids = base64_decode($get[$field]);
        $cat_ids = explode(' ', trim($cat_ids));
        $cat_ids = array_map('intval', $cat_ids);
 
        $this->getObject()->deleteAutomaticContentCategories($cat_ids);
 
        $msg = $this->lng->txt('prg_delete_single_success');
        if (count($cat_ids) > 1) {
            $msg = $this->lng->txt('prg_delete_success');
        }
 
        $this->tpl->setOnScreenMessage("success", $msg, true);
        $this->ctrl->redirect($this, self::CMD_VIEW);
    }

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

Here is the call graph for this function:

◆ deleteConfirmation()

ilObjStudyProgrammeAutoCategoriesGUI::deleteConfirmation ( )

protected

Definition at line 206 of file class.ilObjStudyProgrammeAutoCategoriesGUI.php.

                                           : void
    {
        $get = $this->request->getQueryParams();
        $post = $this->request->getParsedBody();
        $field = self::CHECKBOX_CATEGORY_REF_IDS;
 
        $field_ids_in_get = array_key_exists($field, $get);
        $field_ids_in_post = array_key_exists($field, $post);
 
        $msg = '';
        $cat_ids = '';
        if ($field_ids_in_get) {
            $cat_ids = $get[$field];
            $msg = $this->lng->txt('prg_delete_single_confirmation');
        } elseif ($field_ids_in_post) {
            $cat_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);
        }
 
        $cat_ids = base64_encode($cat_ids);
 
        $this->ctrl->setParameterByClass(self::class, $field, $cat_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));
    }

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

Here is the call graph for this function:

◆ executeCommand()

ilObjStudyProgrammeAutoCategoriesGUI::executeCommand ( )

Definition at line 95 of file class.ilObjStudyProgrammeAutoCategoriesGUI.php.

                                    : void
    {
        $cmd = $this->ctrl->getCmd();
        $next_class = $this->ctrl->getNextClass($this);
 
        switch ($next_class) {
            case "ilpropertyformgui":
                $form = $this->getForm();
                $this->ctrl->forwardCommand($form);
                break;
            default:
                switch ($cmd) {
                    case self::CMD_VIEW:
                    case self::CMD_DELETE:
                    case self::CMD_DELETE_CONFIRMATION:
                    case self::CMD_GET_ASYNC_MODAL:
                        $this->$cmd();
                        break;
                    case self::CMD_SAVE:
                        $this->$cmd();
                        $this->ctrl->redirect($this, 'view');
                        break;
                    case self::CMD_PROFILE_NOT_PUBLIC:
                        $this->view(true);
                        break;
                    default:
                        throw new ilException("ilObjStudyProgrammeAutoCategoriesGUI: Command not supported: $cmd");
                }
        }
    }

References CMD_DELETE, CMD_DELETE_CONFIRMATION, CMD_GET_ASYNC_MODAL, CMD_PROFILE_NOT_PUBLIC, CMD_SAVE, CMD_VIEW, ILIAS\Repository\ctrl(), getForm(), and view().

Here is the call graph for this function:

◆ getAsyncModalOutput()

ilObjStudyProgrammeAutoCategoriesGUI::getAsyncModalOutput ( )

protected

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

                                            : void
    {
        $current_ref_id = null;
        if ($this->request_wrapper->has(self::CHECKBOX_CATEGORY_REF_IDS)) {
            $current_ref_id = $this->request_wrapper->retrieve(
                self::CHECKBOX_CATEGORY_REF_IDS,
                $this->refinery->kindlyTo()->int()
            );
        }
        $form = $this->getForm($current_ref_id);
        $form_id = "form_" . $form->getId();
        $submit = $this->ui_factory->button()->primary($this->lng->txt('add'), "#")->withOnLoadCode(
            function ($id) use ($form_id) {
                return "$('#$id').click(function() { document.getElementById('$form_id').submit(); return false; });";
            }
        );
        $modal = $this->ui_factory->modal()
            ->roundtrip(
                $this->lng->txt('modal_categories_title'),
                $this->ui_factory->legacy($form->getHtml())
            )
            ->withActionButtons([$submit])
            ->withAdditionalOnLoadCode(
                function ($id) use ($form) {
                    $selector_post_var = self::F_CATEGORY_REF;
                    $js = $form->getItemByPostVar($selector_post_var)->getOnloadCode();
                    return implode(';', $js);
                }
            );
 
 
        echo $this->ui_renderer->renderAsync($modal);
        exit;
    }

References $id, exit, F_CATEGORY_REF, getForm(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ getForm()

ilObjStudyProgrammeAutoCategoriesGUI::getForm ( ?int $current_ref_id = null )

protected

Definition at line 341 of file class.ilObjStudyProgrammeAutoCategoriesGUI.php.

                                                           : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
 
        $form->setId(uniqid((string) $current_ref_id, true));
 
        $form->setFormAction($this->ctrl->getFormAction($this, "save"));
        $cat = new ilRepositorySelector2InputGUI(
            $this->lng->txt("category"),
            self::F_CATEGORY_REF,
            false
        );
        $cat->getExplorerGUI()->setSelectableTypes(["cat"]);
        $cat->getExplorerGUI()->setTypeWhiteList(["root", "cat"]);
        if ($current_ref_id !== null) {
            $cat->getExplorerGUI()->setPathOpen($current_ref_id);
            $cat->setValue($current_ref_id);
        }
        $cat->getExplorerGUI()->setRootId(ROOT_FOLDER_ID);
        $cat->getExplorerGUI()->setAjax(false);
        $form->addItem($cat);
 
        $hi = new ilHiddenInputGUI(self::F_CATEGORY_ORIGINAL_REF);
        $hi->setValue((string)$current_ref_id ?? "");
        $form->addItem($hi);
 
        return $form;
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ROOT_FOLDER_ID.

Referenced by executeCommand(), getAsyncModalOutput(), and save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItemAction()

ilObjStudyProgrammeAutoCategoriesGUI::getItemAction	(	int	$cat_ref_id,
		Signal	$signal
	)

protected

Definition at line 380 of file class.ilObjStudyProgrammeAutoCategoriesGUI.php.

     : Standard {
        $items = [];
        $items[] = $this->ui_factory
            ->button()
            ->shy($this->lng->txt('edit'), '')
            ->withOnClick($signal)
        ;
 
        $this->ctrl->setParameterByClass(self::class, self::CHECKBOX_CATEGORY_REF_IDS, $cat_ref_id);
        $link = $this->ctrl->getLinkTarget($this, self::CMD_DELETE_CONFIRMATION);
        $this->ctrl->clearParameterByClass(self::class, self::CHECKBOX_CATEGORY_REF_IDS);
 
        $items[] = $this->ui_factory
            ->button()
            ->shy($this->lng->txt('delete'), $link)
        ;
 
        return $this->ui_factory->dropdown()->standard($items);
    }

Referenced by view().

Here is the caller graph for this function:

◆ getItemPath()

ilObjStudyProgrammeAutoCategoriesGUI::getItemPath ( int $cat_ref_id )

protected

Definition at line 419 of file class.ilObjStudyProgrammeAutoCategoriesGUI.php.

                                                   : array
    {
        $url = ilLink::_getStaticLink($cat_ref_id, 'cat');
 
        $hops = array_map(
            static function (array $c): string {
                return ilObject::_lookupTitle((int)$c["obj_id"]);
            },
            $this->tree->getPathFull($cat_ref_id)
        );
        $path = implode(' > ', $hops);
        return [$path, $this->ui_factory->link()->standard($path, $url)];
    }

References $c, $path, $url, ilLink\_getStaticLink(), and ilObject\_lookupTitle().

Referenced by view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getModal()

ilObjStudyProgrammeAutoCategoriesGUI::getModal ( int $current_ref_id = null )

protected

Definition at line 291 of file class.ilObjStudyProgrammeAutoCategoriesGUI.php.

                                                           : RoundTrip
    {
        if (!is_null($current_ref_id)) {
            $this->ctrl->setParameter($this, self::CHECKBOX_CATEGORY_REF_IDS, (string) $current_ref_id);
        }
        $link = $this->ctrl->getLinkTarget($this, "getAsyncModalOutput", "", true);
        $this->ctrl->setParameter($this, self::CHECKBOX_CATEGORY_REF_IDS, null);
        return $this->ui_factory->modal()->roundtrip(
            '',
            []
        )->withAsyncRenderUrl(
            $link
        );
    }

References ILIAS\Repository\ctrl().

Referenced by view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObject()

ilObjStudyProgrammeAutoCategoriesGUI::getObject ( )

protected

Get current StudyProgramme-object.

Definition at line 281 of file class.ilObjStudyProgrammeAutoCategoriesGUI.php.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getToolbar()

ilObjStudyProgrammeAutoCategoriesGUI::getToolbar ( Signal $add_cat_signal )

protected

Setup toolbar.

Definition at line 373 of file class.ilObjStudyProgrammeAutoCategoriesGUI.php.

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

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

Referenced by view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserRepresentation()

ilObjStudyProgrammeAutoCategoriesGUI::getUserRepresentation ( int $usr_id )

protected

Definition at line 403 of file class.ilObjStudyProgrammeAutoCategoriesGUI.php.

                                                         : Link
    {
        $username = ilObjUser::_lookupName($usr_id);
        $editor = implode(' ', [
            $username['firstname'],
            $username['lastname'],
            '(' . $username['login'] . ')'
        ]);
        $usr = ilObjectFactory::getInstanceByObjId($usr_id);
        $url = ilLink::_getStaticLink($usr_id, 'usr');
        if (!$usr->hasPublicProfile()) {
            $url = $this->ctrl->getLinkTarget($this, self::CMD_PROFILE_NOT_PUBLIC);
        }
        return $this->ui_factory->link()->standard($editor, $url);
    }

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

Referenced by view().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilObjStudyProgrammeAutoCategoriesGUI::save ( )

protected

Store data from (modal-)form.

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

                             : void
    {
        $form = $this->getForm();
        $form->setValuesByPost();
        $form->checkInput();
 
        $cat_ref_id = $form->getInput(self::F_CATEGORY_REF);
        $current_ref_id = $form->getInput(self::F_CATEGORY_ORIGINAL_REF);
 
        if (ilObject::_lookupType((int) $cat_ref_id, true) !== 'cat') {
            $this->tpl->setOnScreenMessage(
                "failure",
                sprintf($this->lng->txt('not_a_valid_cat_id'), $cat_ref_id),
                true
            );
            return;
        }
 
        if (!is_null($current_ref_id) && $current_ref_id !== $cat_ref_id) {
            $ids = [(int) $current_ref_id];
            $this->getObject()->deleteAutomaticContentCategories($ids);
        }
 
        $this->getObject()->storeAutomaticContentCategory((int) $cat_ref_id);
    }

References ilObject\_lookupType(), getForm(), getObject(), ILIAS\Repository\int(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ setRefId()

ilObjStudyProgrammeAutoCategoriesGUI::setRefId ( int $prg_ref_id )

Set ref-id of StudyProgramme before using this GUI.

Definition at line 273 of file class.ilObjStudyProgrammeAutoCategoriesGUI.php.

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

References $prg_ref_id.

◆ view()

ilObjStudyProgrammeAutoCategoriesGUI::view ( bool $profile_not_public = false )

protected

Render.

Definition at line 129 of file class.ilObjStudyProgrammeAutoCategoriesGUI.php.

                                                             : 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()->getAutomaticContentCategories() as $ac) {
            $ref_id = $ac->getCategoryRefId();
            if (ilObject::_lookupType($ref_id, true) !== 'cat' || $this->tree->isDeleted($ref_id)) {
                continue;
            }
            [$title, $link] = $this->getItemPath($ref_id);
            $usr = $this->getUserRepresentation($ac->getLastEditorId());
            $modal = $this->getModal($ref_id);
            $collected_modals[] = $modal;
            $actions = $this->getItemAction(
                $ac->getCategoryRefId(),
                $modal->getShowSignal()
            );
 
            $data[] = [
                $ac,
                $this->ui_renderer->render($link),
                $this->ui_renderer->render($usr),
                $this->ui_renderer->render($actions),
                $title
            ];
        }
        usort($data, static function (array $a, array $b): int {
            return strnatcasecmp($a[4], $b[4]);
        });
 
        $table = new ilStudyProgrammeAutoCategoriesTableGUI($this, "view", "");
        $table->setData($data);
 
        $this->tpl->setContent(
            $this->ui_renderer->render($collected_modals)
            . $table->getHTML()
        );
    }