Inheritance diagram for ilPDSelectedItemsBlockViewSettings:

Collaboration diagram for ilPDSelectedItemsBlockViewSettings:

Public Member Functions
	__construct (ilObjUser $actor, int $view=self::VIEW_SELECTED_ITEMS, ?Setting $settings=null, ?DashboardAccess $access=null)

	getMembershipsView ()

	getSelectedItemsView ()

	getStudyProgrammeView ()

	getLearningSequenceView ()

	getRecommendedContentView ()

	getListPresentationMode ()

	getTilePresentationMode ()

	isMembershipsViewActive ()

	isRecommendedContentViewActive ()

	isSelectedItemsViewActive ()

	isStudyProgrammeViewActive ()

	isLearningSequenceViewActive ()

	getSortByStartDateMode ()

	getSortByLocationMode ()

	getSortByTypeMode ()

	getSortByAlphabetMode ()

	getAvailableSortOptionsByView (int $view)

	getDefaultSortingByView (int $view)

	getPresentationViews ()

	getAvailablePresentationsByView (int $view)

	storeViewSorting (int $view, string $type, array $active)

	storeViewSortingOptions (int $view, array $options)

	getActiveSortingsByView (int $view)

	storeViewPresentation (int $view, string $default, array $active)

	getDefaultPresentationByView (int $view)

	getActivePresentationsByView (int $view)

	setViewPositions (array $positions)

	getViewPositions ()

	isViewEnabled (int $view)

	enableView (int $view, bool $status)

	enabledMemberships ()

	enabledSelectedItems ()

	enableMemberships (bool $status)

	enableSelectedItems (bool $status)

	allViewsEnabled ()

	getDefaultView ()

	storeDefaultView (int $view)

	parse ()

	getEffectivePresentationMode ()

	getEffectiveSortingMode ()

	getSelectableSortingModes ()

	getSelectablePresentationModes ()

	storeActorPresentationMode (string $presentationMode)

	storeActorSortingMode (string $sortingMode)

	getActor ()

	getCurrentView ()

	getCurrentSortOption ()

	isValidView (int $view)

	getDefaultSorting ()

	isSortedByType ()

	isSortedByAlphabet ()

	isSortedByLocation ()

	isSortedByStartDate ()

	isTilePresentation ()

	isListPresentation ()

	enabledRecommendedContent ()

	enabledLearningSequences ()

	enabledStudyProgrammes ()

	enableLearningSequences (bool $status)

	enableStudyProgrammes (bool $status)

	getViewName (int $view)

	getEffectiveSortingData ()

	getEffectiveSortingOptions ()

	storeActorSortingData (array $data)

	getAvailableOptionsBySortation (string $sortation)

	getSortingOptionsByView (int $view)

Protected Member Functions
	allViewsDisabled ()

Protected Attributes
Setting	$settings

ilObjUser	$actor

array	$validViews = []

int	$currentView = self::VIEW_SELECTED_ITEMS

string	$currentSortOption = self::SORT_BY_LOCATION

string	$currentPresentationOption = self::PRESENTATION_LIST

DashboardAccess	$access

Static Protected Attributes
static array	$availableViews

static array	$viewNames

static array	$availablePresentations

static array	$availableSortOptions

static array	$availableSortOptionsByView

static array	$availablePresentationsByView

Static Private Attributes
static array	$has_data = [self::SORT_MANUALLY]

static array	$has_options = [self::SORT_MANUALLY]

static array	$options_by_sortation

Additional Inherited Members
Data Fields inherited from ilPDSelectedItemsBlockConstants
const	VIEW_SELECTED_ITEMS = 0

const	VIEW_RECOMMENDED_CONTENT = 1

const	VIEW_MY_MEMBERSHIPS = 2

const	VIEW_LEARNING_SEQUENCES = 3

const	VIEW_MY_STUDYPROGRAMME = 4

const	SORT_BY_TYPE = 'type'

const	SORT_BY_LOCATION = 'location'

const	SORT_BY_START_DATE = 'start_date'

const	SORT_BY_ALPHABET = 'alphabet'

const	SORT_MANUALLY = 'manually'

const	PRESENTATION_LIST = 'list'

const	PRESENTATION_TILE = 'tile'

Detailed Description

Definition at line 24 of file class.ilPDSelectedItemsBlockViewSettings.php.

Constructor & Destructor Documentation

◆ __construct()

ilPDSelectedItemsBlockViewSettings::__construct	(	ilObjUser	$actor,
		int	$view = `self::VIEW_SELECTED_ITEMS`,
		?Setting	$settings = `null`,
		?DashboardAccess	$access = `null`
	)

Definition at line 120 of file class.ilPDSelectedItemsBlockViewSettings.php.

      {
        global $DIC;
 
        $this->settings = $settings ?? $DIC->settings();
 
        $this->actor = $actor;
        $this->currentView = $view;
        $this->access = $access ?? new DashboardAccess();
    }

References $actor, $DIC, ILIAS\Repository\access(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ allViewsDisabled()

ilPDSelectedItemsBlockViewSettings::allViewsDisabled ( )

protected

Definition at line 402 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                         : bool
    {
        return !$this->enabledMemberships() && !$this->enabledSelectedItems();
    }

References enabledMemberships(), and enabledSelectedItems().

Here is the call graph for this function:

◆ allViewsEnabled()

ilPDSelectedItemsBlockViewSettings::allViewsEnabled ( )

Definition at line 397 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                     : bool
    {
        return $this->enabledMemberships() && $this->enabledSelectedItems();
    }

References enabledMemberships(), and enabledSelectedItems().

Here is the call graph for this function:

◆ enabledLearningSequences()

ilPDSelectedItemsBlockViewSettings::enabledLearningSequences ( )

Definition at line 552 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                              : bool
    {
        return (int) $this->settings->get('disable_learning_sequences', '1') === 0;
    }

References ILIAS\Repository\settings().

Referenced by isViewEnabled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enabledMemberships()

ilPDSelectedItemsBlockViewSettings::enabledMemberships ( )

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

                                        : bool
    {
        return (int) $this->settings->get('disable_my_memberships', '0') === 0;
    }

References ILIAS\Repository\settings().

Referenced by allViewsDisabled(), allViewsEnabled(), and isViewEnabled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enabledRecommendedContent()

ilPDSelectedItemsBlockViewSettings::enabledRecommendedContent ( )

Definition at line 547 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                               : bool
    {
        return true;
    }

Referenced by isViewEnabled().

Here is the caller graph for this function:

◆ enabledSelectedItems()

ilPDSelectedItemsBlockViewSettings::enabledSelectedItems ( )

Definition at line 382 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                          : bool
    {
        return (int) $this->settings->get('disable_my_offers', '0') === 0;
    }

References ILIAS\Repository\settings().

Referenced by allViewsDisabled(), allViewsEnabled(), and isViewEnabled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enabledStudyProgrammes()

ilPDSelectedItemsBlockViewSettings::enabledStudyProgrammes ( )

Definition at line 557 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                            : bool
    {
        return (int) $this->settings->get('disable_study_programmes', '1') === 0;
    }

References ILIAS\Repository\settings().

Referenced by isViewEnabled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableLearningSequences()

ilPDSelectedItemsBlockViewSettings::enableLearningSequences ( bool $status )

Definition at line 562 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                         : void
    {
        $this->settings->set('disable_learning_sequences', $status ? '0' : '1');
    }

References ILIAS\Repository\settings().

Referenced by enableView().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableMemberships()

ilPDSelectedItemsBlockViewSettings::enableMemberships ( bool $status )

Definition at line 387 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                   : void
    {
        $this->settings->set('disable_my_memberships', $status ? '0' : '1');
    }

References ILIAS\Repository\settings().

Referenced by enableView(), and DashboardViewSettingsTest\testDisableMemberships().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableSelectedItems()

ilPDSelectedItemsBlockViewSettings::enableSelectedItems ( bool $status )

Definition at line 392 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                     : void
    {
        $this->settings->set('disable_my_offers', $status ? '0' : '1');
    }

References ILIAS\Repository\settings().

Referenced by enableView(), and DashboardViewSettingsTest\testDisableSelectedItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableStudyProgrammes()

ilPDSelectedItemsBlockViewSettings::enableStudyProgrammes ( bool $status )

Definition at line 567 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                       : void
    {
        $this->settings->set('disable_study_programmes', $status ? '0' : '1');
    }

References ILIAS\Repository\settings().

Referenced by enableView().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableView()

ilPDSelectedItemsBlockViewSettings::enableView	(	int	$view,
		bool	$status
	)

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

                                                       : void
    {
        switch ($view) {
            case $this->getMembershipsView():
                $this->enableMemberships($status);
                break;
            case $this->getSelectedItemsView():
                $this->enableSelectedItems($status);
                break;
            case $this->getStudyProgrammeView():
                $this->enableStudyProgrammes($status);
                break;
            case $this->getRecommendedContentView():
                break;
            case $this->getLearningSequenceView():
                $this->enableLearningSequences($status);
                break;
            default:
                throw new InvalidArgumentException('Unknown view: $view');
        }
    }

References enableLearningSequences(), enableMemberships(), enableSelectedItems(), enableStudyProgrammes(), getLearningSequenceView(), getMembershipsView(), getRecommendedContentView(), getSelectedItemsView(), and getStudyProgrammeView().

Here is the call graph for this function:

◆ getActivePresentationsByView()

ilPDSelectedItemsBlockViewSettings::getActivePresentationsByView ( int $view )

Returns: string[]

Definition at line 309 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                           : array
    {
        $val = $this->settings->get('pd_active_pres_view_' . $view, '');
 
        return (!$val)
            ? $this->getAvailablePresentationsByView($view)
            : unserialize($val, ['allowed_classes' => false]);
    }

References getAvailablePresentationsByView(), and ILIAS\Repository\settings().

Referenced by getSelectablePresentationModes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActiveSortingsByView()

ilPDSelectedItemsBlockViewSettings::getActiveSortingsByView ( int $view )

Returns: string[]

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

                                                      : array
    {
        $val = $this->settings->get('pd_active_sort_view_' . $view);
        if ($val === '' || $val === null) {
            $active_sortings = $this->getAvailableSortOptionsByView($view);
        } else {
            $active_sortings = unserialize($val, ['allowed_classes' => false]);
        }
        return array_filter(
            $active_sortings,
            fn(string $sorting): bool => in_array(
                $sorting,
                $this->getAvailableSortOptionsByView($view),
                true
            )
        );
    }

References getAvailableSortOptionsByView(), and ILIAS\Repository\settings().

Referenced by getSelectableSortingModes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActor()

ilPDSelectedItemsBlockViewSettings::getActor ( )

Definition at line 492 of file class.ilPDSelectedItemsBlockViewSettings.php.

                              : ilObjUser
    {
        return $this->actor;
    }

References $actor.

◆ getAvailableOptionsBySortation()

ilPDSelectedItemsBlockViewSettings::getAvailableOptionsBySortation ( string $sortation )

Definition at line 602 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                                     : array
    {
        return self::$options_by_sortation[$sortation] ?? [];
    }

◆ getAvailablePresentationsByView()

ilPDSelectedItemsBlockViewSettings::getAvailablePresentationsByView ( int $view )

Returns: string[]

Definition at line 240 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                              : array
    {
        return self::$availablePresentationsByView[$view];
    }

Referenced by getActivePresentationsByView(), and getSelectablePresentationModes().

Here is the caller graph for this function:

◆ getAvailableSortOptionsByView()

ilPDSelectedItemsBlockViewSettings::getAvailableSortOptionsByView ( int $view )

Definition at line 215 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                            : array
    {
        return self::$availableSortOptionsByView[$view] ?? [];
    }

Referenced by getActiveSortingsByView(), getDefaultSortingByView(), getSelectableSortingModes(), storeViewSorting(), and storeViewSortingOptions().

Here is the caller graph for this function:

◆ getCurrentSortOption()

ilPDSelectedItemsBlockViewSettings::getCurrentSortOption ( )

Definition at line 502 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                          : string
    {
        return $this->currentSortOption;
    }

References $currentSortOption.

◆ getCurrentView()

ilPDSelectedItemsBlockViewSettings::getCurrentView ( )

Definition at line 497 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                    : int
    {
        return $this->currentView;
    }

References $currentView.

Referenced by getEffectiveSortingData(), getEffectiveSortingOptions(), and storeActorSortingData().

Here is the caller graph for this function:

◆ getDefaultPresentationByView()

ilPDSelectedItemsBlockViewSettings::getDefaultPresentationByView ( int $view )

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

                                                           : string
    {
        return $this->settings->get('pd_def_pres_view_' . $view, 'list');
    }

References ILIAS\Repository\settings().

Referenced by getEffectivePresentationMode(), and getSelectablePresentationModes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultSorting()

ilPDSelectedItemsBlockViewSettings::getDefaultSorting ( )

Definition at line 512 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                       : string
    {
        return $this->settings->get('dash_def_sort', $this->getSortByLocationMode());
    }

References getSortByLocationMode(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ getDefaultSortingByView()

ilPDSelectedItemsBlockViewSettings::getDefaultSortingByView ( int $view )

Definition at line 220 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                      : string
    {
        $sorting = $this->settings->get('pd_def_sort_view_' . $view, self::SORT_BY_LOCATION);
        if (!in_array($sorting, $this->getAvailableSortOptionsByView($view), true)) {
            return $this->getAvailableSortOptionsByView($view)[0];
        }
        return $sorting;
    }

References getAvailableSortOptionsByView(), and ILIAS\Repository\settings().

Referenced by getEffectiveSortingMode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultView()

ilPDSelectedItemsBlockViewSettings::getDefaultView ( )

Definition at line 407 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                    : int
    {
        return (int) $this->settings->get('personal_items_default_view', (string) $this->getSelectedItemsView());
    }

References getSelectedItemsView(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ getEffectivePresentationMode()

ilPDSelectedItemsBlockViewSettings::getEffectivePresentationMode ( )

Definition at line 425 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                  : string
    {
        $mode = $this->actor->getPref('pd_view_pres_' . $this->currentView);
 
        if (!in_array($mode, $this->getSelectablePresentationModes(), true)) {
            $mode = $this->getDefaultPresentationByView($this->currentView);
        }
 
        return $mode;
    }

References getDefaultPresentationByView(), and getSelectablePresentationModes().

Referenced by parse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEffectiveSortingData()

ilPDSelectedItemsBlockViewSettings::getEffectiveSortingData ( )

Returns: string

Definition at line 580 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                             : ?array
    {
        $mode = $this->getEffectiveSortingMode();
        $key = 'pd_order_data_' . $this->getCurrentView() . '_' . $mode;
        return in_array($mode, self::$has_data, true) ?
            json_decode($this->actor->getPref($key) ?: '[]', true, 2) :
            null;
    }

References getCurrentView(), and getEffectiveSortingMode().

Here is the call graph for this function:

◆ getEffectiveSortingMode()

ilPDSelectedItemsBlockViewSettings::getEffectiveSortingMode ( )

Definition at line 436 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                             : string
    {
        $mode = $this->actor->getPref('pd_order_items_' . $this->currentView);
 
        if (!in_array($mode, $this->getSelectableSortingModes(), true)) {
            $mode = $this->getDefaultSortingByView($this->currentView);
        }
 
        return $mode;
    }

References getDefaultSortingByView(), and getSelectableSortingModes().

Referenced by getEffectiveSortingData(), getEffectiveSortingOptions(), parse(), and storeActorSortingData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEffectiveSortingOptions()

ilPDSelectedItemsBlockViewSettings::getEffectiveSortingOptions ( )

Definition at line 589 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                : array
    {
        return $this->getSortingOptionsByView($this->getCurrentView())[$this->getEffectiveSortingMode()] ?? [];
    }

References getCurrentView(), getEffectiveSortingMode(), and getSortingOptionsByView().

Here is the call graph for this function:

◆ getLearningSequenceView()

ilPDSelectedItemsBlockViewSettings::getLearningSequenceView ( )

Definition at line 150 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                             : int
    {
        return self::VIEW_LEARNING_SEQUENCES;
    }

References ilPDSelectedItemsBlockConstants\VIEW_LEARNING_SEQUENCES.

Referenced by enableView(), and isViewEnabled().

Here is the caller graph for this function:

◆ getListPresentationMode()

ilPDSelectedItemsBlockViewSettings::getListPresentationMode ( )

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

                                             : string
    {
        return self::PRESENTATION_LIST;
    }

References ilPDSelectedItemsBlockConstants\PRESENTATION_LIST.

Referenced by isListPresentation().

Here is the caller graph for this function:

◆ getMembershipsView()

ilPDSelectedItemsBlockViewSettings::getMembershipsView ( )

Definition at line 135 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                        : int
    {
        return self::VIEW_MY_MEMBERSHIPS;
    }

References ilPDSelectedItemsBlockConstants\VIEW_MY_MEMBERSHIPS.

Referenced by enableView(), isMembershipsViewActive(), and isViewEnabled().

Here is the caller graph for this function:

◆ getPresentationViews()

ilPDSelectedItemsBlockViewSettings::getPresentationViews ( )

Returns: int[]

Definition at line 232 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                          : array
    {
        return self::$availableViews;
    }

References $availableViews.

◆ getRecommendedContentView()

ilPDSelectedItemsBlockViewSettings::getRecommendedContentView ( )

Definition at line 155 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                               : int
    {
        return self::VIEW_RECOMMENDED_CONTENT;
    }

References ilPDSelectedItemsBlockConstants\VIEW_RECOMMENDED_CONTENT.

Referenced by enableView(), and isViewEnabled().

Here is the caller graph for this function:

◆ getSelectablePresentationModes()

ilPDSelectedItemsBlockViewSettings::getSelectablePresentationModes ( )

Returns: string[]

Definition at line 461 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                    : array
    {
        if (!$this->access->canChangePresentation($this->actor->getId())) {
            return [$this->getDefaultPresentationByView($this->currentView)];
        }
        return array_intersect(
            $this->getActivePresentationsByView($this->currentView),
            $this->getAvailablePresentationsByView($this->currentView)
        );
    }

References ILIAS\Repository\access(), getActivePresentationsByView(), getAvailablePresentationsByView(), and getDefaultPresentationByView().

Referenced by getEffectivePresentationMode(), and storeActorPresentationMode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSelectableSortingModes()

ilPDSelectedItemsBlockViewSettings::getSelectableSortingModes ( )

Returns: string[]

Definition at line 450 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                               : array
    {
        return array_intersect(
            $this->getActiveSortingsByView($this->currentView),
            $this->getAvailableSortOptionsByView($this->currentView)
        );
    }

References getActiveSortingsByView(), and getAvailableSortOptionsByView().

Referenced by getEffectiveSortingMode(), and storeActorSortingMode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSelectedItemsView()

ilPDSelectedItemsBlockViewSettings::getSelectedItemsView ( )

Definition at line 140 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                          : int
    {
        return self::VIEW_SELECTED_ITEMS;
    }

References ilPDSelectedItemsBlockConstants\VIEW_SELECTED_ITEMS.

Referenced by enableView(), getDefaultView(), isSelectedItemsViewActive(), and isViewEnabled().

Here is the caller graph for this function:

◆ getSortByAlphabetMode()

ilPDSelectedItemsBlockViewSettings::getSortByAlphabetMode ( )

Definition at line 210 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                           : string
    {
        return self::SORT_BY_ALPHABET;
    }

References ilPDSelectedItemsBlockConstants\SORT_BY_ALPHABET.

Referenced by isSortedByAlphabet().

Here is the caller graph for this function:

◆ getSortByLocationMode()

ilPDSelectedItemsBlockViewSettings::getSortByLocationMode ( )

Definition at line 200 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                           : string
    {
        return self::SORT_BY_LOCATION;
    }

References ilPDSelectedItemsBlockConstants\SORT_BY_LOCATION.

Referenced by getDefaultSorting(), and isSortedByLocation().

Here is the caller graph for this function:

◆ getSortByStartDateMode()

ilPDSelectedItemsBlockViewSettings::getSortByStartDateMode ( )

Definition at line 195 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                            : string
    {
        return self::SORT_BY_START_DATE;
    }

References ilPDSelectedItemsBlockConstants\SORT_BY_START_DATE.

Referenced by isSortedByStartDate().

Here is the caller graph for this function:

◆ getSortByTypeMode()

ilPDSelectedItemsBlockViewSettings::getSortByTypeMode ( )

Definition at line 205 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                       : string
    {
        return self::SORT_BY_TYPE;
    }

References ilPDSelectedItemsBlockConstants\SORT_BY_TYPE.

Referenced by isSortedByType().

Here is the caller graph for this function:

◆ getSortingOptionsByView()

ilPDSelectedItemsBlockViewSettings::getSortingOptionsByView ( int $view )

Returns: array<string, array<string, mixed>>

Definition at line 610 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                      : array
    {
        return array_merge(...array_map(fn($sorting) => [
            $sorting => json_decode(
                $this->settings->get('pd_sort_options_' . $view . '_' . $sorting) ?: '[]',
                true,
                2
            ),
        ], self::$has_options));
    }

References ILIAS\Repository\settings().

Referenced by getEffectiveSortingOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStudyProgrammeView()

ilPDSelectedItemsBlockViewSettings::getStudyProgrammeView ( )

Definition at line 145 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                           : int
    {
        return self::VIEW_MY_STUDYPROGRAMME;
    }

References ilPDSelectedItemsBlockConstants\VIEW_MY_STUDYPROGRAMME.

Referenced by enableView(), isStudyProgrammeViewActive(), and isViewEnabled().

Here is the caller graph for this function:

◆ getTilePresentationMode()

ilPDSelectedItemsBlockViewSettings::getTilePresentationMode ( )

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

                                             : string
    {
        return self::PRESENTATION_TILE;
    }

References ilPDSelectedItemsBlockConstants\PRESENTATION_TILE.

Referenced by isTilePresentation().

Here is the caller graph for this function:

◆ getViewName()

ilPDSelectedItemsBlockViewSettings::getViewName ( int $view )

Definition at line 572 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                          : string
    {
        return self::$viewNames[$view];
    }

◆ getViewPositions()

ilPDSelectedItemsBlockViewSettings::getViewPositions ( )

Returns: int[]

Definition at line 329 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                      : array
    {
        $val = $this->settings->get('pd_view_positions', '');
        return (!$val)
            ? self::$availableViews
            : unserialize($val, ['allowed_classes' => false]);
    }

References $availableViews, and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ isLearningSequenceViewActive()

ilPDSelectedItemsBlockViewSettings::isLearningSequenceViewActive ( )

Definition at line 190 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                  : bool
    {
        return $this->currentView === self::VIEW_LEARNING_SEQUENCES;
    }

References ilPDSelectedItemsBlockConstants\VIEW_LEARNING_SEQUENCES.

◆ isListPresentation()

ilPDSelectedItemsBlockViewSettings::isListPresentation ( )

Definition at line 542 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                        : bool
    {
        return $this->currentPresentationOption === $this->getListPresentationMode();
    }

References getListPresentationMode().

Here is the call graph for this function:

◆ isMembershipsViewActive()

ilPDSelectedItemsBlockViewSettings::isMembershipsViewActive ( )

Definition at line 170 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                             : bool
    {
        return $this->currentView === $this->getMembershipsView();
    }

References getMembershipsView().

Here is the call graph for this function:

◆ isRecommendedContentViewActive()

ilPDSelectedItemsBlockViewSettings::isRecommendedContentViewActive ( )

Definition at line 175 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                    : bool
    {
        return $this->currentView === self::VIEW_RECOMMENDED_CONTENT;
    }

References ilPDSelectedItemsBlockConstants\VIEW_RECOMMENDED_CONTENT.

◆ isSelectedItemsViewActive()

ilPDSelectedItemsBlockViewSettings::isSelectedItemsViewActive ( )

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

                                               : bool
    {
        return $this->currentView === $this->getSelectedItemsView();
    }

References getSelectedItemsView().

Here is the call graph for this function:

◆ isSortedByAlphabet()

ilPDSelectedItemsBlockViewSettings::isSortedByAlphabet ( )

Definition at line 522 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                        : bool
    {
        return $this->currentSortOption === $this->getSortByAlphabetMode();
    }

References getSortByAlphabetMode().

Here is the call graph for this function:

◆ isSortedByLocation()

ilPDSelectedItemsBlockViewSettings::isSortedByLocation ( )

Definition at line 527 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                        : bool
    {
        return $this->currentSortOption === $this->getSortByLocationMode();
    }

References getSortByLocationMode().

Here is the call graph for this function:

◆ isSortedByStartDate()

ilPDSelectedItemsBlockViewSettings::isSortedByStartDate ( )

Definition at line 532 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                         : bool
    {
        return $this->currentSortOption === $this->getSortByStartDateMode();
    }

References getSortByStartDateMode().

Here is the call graph for this function:

◆ isSortedByType()

ilPDSelectedItemsBlockViewSettings::isSortedByType ( )

Definition at line 517 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                    : bool
    {
        return $this->currentSortOption === $this->getSortByTypeMode();
    }

References getSortByTypeMode().

Here is the call graph for this function:

◆ isStudyProgrammeViewActive()

ilPDSelectedItemsBlockViewSettings::isStudyProgrammeViewActive ( )

Definition at line 185 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                : bool
    {
        return $this->currentView === $this->getStudyProgrammeView();
    }

References getStudyProgrammeView().

Here is the call graph for this function:

◆ isTilePresentation()

ilPDSelectedItemsBlockViewSettings::isTilePresentation ( )

Definition at line 537 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                        : bool
    {
        return $this->currentPresentationOption === $this->getTilePresentationMode();
    }

References getTilePresentationMode().

Here is the call graph for this function:

◆ isValidView()

ilPDSelectedItemsBlockViewSettings::isValidView ( int $view )

Definition at line 507 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                          : bool
    {
        return in_array($view, $this->validViews, true);
    }

◆ isViewEnabled()

ilPDSelectedItemsBlockViewSettings::isViewEnabled ( int $view )

Definition at line 337 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                            : bool
    {
        switch ($view) {
            case $this->getMembershipsView():
                return $this->enabledMemberships();
            case $this->getSelectedItemsView():
                return $this->enabledSelectedItems();
            case $this->getStudyProgrammeView():
                return $this->enabledStudyProgrammes();
            case $this->getRecommendedContentView():
                return $this->enabledRecommendedContent();
            case $this->getLearningSequenceView():
                return $this->enabledLearningSequences();
            default:
                return false;
        }
    }

References enabledLearningSequences(), enabledMemberships(), enabledRecommendedContent(), enabledSelectedItems(), enabledStudyProgrammes(), getLearningSequenceView(), getMembershipsView(), getRecommendedContentView(), getSelectedItemsView(), and getStudyProgrammeView().

Here is the call graph for this function:

◆ parse()

ilPDSelectedItemsBlockViewSettings::parse ( )

Definition at line 417 of file class.ilPDSelectedItemsBlockViewSettings.php.

                           : void
    {
        $this->validViews = self::$availableViews;
 
        $this->currentSortOption = $this->getEffectiveSortingMode();
        $this->currentPresentationOption = $this->getEffectivePresentationMode();
    }

References $availableViews, getEffectivePresentationMode(), and getEffectiveSortingMode().

Here is the call graph for this function:

◆ setViewPositions()

ilPDSelectedItemsBlockViewSettings::setViewPositions ( array $positions )

Parameters

int[] $positions

Definition at line 321 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                      : void
    {
        $this->settings->set('pd_view_positions', serialize($positions));
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

◆ storeActorPresentationMode()

ilPDSelectedItemsBlockViewSettings::storeActorPresentationMode ( string $presentationMode )

Definition at line 472 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                                        : void
    {
        if (in_array($presentationMode, $this->getSelectablePresentationModes())) {
            $this->actor->writePref(
                'pd_view_pres_' . $this->currentView,
                $presentationMode
            );
        }
    }

References getSelectablePresentationModes().

Here is the call graph for this function:

◆ storeActorSortingData()

ilPDSelectedItemsBlockViewSettings::storeActorSortingData ( array $data )

Definition at line 594 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                      : void
    {
        $mode = $this->getEffectiveSortingMode();
        if (in_array($mode, self::$has_options, true)) {
            $this->actor->writePref('pd_order_data_' . $this->getCurrentView() . '_' . $mode, json_encode($data));
        }
    }

References $data, getCurrentView(), and getEffectiveSortingMode().

Here is the call graph for this function:

◆ storeActorSortingMode()

ilPDSelectedItemsBlockViewSettings::storeActorSortingMode ( string $sortingMode )

Definition at line 482 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                              : void
    {
        if (in_array($sortingMode, $this->getSelectableSortingModes())) {
            $this->actor->writePref(
                'pd_order_items_' . $this->currentView,
                $sortingMode
            );
        }
    }

References getSelectableSortingModes().

Here is the call graph for this function:

◆ storeDefaultView()

ilPDSelectedItemsBlockViewSettings::storeDefaultView ( int $view )

Definition at line 412 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                               : void
    {
        $this->settings->set('personal_items_default_view', (string) $view);
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

◆ storeViewPresentation()

ilPDSelectedItemsBlockViewSettings::storeViewPresentation	(	int	$view,
		string	$default,
		array	$active
	)

Parameters

string[] $active

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

                                                                                    : void
    {
        if (!in_array($default, $active, true)) {
            $active[] = $default;
        }
        $this->settings->set('pd_def_pres_view_' . $view, $default);
        $this->settings->set('pd_active_pres_view_' . $view, serialize($active));
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

◆ storeViewSorting()

ilPDSelectedItemsBlockViewSettings::storeViewSorting	(	int	$view,
		string	$type,
		array	$active
	)

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

                                                                            : void
    {
        if (!in_array($type, $active, true)) {
            $active[] = $type;
        }
 
        assert(in_array($type, $this->getAvailableSortOptionsByView($view), true));
 
        $this->settings->set('pd_def_sort_view_' . $view, $type);
        $this->settings->set('pd_active_sort_view_' . $view, serialize($active));
    }

References getAvailableSortOptionsByView(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ storeViewSortingOptions()

ilPDSelectedItemsBlockViewSettings::storeViewSortingOptions	(	int	$view,
		array	$options
	)

Definition at line 257 of file class.ilPDSelectedItemsBlockViewSettings.php.

                                                                      : void
    {
        foreach ($options as $sorting => $option) {
            if (in_array($sorting, $this->getAvailableSortOptionsByView($view), true)) {
                $this->settings->set(
                    'pd_sort_options_' . $view . '_' . $sorting,
                    json_encode($option)
                );
            }
        }
    }

References getAvailableSortOptionsByView(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Field Documentation

◆ $access

DashboardAccess ilPDSelectedItemsBlockViewSettings::$access

protected

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

◆ $actor

ilObjUser ilPDSelectedItemsBlockViewSettings::$actor

protected

Definition at line 113 of file class.ilPDSelectedItemsBlockViewSettings.php.

Referenced by __construct(), and getActor().

◆ $availablePresentations

array ilPDSelectedItemsBlockViewSettings::$availablePresentations

staticprotected

Initial value:

= [
        self::PRESENTATION_LIST,
        self::PRESENTATION_TILE
    ]

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

◆ $availablePresentationsByView

array ilPDSelectedItemsBlockViewSettings::$availablePresentationsByView

staticprotected

Initial value:

= [
        self::VIEW_SELECTED_ITEMS => [
            self::PRESENTATION_LIST,
            self::PRESENTATION_TILE
        ],
        self::VIEW_RECOMMENDED_CONTENT => [
            self::PRESENTATION_LIST,
            self::PRESENTATION_TILE
        ],
        self::VIEW_MY_MEMBERSHIPS => [
            self::PRESENTATION_LIST,
            self::PRESENTATION_TILE
        ],
        self::VIEW_LEARNING_SEQUENCES => [
            self::PRESENTATION_LIST,
            self::PRESENTATION_TILE
        ],
        self::VIEW_MY_STUDYPROGRAMME => [
            self::PRESENTATION_LIST,
            self::PRESENTATION_TILE
        ],
 
    ]

Definition at line 84 of file class.ilPDSelectedItemsBlockViewSettings.php.

◆ $availableSortOptions

array ilPDSelectedItemsBlockViewSettings::$availableSortOptions

staticprotected

Initial value:

= [
        self::SORT_BY_LOCATION,
        self::SORT_BY_TYPE,
        self::SORT_BY_START_DATE,
        self::SORT_BY_ALPHABET,
    ]

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

◆ $availableSortOptionsByView

array ilPDSelectedItemsBlockViewSettings::$availableSortOptionsByView

staticprotected

Initial value:

= [
        self::VIEW_SELECTED_ITEMS => [
            self::SORT_BY_LOCATION,
            self::SORT_BY_TYPE,
            self::SORT_BY_ALPHABET,
            self::SORT_MANUALLY,
        ],
        self::VIEW_RECOMMENDED_CONTENT => [
            self::SORT_BY_LOCATION,
            self::SORT_BY_TYPE,
            self::SORT_BY_ALPHABET,
        ],
        self::VIEW_MY_MEMBERSHIPS => [
            self::SORT_BY_LOCATION,
            self::SORT_BY_TYPE,
            self::SORT_BY_ALPHABET,
            self::SORT_BY_START_DATE,
            self::SORT_MANUALLY,
        ],
        self::VIEW_LEARNING_SEQUENCES => [
            self::SORT_BY_LOCATION,
            self::SORT_BY_ALPHABET,
        ],
        self::VIEW_MY_STUDYPROGRAMME => [
            self::SORT_BY_LOCATION,
            self::SORT_BY_ALPHABET,
        ],
    ]

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

◆ $availableViews

array ilPDSelectedItemsBlockViewSettings::$availableViews

staticprotected

Initial value:

= [
        self::VIEW_SELECTED_ITEMS,
        self::VIEW_RECOMMENDED_CONTENT,
        self::VIEW_MY_MEMBERSHIPS,
        self::VIEW_LEARNING_SEQUENCES,
        self::VIEW_MY_STUDYPROGRAMME,
    ]

Definition at line 27 of file class.ilPDSelectedItemsBlockViewSettings.php.

Referenced by getPresentationViews(), getViewPositions(), and parse().

◆ $currentPresentationOption

string ilPDSelectedItemsBlockViewSettings::$currentPresentationOption = self::PRESENTATION_LIST

protected

Definition at line 117 of file class.ilPDSelectedItemsBlockViewSettings.php.

◆ $currentSortOption

string ilPDSelectedItemsBlockViewSettings::$currentSortOption = self::SORT_BY_LOCATION

protected

Definition at line 116 of file class.ilPDSelectedItemsBlockViewSettings.php.

Referenced by getCurrentSortOption().

◆ $currentView

int ilPDSelectedItemsBlockViewSettings::$currentView = self::VIEW_SELECTED_ITEMS

protected

Definition at line 115 of file class.ilPDSelectedItemsBlockViewSettings.php.

Referenced by getCurrentView().

◆ $has_data

array ilPDSelectedItemsBlockViewSettings::$has_data = [self::SORT_MANUALLY]

staticprivate

Definition at line 107 of file class.ilPDSelectedItemsBlockViewSettings.php.

◆ $has_options

array ilPDSelectedItemsBlockViewSettings::$has_options = [self::SORT_MANUALLY]

staticprivate

Definition at line 108 of file class.ilPDSelectedItemsBlockViewSettings.php.

◆ $options_by_sortation

array ilPDSelectedItemsBlockViewSettings::$options_by_sortation

staticprivate

Initial value:

= [
        self::SORT_MANUALLY => ['top', 'bot'],
    ]

Definition at line 109 of file class.ilPDSelectedItemsBlockViewSettings.php.

◆ $settings

Setting ilPDSelectedItemsBlockViewSettings::$settings

protected

Definition at line 112 of file class.ilPDSelectedItemsBlockViewSettings.php.

◆ $validViews

array ilPDSelectedItemsBlockViewSettings::$validViews = []

protected

Definition at line 114 of file class.ilPDSelectedItemsBlockViewSettings.php.

◆ $viewNames

array ilPDSelectedItemsBlockViewSettings::$viewNames

staticprotected

Initial value:

= [
        self::VIEW_SELECTED_ITEMS => 'favourites',
        self::VIEW_RECOMMENDED_CONTENT => 'recommended_content',
        self::VIEW_MY_MEMBERSHIPS => 'memberships',
        self::VIEW_LEARNING_SEQUENCES => 'learning_sequences',
        self::VIEW_MY_STUDYPROGRAMME => 'study_programmes',
    ]

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

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

components/ILIAS/Dashboard/ItemsBlock/classes/class.ilPDSelectedItemsBlockViewSettings.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ allViewsDisabled()

◆ allViewsEnabled()

◆ enabledLearningSequences()

◆ enabledMemberships()

◆ enabledRecommendedContent()

◆ enabledSelectedItems()

◆ enabledStudyProgrammes()

◆ enableLearningSequences()

◆ enableMemberships()

◆ enableSelectedItems()

◆ enableStudyProgrammes()

◆ enableView()

◆ getActivePresentationsByView()

◆ getActiveSortingsByView()

◆ getActor()

◆ getAvailableOptionsBySortation()

◆ getAvailablePresentationsByView()

◆ getAvailableSortOptionsByView()

◆ getCurrentSortOption()

◆ getCurrentView()

◆ getDefaultPresentationByView()

◆ getDefaultSorting()

◆ getDefaultSortingByView()

◆ getDefaultView()

◆ getEffectivePresentationMode()

◆ getEffectiveSortingData()

◆ getEffectiveSortingMode()

◆ getEffectiveSortingOptions()

◆ getLearningSequenceView()

◆ getListPresentationMode()

◆ getMembershipsView()

◆ getPresentationViews()

◆ getRecommendedContentView()

◆ getSelectablePresentationModes()

◆ getSelectableSortingModes()

◆ getSelectedItemsView()

◆ getSortByAlphabetMode()

◆ getSortByLocationMode()

◆ getSortByStartDateMode()

◆ getSortByTypeMode()

◆ getSortingOptionsByView()

◆ getStudyProgrammeView()

◆ getTilePresentationMode()

◆ getViewName()

◆ getViewPositions()

◆ isLearningSequenceViewActive()

◆ isListPresentation()

◆ isMembershipsViewActive()

◆ isRecommendedContentViewActive()

◆ isSelectedItemsViewActive()

◆ isSortedByAlphabet()

◆ isSortedByLocation()

◆ isSortedByStartDate()

◆ isSortedByType()

◆ isStudyProgrammeViewActive()

◆ isTilePresentation()

◆ isValidView()

◆ isViewEnabled()

◆ parse()

◆ setViewPositions()

◆ storeActorPresentationMode()

◆ storeActorSortingData()

◆ storeActorSortingMode()

◆ storeDefaultView()

◆ storeViewPresentation()

◆ storeViewSorting()

◆ storeViewSortingOptions()

Field Documentation

◆ $access

◆ $actor