@ilCtrl_Calls ilObjDashboardSettingsGUI: ilPermissionGUI @ilCtrl_Calls ilObjDashboardSettingsGUI: ilDashboardPageLanguageSelectGUI, ilObjectContentStyleSettingsGUI @ilCtrl_isCalledBy ilObjDashboardSettingsGUI: ilAdministrationGUI More...

Inheritance diagram for ilObjDashboardSettingsGUI:

Collaboration diagram for ilObjDashboardSettingsGUI:

Public Member Functions
	__construct ( $a_data, int $a_id, bool $a_call_by_reference=true, bool $a_prepare_output=true)

	executeCommand ()

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	editSettings ()

	editSorting (?StandardForm $form=null)

	getViewForm (string $mode)

	getViewSectionSorting (int $view, string $title)

	getViewByMode (string $mode, int $view)

	saveSettings ()

	setSettingsSubTabs (string $a_active)

	editPresentation ()

	editCustomization ()

	getViewSectionPresentation (int $view, string $title)

	saveSorting ()

Public Member Functions inherited from ilObjectGUI
	getRefId ()

	setAdminMode (string $mode)

	getAdminMode ()

	getObject ()

	executeCommand ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelObject ()
	cancel action and go back to previous page More...

	createObject ()
	create new object form More...

	editAvailabilityPeriodObject ()

	saveAvailabilityPeriodObject ()

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()

	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()

	addExternalEditFormCustom (ilPropertyFormGUI $form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...

	isVisible (int $ref_id, string $type)

	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...

	setColumnSettings (ilColumnGUI $column_gui)

	addToDeskObject ()

	removeFromDeskObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Data Fields
const	VIEW_MODE_SETTINGS = 'Settings'

const	VIEW_MODE_PRESENTATION = 'Presentation'

const	VIEW_MODE_SORTING = 'Sorting'

const	DASH_SORT_PREFIX = 'dash_sort_by_'

const	DASH_ENABLE_PREFIX = 'dash_enable_'

Data Fields inherited from ilObjectGUI
const	ADMIN_MODE_NONE = ""

const	ADMIN_MODE_SETTINGS = "settings"

const	ADMIN_MODE_REPOSITORY = "repository"

const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

const	SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]

Protected Member Functions
	savePresentation ()

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	createActionDispatcherGUI ()

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...

	addHeaderAction ()
	Add header action menu. More...

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	setTabs ()
	set admin tabs More...

	setAdminTabs ()
	set admin tabs More...

	setLocator ()

	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...

	omitLocator (bool $omit=true)

	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	getCreationFormsHTML (StandardForm\|ilPropertyFormGUI\|array $form)

	getTitleForCreationFormPage ()

	getCreationFormTitle ()

	initCreateForm (string $new_type)

	didacticTemplatesToForm ()

	initDidacticTemplate (ilPropertyFormGUI $form)

	retrieveAdditionalDidacticTemplateOptions ()

	addAdoptContentLinkToToolbar ()

	addImportButtonToToolbar ()

	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)

	parseDidacticTemplateVar (string $var, string $type)

	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...

	initEditForm ()

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	routeImportCmdObject ()

	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)

	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)

	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...

	setFormAction (string $cmd, string $form_action)

	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	getTabs ()
	@abstract overwrite in derived GUI class of your object type More...

	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

	getCreatableObjectTypes ()

	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)

	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Protected Attributes
Factory	$ui_factory

Renderer	$ui_renderer

ilPDSelectedItemsBlockViewSettings	$viewSettings

UIServices	$ui

ilDashboardSidePanelSettingsRepository	$side_panel_settings

GUIService	$style_gui

Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service

GlobalHttpState	$http

ServerRequestInterface	$request

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilSetting	$settings

ilToolbarGUI	$toolbar

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

ilObjectService	$object_service

ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilCtrl	$ctrl

ilErrorHandling	$error

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ILIAS	$ilias

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Refinery	$refinery

ilFavouritesManager	$favourites

CustomIconFactory	$custom_icon_factory

UIFactory	$ui_factory

UIRenderer	$ui_renderer

Filesystem	$temp_file_system

ilObject	$object = null

bool	$creation_mode = false

	$data

int	$id

bool	$call_by_reference = false

bool	$prepare_output

int	$ref_id

int	$obj_id

int	$maxcount

array	$form_action = []

array	$return_location = []

array	$target_frame = []

string	$tmp_import_dir

string	$sub_objects = ""

bool	$omit_locator = false

string	$type = ""

string	$admin_mode = self::ADMIN_MODE_NONE

int	$requested_ref_id = 0

int	$requested_crtptrefid = 0

int	$requested_crtcb = 0

string	$requested_new_type = ""

string	$link_params

string	$html = ""

Private Member Functions
	maybeDisable (array $fields)

	canWrite ()

	manuallySortingSettings (int $view, string $name, array $saved)

	sortingCheckbox (int $view, string $name, array $saved)

	sortingInputs (int $view)

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode (int $ref_id, string $cmd="")

static	_gotoSharedWorkspaceNode (int $wsp_id)

Detailed Description

@ilCtrl_Calls ilObjDashboardSettingsGUI: ilPermissionGUI @ilCtrl_Calls ilObjDashboardSettingsGUI: ilDashboardPageLanguageSelectGUI, ilObjectContentStyleSettingsGUI @ilCtrl_isCalledBy ilObjDashboardSettingsGUI: ilAdministrationGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjDashboardSettingsGUI::__construct	(		$a_data,
		int	$a_id,
		bool	$a_call_by_reference = `true`,
		bool	$a_prepare_output = `true`
	)

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

      {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->rbac_system = $DIC->rbac()->system();
        $this->access = $DIC->access();
        $this->ctrl = $DIC->ctrl();
        $this->settings = $DIC->settings();
        $lng = $DIC->language();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->request = $DIC->http()->request();
        $this->ui = $DIC->ui();
        $this->style_gui = $DIC->contentStyle()->gui();
 
        $this->type = 'dshs';
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
 
        $lng->loadLanguageModule('dash');
 
        $this->viewSettings = new ilPDSelectedItemsBlockViewSettings($DIC->user());
 
        $this->side_panel_settings = new ilDashboardSidePanelSettingsRepository();
    }

References $DIC, ilObjectGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), ILIAS\Repository\settings(), and ILIAS\Repository\ui().

Here is the call graph for this function:

Member Function Documentation

◆ canWrite()

ilObjDashboardSettingsGUI::canWrite ( )

private

Definition at line 414 of file class.ilObjDashboardSettingsGUI.php.

                               : bool
    {
        return $this->rbac_system->checkAccess('write', $this->object->getRefId());
    }

References ILIAS\Repository\object().

Referenced by editSettings(), getViewSectionSorting(), maybeDisable(), savePresentation(), saveSettings(), and saveSorting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editCustomization()

ilObjDashboardSettingsGUI::editCustomization ( )

Definition at line 301 of file class.ilObjDashboardSettingsGUI.php.

                                       : void
    {
        $this->ui->mainTemplate()->setOnScreenMessage(
            $this->ui->mainTemplate()::MESSAGE_TYPE_INFO,
            $this->lng->txt('dash_page_edit_info'),
            true
        );
 
        $this->tabs_gui->activateTab('dash_customization');
 
        $content = $this->ui->renderer()->render(
            $this->ui->factory()->button()->standard(
                $this->lng->txt('customize_page'),
                $this->ctrl->getLinkTargetByClass([self::class, ilDashboardPageLanguageSelectGUI::class], 'select')
            )
        );
 
        if (ilDashboardPageGUI::isLanguageAvailable($this->user->getLanguage())) {
            $content .= (new ilDashboardPageGUI($this->user->getLanguage()))->showPage();
        } elseif (ilDashboardPageGUI::isLanguageAvailable($this->lng->getContentLanguage())) {
            $content .= (new ilDashboardPageGUI($this->lng->getDefaultLanguage()))->showPage();
        }
 
        $this->tpl->setContent($content);
    }

References ilDashboardPageGUI\isLanguageAvailable(), ILIAS\Repository\lng(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ editPresentation()

ilObjDashboardSettingsGUI::editPresentation ( )

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

                                      : void
    {
        $this->tabs_gui->activateTab('settings');
        $this->setSettingsSubTabs('presentation');
 
        $form = $this->getViewForm(self::VIEW_MODE_PRESENTATION);
 
        $this->tpl->setContent($this->ui->renderer()->renderAsync($form));
    }

References getViewForm(), setSettingsSubTabs(), and ILIAS\Repository\ui().

Referenced by savePresentation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editSettings()

ilObjDashboardSettingsGUI::editSettings ( )

Definition at line 146 of file class.ilObjDashboardSettingsGUI.php.

                                  : void
    {
        if ($this->settings->get('rep_favourites', '0') !== '1') {
            $content[] = $this->ui_factory->messageBox()->info($this->lng->txt('favourites_disabled_info'));
        }
 
        if ($this->settings->get('mmbr_my_crs_grp', '0') !== '1') {
            $content[] = $this->ui_factory->messageBox()->info($this->lng->txt('memberships_disabled_info'));
        }
        $this->setSettingsSubTabs('general');
        $table = new ilDashboardSortationTableGUI($this, 'editSettings', !$this->canWrite());
        $this->tpl->setContent($table->getHTML());
    }

References canWrite(), ILIAS\Repository\lng(), setSettingsSubTabs(), and ILIAS\Repository\settings().

Referenced by saveSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editSorting()

ilObjDashboardSettingsGUI::editSorting ( ?StandardForm $form = null )

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

                                                           : void
    {
        $this->tabs_gui->activateTab('settings');
        $this->setSettingsSubTabs('sorting');
        $form = $form ?? $this->getViewForm(self::VIEW_MODE_SORTING);
        $this->tpl->setContent($this->ui->renderer()->renderAsync($form));
    }

References getViewForm(), setSettingsSubTabs(), and ILIAS\Repository\ui().

Referenced by saveSorting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjDashboardSettingsGUI::executeCommand ( )

Reimplemented from ilObjectGUI.

Definition at line 80 of file class.ilObjDashboardSettingsGUI.php.

                                    : void
    {
        $cmd = $this->ctrl->getCmd();
 
        $this->prepareOutput();
 
        if (!$this->rbac_system->checkAccess('visible,read', $this->object->getRefId())) {
            throw new ilPermissionException($this->lng->txt('no_permission'));
        }
 
        switch ($this->ctrl->getNextClass($this)) {
            case strtolower(ilPermissionGUI::class):
                $this->tabs_gui->activateTab('perm_settings');
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
            case strtolower(ilDashboardPageLanguageSelectGUI::class):
                $this->tabs_gui->activateTab('dash_customization');
                $this->ctrl->forwardCommand(new ilDashboardPageLanguageSelectGUI());
                break;
            case strtolower(ilObjectContentStyleSettingsGUI::class):
                $this->tabs_gui->clearTargets();
                $this->ctrl->setParameterByClass(ilDashboardPageGUI::class, 'dshs_lang', $this->request->getQueryParams()['dshs_lang']);
                $this->tabs_gui->setBackTarget($this->lng->txt('back'), $this->ctrl->getLinkTargetByClass(
                    [ilDashboardPageLanguageSelectGUI::class, ilDashboardPageGUI::class],
                    'edit'
                ));
                $gui = $this->style_gui->objectSettingsGUIForRefId(null, $this->getRefId());
                $this->ctrl->setParameter($gui, 'dshs_lang', $this->request->getQueryParams()['dshs_lang']);
                $this->ctrl->forwardCommand($gui);
                break;
            default:
                $this->tabs_gui->activateTab('settings');
                if (!$cmd || $cmd === 'view') {
                    $cmd = 'editSettings';
                }
 
                $this->$cmd();
                break;
        }
    }

References ILIAS\Repository\ctrl(), ilObjectGUI\getRefId(), ILIAS\Repository\lng(), and ilObjectGUI\prepareOutput().

Here is the call graph for this function:

◆ getAdminTabs()

ilObjDashboardSettingsGUI::getAdminTabs ( )

administration tabs show only permissions and trash folder

Reimplemented from ilObjectGUI.

Definition at line 122 of file class.ilObjDashboardSettingsGUI.php.

                                  : void
    {
        if ($this->rbac_system->checkAccess('visible,read', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                'settings',
                $this->ctrl->getLinkTarget($this, 'editSettings'),
                ['editSettings', 'view']
            );
            $this->tabs_gui->addTarget(
                'dash_customization',
                $this->ctrl->getLinkTargetByClass(ilDashboardPageLanguageSelectGUI::class)
            );
        }
 
        if ($this->rbac_system->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                'perm_settings',
                $this->ctrl->getLinkTargetByClass(ilPermissionGUI::class, 'perm'),
                [],
                ilPermissionGUI::class
            );
        }
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getViewByMode()

ilObjDashboardSettingsGUI::getViewByMode	(	string	$mode,
		int	$view
	)

Definition at line 211 of file class.ilObjDashboardSettingsGUI.php.

                                                          : Section
    {
        switch ($mode) {
            case self::VIEW_MODE_SORTING:
                return $this->getViewSectionSorting(
                    $view,
                    $this->lng->txt('dash_' . $this->viewSettings->getViewName($view))
                );
            case self::VIEW_MODE_PRESENTATION:
            default:
                return $this->getViewSectionPresentation(
                    $view,
                    $this->lng->txt('dash_' . $this->viewSettings->getViewName($view))
                );
        }
    }

References getViewSectionPresentation(), getViewSectionSorting(), ILIAS\Repository\lng(), VIEW_MODE_PRESENTATION, and VIEW_MODE_SORTING.

Referenced by getViewForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getViewForm()

ilObjDashboardSettingsGUI::getViewForm ( string $mode )

Definition at line 168 of file class.ilObjDashboardSettingsGUI.php.

                                             : ?StandardForm
    {
        switch ($mode) {
            case self::VIEW_MODE_PRESENTATION:
            case self::VIEW_MODE_SORTING:
                return $this->ui_factory->input()->container()->form()->standard(
                    $this->ctrl->getFormAction($this, 'save' . $mode),
                    array_map(
                        fn(int $view): Section => $this->getViewByMode($mode, $view),
                        $this->viewSettings->getPresentationViews()
                    )
                );
        }
        return null;
    }

References ILIAS\Repository\ctrl(), getViewByMode(), VIEW_MODE_PRESENTATION, and VIEW_MODE_SORTING.

Referenced by editPresentation(), editSorting(), savePresentation(), and saveSorting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getViewSectionPresentation()

ilObjDashboardSettingsGUI::getViewSectionPresentation	(	int	$view,
		string	$title
	)

Definition at line 327 of file class.ilObjDashboardSettingsGUI.php.

                                                                        : Section
    {
        $lng = $this->lng;
        $ops = $this->viewSettings->getAvailablePresentationsByView($view);
        $pres_options = array_column(
            array_map(
                static fn(int $k, string $v): array => [$v, $lng->txt('dash_' . $v)],
                array_keys($ops),
                $ops
            ),
            1,
            0
        );
        $avail_pres = $this->ui_factory->input()->field()->multiSelect(
            $lng->txt('dash_avail_presentation'),
            $pres_options
        )
                                       ->withValue($this->viewSettings->getActivePresentationsByView($view));
        $default_pres = $this->ui_factory->input()->field()->radio($lng->txt('dash_default_presentation'))
                                         ->withOption('list', $lng->txt('dash_list'))
                                         ->withOption('tile', $lng->txt('dash_tile'));
        $default_pres = $default_pres->withValue($this->viewSettings->getDefaultPresentationByView($view));
        return $this->ui_factory->input()->field()->section(
            $this->maybeDisable(['avail_pres' => $avail_pres, 'default_pres' => $default_pres]),
            $title
        );
    }

References ilObjectGUI\$lng, maybeDisable(), and ilLanguage\txt().

Referenced by getViewByMode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getViewSectionSorting()

ilObjDashboardSettingsGUI::getViewSectionSorting	(	int	$view,
		string	$title
	)

Definition at line 184 of file class.ilObjDashboardSettingsGUI.php.

                                                                   : Section
    {
        if ($this->canWrite()) {
            $this->tpl->addJavaScript("assets/js/SortationUserInputHandler.js");
        }
        $available = $this->viewSettings->getAvailableSortOptionsByView($view);
        $options = array_combine($available, $available);
        $select_options = array_map(fn($s) => $this->lng->txt(self::DASH_SORT_PREFIX . $s), $options);
        $available_sorting = array_map($this->sortingInputs($view), $options);
        $default_sorting = $this->ui_factory
            ->input()
            ->field()
            ->select($this->lng->txt('dash_default_sortation'), $select_options)
            ->withValue($this->viewSettings->getDefaultSortingByView($view))
            ->withAdditionalOnLoadCode(
                static fn(string $id) => "
                document.getElementById('$id').setAttribute('data-select', 'sorting$view');
                window.addEventListener('DOMContentLoaded', () => il.Dashboard.handleUserInputForSortationsByView($view));
            "
            );
 
        return $this->ui_factory->input()->field()->section(
            $this->maybeDisable([...$available_sorting, 'default_sorting' => $default_sorting]),
            $title
        );
    }

References ilObjectGUI\$id, canWrite(), ILIAS\Repository\lng(), maybeDisable(), and sortingInputs().

Referenced by getViewByMode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ manuallySortingSettings()

ilObjDashboardSettingsGUI::manuallySortingSettings	(	int	$view,
		string	$name,
		array	$saved
	)

private

Parameters

array<string,mixed> $saved

Definition at line 422 of file class.ilObjDashboardSettingsGUI.php.

                                                                                   : Input
    {
        $options = $this->viewSettings->getSortingOptionsByView($view);
        $sort_options = $this->viewSettings->getAvailableOptionsBySortation($name);
        $value = isset($saved[$name]) ?
            ['new_items' => ($options[$name]['new_items'] ?? null) ?: 'top'] :
            null;
 
        return $this->ui_factory->input()->field()->optionalGroup([
            'new_items' => array_reduce(
                $sort_options,
                fn($r, $o) => $r->withOption($o, $this->lng->txt('dash_manual_new_item_pos_' . $o)),
                $this->ui_factory->input()->field()->radio($this->lng->txt('dash_manual_new_item_pos'), '')
            )
        ], $this->lng->txt(self::DASH_SORT_PREFIX . $name))
            ->withValue($value);
    }

References ILIAS\Repository\lng(), and ILIAS\UI\Implementation\Component\Input\withValue().

Here is the call graph for this function:

◆ maybeDisable()

ilObjDashboardSettingsGUI::maybeDisable ( array $fields )

private

Parameters

FormInput[] $fields

Returns: FormInput[]

Definition at line 405 of file class.ilObjDashboardSettingsGUI.php.

                                                : array
    {
        if ($this->canWrite()) {
            return $fields;
        }
 
        return array_map(static fn(FormInput $field): FormInput => $field->withDisabled(true), $fields);
    }

References canWrite(), and ILIAS\UI\Implementation\Component\Input\Field\FormInput\withDisabled().

Referenced by getViewSectionPresentation(), and getViewSectionSorting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ savePresentation()

ilObjDashboardSettingsGUI::savePresentation ( )

protected

Definition at line 355 of file class.ilObjDashboardSettingsGUI.php.

                                         : void
    {
        if ($this->canWrite()) {
            $data = $this->getViewForm(self::VIEW_MODE_PRESENTATION)->withRequest($this->request)->getData();
 
            foreach ($data as $view => $view_data) {
                $this->viewSettings->storeViewPresentation(
                    $view,
                    $view_data['default_pres'],
                    $view_data['avail_pres'] ?? []
                );
            }
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('msg_obj_modified'), true);
        } else {
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_FAILURE, $this->lng->txt('no_permission'), true);
        }
        $this->editPresentation();
    }

References ilObjectGUI\$data, canWrite(), editPresentation(), getViewForm(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ saveSettings()

ilObjDashboardSettingsGUI::saveSettings ( )

Definition at line 228 of file class.ilObjDashboardSettingsGUI.php.

                                  : void
    {
        if ($this->canWrite()) {
            $form_data = $this->request->getParsedBody();
            foreach ($this->viewSettings->getPresentationViews() as $presentation_view) {
                if (isset($form_data['main_panel']['enable'][$presentation_view])) {
                    $this->viewSettings->enableView(
                        $presentation_view,
                        (bool) $form_data['main_panel']['enable'][$presentation_view]
                    );
                } elseif ($presentation_view !== ilPDSelectedItemsBlockConstants::VIEW_RECOMMENDED_CONTENT) {
                    $this->viewSettings->enableView($presentation_view, false);
                }
            }
 
            $positions = $form_data['main_panel']['position'];
            asort($positions);
            $this->viewSettings->setViewPositions(array_keys($positions));
 
            foreach ($this->side_panel_settings->getValidModules() as $mod) {
                $this->side_panel_settings->enable($mod, (bool) ($form_data['side_panel']['enable'][$mod] ?? false));
            }
 
            $positions = $form_data['side_panel']['position'];
            asort($positions);
            $this->side_panel_settings->setPositions(array_keys($positions));
 
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('settings_saved'), true);
        } else {
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_FAILURE, $this->lng->txt('no_permission'), true);
        }
        $this->editSettings();
    }

References canWrite(), editSettings(), ILIAS\Repository\lng(), and ilPDSelectedItemsBlockConstants\VIEW_RECOMMENDED_CONTENT.

Here is the call graph for this function:

◆ saveSorting()

ilObjDashboardSettingsGUI::saveSorting ( )

Definition at line 374 of file class.ilObjDashboardSettingsGUI.php.

                                 : void
    {
        $form = null;
        if ($this->canWrite()) {
            $form = $this->getViewForm(self::VIEW_MODE_SORTING)->withRequest($this->request);
            $data = $form->getData();
            if ($data) {
                foreach ($data as $view => $view_data) {
                    $avail_sorting = array_keys(array_filter($view_data));
                    $saved = array_filter($view_data, fn($x) => !is_bool($x));
                    if (isset($view_data['default_sorting'])) {
                        $this->viewSettings->storeViewSorting(
                            $view,
                            $view_data['default_sorting'],
                            $avail_sorting
                        );
                        $this->viewSettings->storeViewSortingOptions($view, $saved);
                    }
                }
                $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('msg_obj_modified'), true);
            }
        } else {
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_FAILURE, $this->lng->txt('no_permission'), true);
        }
        $this->editSorting($form);
    }

References ilObjectGUI\$data, canWrite(), editSorting(), getViewForm(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ setSettingsSubTabs()

ilObjDashboardSettingsGUI::setSettingsSubTabs ( string $a_active )

Definition at line 262 of file class.ilObjDashboardSettingsGUI.php.

                                                        : void
    {
        $tabs = $this->tabs_gui;
        $ctrl = $this->ctrl;
        $lng = $this->lng;
 
        if ($this->rbac_system->checkAccess('visible,read', $this->object->getRefId())) {
            $tabs->addSubTab(
                'general',
                $lng->txt('general_settings'),
                $ctrl->getLinkTarget($this, 'editSettings')
            );
 
            $tabs->addSubTab(
                'presentation',
                $lng->txt('dash_presentation'),
                $ctrl->getLinkTarget($this, 'editPresentation')
            );
 
            $tabs->addSubTab(
                'sorting',
                $lng->txt('dash_sortation'),
                $ctrl->getLinkTarget($this, 'editSorting')
            );
        }
 
        $tabs->activateSubTab($a_active);
    }

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjectGUI\$tabs_gui, ilCtrl\getLinkTarget(), and ilLanguage\txt().

Referenced by editPresentation(), editSettings(), and editSorting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sortingCheckbox()

ilObjDashboardSettingsGUI::sortingCheckbox	(	int	$view,
		string	$name,
		array	$saved
	)

private

Parameters

array<string,mixed> $saved

Definition at line 443 of file class.ilObjDashboardSettingsGUI.php.

                                                                           : Input
    {
        return $this->ui_factory->input()->field()
            ->checkbox($this->lng->txt(self::DASH_SORT_PREFIX . $name))
            ->withAdditionalOnLoadCode(fn(string $id) => "
                document.getElementById('$id').closest('form').addEventListener('submit', e => (
                    e.target.querySelectorAll('input[disabled]').forEach(x => {x.disabled = false;})
                ));
            ")
            ->withValue(isset($saved[$name]));
    }

References ilObjectGUI\$id, ILIAS\Repository\lng(), and ILIAS\UI\Component\Input\Input\withValue().

Here is the call graph for this function:

◆ sortingInputs()

ilObjDashboardSettingsGUI::sortingInputs ( int $view )

private

Definition at line 455 of file class.ilObjDashboardSettingsGUI.php.

                                             : Closure
    {
        $saved = array_flip($this->viewSettings->getActiveSortingsByView($view));
        $with_js = fn($name, $check) => $check->withAdditionalOnLoadCode(fn($id) => "
            document.getElementById('$id').setAttribute('data-checkbox', 'activeSorting$view');
            document.querySelector('#$id input').setAttribute('data-value', '$name')
        ");
 
        $special_settings = ['manually'];
        $method_for = fn($name) => in_array($name, $special_settings, true) ?
            $name . 'SortingSettings' :
            'sortingCheckbox';
 
        return fn(string $name) => $with_js($name, $this->{$method_for($name)}($view, $name, $saved));
    }