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)

	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)

Protected Member Functions
	allViewsDisabled ()

Protected Attributes
static array 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

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	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 113 of file class.ilPDSelectedItemsBlockViewSettings.php.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ allViewsDisabled()

ilPDSelectedItemsBlockViewSettings::allViewsDisabled ( )

protected

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

References enabledMemberships(), and enabledSelectedItems().

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

Here is the call graph for this function:

◆ allViewsEnabled()

ilPDSelectedItemsBlockViewSettings::allViewsEnabled ( )

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

References enabledMemberships(), and enabledSelectedItems().

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

Here is the call graph for this function:

◆ enabledLearningSequences()

ilPDSelectedItemsBlockViewSettings::enabledLearningSequences ( )

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

References ILIAS\Repository\settings().

Referenced by isViewEnabled().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enabledMemberships()

ilPDSelectedItemsBlockViewSettings::enabledMemberships ( )

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

References ILIAS\Repository\settings().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enabledRecommendedContent()

ilPDSelectedItemsBlockViewSettings::enabledRecommendedContent ( )

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

Referenced by isViewEnabled().

                                                : bool
     {
         return true;
     }

Here is the caller graph for this function:

◆ enabledSelectedItems()

ilPDSelectedItemsBlockViewSettings::enabledSelectedItems ( )

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

References ILIAS\Repository\settings().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enabledStudyProgrammes()

ilPDSelectedItemsBlockViewSettings::enabledStudyProgrammes ( )

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

References ILIAS\Repository\settings().

Referenced by isViewEnabled().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableLearningSequences()

ilPDSelectedItemsBlockViewSettings::enableLearningSequences ( bool $status )

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

References ILIAS\Repository\settings().

Referenced by enableView().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableMemberships()

ilPDSelectedItemsBlockViewSettings::enableMemberships ( bool $status )

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

References ILIAS\Repository\settings().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableSelectedItems()

ilPDSelectedItemsBlockViewSettings::enableSelectedItems ( bool $status )

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

References ILIAS\Repository\settings().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableStudyProgrammes()

ilPDSelectedItemsBlockViewSettings::enableStudyProgrammes ( bool $status )

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

References ILIAS\Repository\settings().

Referenced by enableView().

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

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 337 of file class.ilPDSelectedItemsBlockViewSettings.php.

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

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

Here is the call graph for this function:

◆ getActivePresentationsByView()

ilPDSelectedItemsBlockViewSettings::getActivePresentationsByView ( int $view )

Returns: string[]

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

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

Referenced by getSelectablePresentationModes().

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

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 253 of file class.ilPDSelectedItemsBlockViewSettings.php.

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

Referenced by getSelectableSortingModes().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActor()

ilPDSelectedItemsBlockViewSettings::getActor ( )

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

References $actor.

                               : ilObjUser
     {
         return $this->actor;
     }

◆ getAvailablePresentationsByView()

ilPDSelectedItemsBlockViewSettings::getAvailablePresentationsByView ( int $view )

Returns: string[]

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

Referenced by getActivePresentationsByView(), and getSelectablePresentationModes().

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

Here is the caller graph for this function:

◆ getAvailableSortOptionsByView()

ilPDSelectedItemsBlockViewSettings::getAvailableSortOptionsByView ( int $view )

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

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

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

Here is the caller graph for this function:

◆ getCurrentSortOption()

ilPDSelectedItemsBlockViewSettings::getCurrentSortOption ( )

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

References $currentSortOption.

                                           : string
     {
         return $this->currentSortOption;
     }

◆ getCurrentView()

ilPDSelectedItemsBlockViewSettings::getCurrentView ( )

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

References $currentView.

                                     : int
     {
         return $this->currentView;
     }

◆ getDefaultPresentationByView()

ilPDSelectedItemsBlockViewSettings::getDefaultPresentationByView ( int $view )

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

References ILIAS\Repository\settings().

Referenced by getEffectivePresentationMode(), and getSelectablePresentationModes().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultSorting()

ilPDSelectedItemsBlockViewSettings::getDefaultSorting ( )

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

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

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

Here is the call graph for this function:

◆ getDefaultSortingByView()

ilPDSelectedItemsBlockViewSettings::getDefaultSortingByView ( int $view )

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

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

Referenced by getEffectiveSortingMode().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultView()

ilPDSelectedItemsBlockViewSettings::getDefaultView ( )

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

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

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

Here is the call graph for this function:

◆ getEffectivePresentationMode()

ilPDSelectedItemsBlockViewSettings::getEffectivePresentationMode ( )

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

References getDefaultPresentationByView(), and getSelectablePresentationModes().

Referenced by parse().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEffectiveSortingMode()

ilPDSelectedItemsBlockViewSettings::getEffectiveSortingMode ( )

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

References getDefaultSortingByView(), and getSelectableSortingModes().

Referenced by parse().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLearningSequenceView()

ilPDSelectedItemsBlockViewSettings::getLearningSequenceView ( )

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

Referenced by enableView(), and isViewEnabled().

                                              : int
     {
         return self::VIEW_LEARNING_SEQUENCES;
     }

Here is the caller graph for this function:

◆ getListPresentationMode()

ilPDSelectedItemsBlockViewSettings::getListPresentationMode ( )

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

Referenced by isListPresentation().

                                              : string
     {
         return self::PRESENTATION_LIST;
     }

Here is the caller graph for this function:

◆ getMembershipsView()

ilPDSelectedItemsBlockViewSettings::getMembershipsView ( )

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

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

                                         : int
     {
         return self::VIEW_MY_MEMBERSHIPS;
     }

Here is the caller graph for this function:

◆ getPresentationViews()

ilPDSelectedItemsBlockViewSettings::getPresentationViews ( )

Returns: int[]

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

                                           : array
     {
         return self::$availableViews;
     }

◆ getRecommendedContentView()

ilPDSelectedItemsBlockViewSettings::getRecommendedContentView ( )

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

Referenced by enableView(), and isViewEnabled().

                                                : int
     {
         return self::VIEW_RECOMMENDED_CONTENT;
     }

Here is the caller graph for this function:

◆ getSelectablePresentationModes()

ilPDSelectedItemsBlockViewSettings::getSelectablePresentationModes ( )

Returns: string[]

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

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

Referenced by getEffectivePresentationMode(), and storeActorPresentationMode().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSelectableSortingModes()

ilPDSelectedItemsBlockViewSettings::getSelectableSortingModes ( )

Returns: string[]

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

References getActiveSortingsByView(), and getAvailableSortOptionsByView().

Referenced by getEffectiveSortingMode(), and storeActorSortingMode().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSelectedItemsView()

ilPDSelectedItemsBlockViewSettings::getSelectedItemsView ( )

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

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

                                           : int
     {
         return self::VIEW_SELECTED_ITEMS;
     }

Here is the caller graph for this function:

◆ getSortByAlphabetMode()

ilPDSelectedItemsBlockViewSettings::getSortByAlphabetMode ( )

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

Referenced by isSortedByAlphabet().

                                            : string
     {
         return self::SORT_BY_ALPHABET;
     }

Here is the caller graph for this function:

◆ getSortByLocationMode()

ilPDSelectedItemsBlockViewSettings::getSortByLocationMode ( )

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

Referenced by getDefaultSorting(), and isSortedByLocation().

                                            : string
     {
         return self::SORT_BY_LOCATION;
     }

Here is the caller graph for this function:

◆ getSortByStartDateMode()

ilPDSelectedItemsBlockViewSettings::getSortByStartDateMode ( )

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

Referenced by isSortedByStartDate().

                                             : string
     {
         return self::SORT_BY_START_DATE;
     }

Here is the caller graph for this function:

◆ getSortByTypeMode()

ilPDSelectedItemsBlockViewSettings::getSortByTypeMode ( )

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

Referenced by isSortedByType().

                                        : string
     {
         return self::SORT_BY_TYPE;
     }

Here is the caller graph for this function:

◆ getStudyProgrammeView()

ilPDSelectedItemsBlockViewSettings::getStudyProgrammeView ( )

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

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

                                            : int
     {
         return self::VIEW_MY_STUDYPROGRAMME;
     }

Here is the caller graph for this function:

◆ getTilePresentationMode()

ilPDSelectedItemsBlockViewSettings::getTilePresentationMode ( )

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

Referenced by isTilePresentation().

                                              : string
     {
         return self::PRESENTATION_TILE;
     }

Here is the caller graph for this function:

◆ getViewName()

ilPDSelectedItemsBlockViewSettings::getViewName ( int $view )

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

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

◆ getViewPositions()

ilPDSelectedItemsBlockViewSettings::getViewPositions ( )

Returns: int[]

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

References ILIAS\Repository\settings().

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

Here is the call graph for this function:

◆ isLearningSequenceViewActive()

ilPDSelectedItemsBlockViewSettings::isLearningSequenceViewActive ( )

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

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

◆ isListPresentation()

ilPDSelectedItemsBlockViewSettings::isListPresentation ( )

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

References getListPresentationMode().

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

Here is the call graph for this function:

◆ isMembershipsViewActive()

ilPDSelectedItemsBlockViewSettings::isMembershipsViewActive ( )

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

References getMembershipsView().

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

Here is the call graph for this function:

◆ isRecommendedContentViewActive()

ilPDSelectedItemsBlockViewSettings::isRecommendedContentViewActive ( )

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

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

◆ isSelectedItemsViewActive()

ilPDSelectedItemsBlockViewSettings::isSelectedItemsViewActive ( )

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

References getSelectedItemsView().

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

Here is the call graph for this function:

◆ isSortedByAlphabet()

ilPDSelectedItemsBlockViewSettings::isSortedByAlphabet ( )

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

References getSortByAlphabetMode().

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

Here is the call graph for this function:

◆ isSortedByLocation()

ilPDSelectedItemsBlockViewSettings::isSortedByLocation ( )

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

References getSortByLocationMode().

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

Here is the call graph for this function:

◆ isSortedByStartDate()

ilPDSelectedItemsBlockViewSettings::isSortedByStartDate ( )

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

References getSortByStartDateMode().

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

Here is the call graph for this function:

◆ isSortedByType()

ilPDSelectedItemsBlockViewSettings::isSortedByType ( )

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

References getSortByTypeMode().

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

Here is the call graph for this function:

◆ isStudyProgrammeViewActive()

ilPDSelectedItemsBlockViewSettings::isStudyProgrammeViewActive ( )

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

References getStudyProgrammeView().

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

Here is the call graph for this function:

◆ isTilePresentation()

ilPDSelectedItemsBlockViewSettings::isTilePresentation ( )

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

References getTilePresentationMode().

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

Here is the call graph for this function:

◆ isValidView()

ilPDSelectedItemsBlockViewSettings::isValidView ( int $view )

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

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

◆ isViewEnabled()

ilPDSelectedItemsBlockViewSettings::isViewEnabled ( int $view )

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

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

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

Here is the call graph for this function:

◆ parse()

ilPDSelectedItemsBlockViewSettings::parse ( )

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

References getEffectivePresentationMode(), and getEffectiveSortingMode().

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

Here is the call graph for this function:

◆ setViewPositions()

ilPDSelectedItemsBlockViewSettings::setViewPositions ( array $positions )

Parameters

int[] $positions

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

References ILIAS\Repository\settings().

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

Here is the call graph for this function:

◆ storeActorPresentationMode()

ilPDSelectedItemsBlockViewSettings::storeActorPresentationMode ( string $presentationMode )

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

References getSelectablePresentationModes().

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

Here is the call graph for this function:

◆ storeActorSortingMode()

ilPDSelectedItemsBlockViewSettings::storeActorSortingMode ( string $sortingMode )

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

References getSelectableSortingModes().

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

Here is the call graph for this function:

◆ storeDefaultView()

ilPDSelectedItemsBlockViewSettings::storeDefaultView ( int $view )

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

References ILIAS\Repository\settings().

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

Here is the call graph for this function:

◆ storeViewPresentation()

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

Parameters

string[] $active

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

References ILIAS\Repository\settings().

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

Here is the call graph for this function:

◆ storeViewSorting()

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

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

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

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

Here is the call graph for this function:

Field Documentation

◆ $access

DashboardAccess ilPDSelectedItemsBlockViewSettings::$access

protected

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

◆ $actor

ilObjUser ilPDSelectedItemsBlockViewSettings::$actor

protected

Definition at line 106 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
        ]

Definition at line 82 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,
        ]

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.

◆ $currentPresentationOption

string ilPDSelectedItemsBlockViewSettings::$currentPresentationOption = self::PRESENTATION_LIST

protected

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

◆ $currentSortOption

string ilPDSelectedItemsBlockViewSettings::$currentSortOption = self::SORT_BY_LOCATION

protected

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

Referenced by getCurrentSortOption().

◆ $currentView

int ilPDSelectedItemsBlockViewSettings::$currentView = self::VIEW_SELECTED_ITEMS

protected

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

Referenced by getCurrentView().

◆ $settings

array Setting ilPDSelectedItemsBlockViewSettings::$settings

protected

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

◆ $validViews

array ilPDSelectedItemsBlockViewSettings::$validViews = []

protected

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

◆ $viewNames

array ilPDSelectedItemsBlockViewSettings::$viewNames

staticprotected

Initial value:

= [

self::VIEW_SELECTED_ITEMS => 'favourites'

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

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()

◆ getAvailablePresentationsByView()

◆ getAvailableSortOptionsByView()

◆ getCurrentSortOption()

◆ getCurrentView()

◆ getDefaultPresentationByView()

◆ getDefaultSorting()

◆ getDefaultSortingByView()

◆ getDefaultView()

◆ getEffectivePresentationMode()

◆ getEffectiveSortingMode()

◆ getLearningSequenceView()

◆ getListPresentationMode()

◆ getMembershipsView()

◆ getPresentationViews()

◆ getRecommendedContentView()

◆ getSelectablePresentationModes()

◆ getSelectableSortingModes()

◆ getSelectedItemsView()

◆ getSortByAlphabetMode()

◆ getSortByLocationMode()

◆ getSortByStartDateMode()

◆ getSortByTypeMode()

◆ getStudyProgrammeView()

◆ getTilePresentationMode()

◆ getViewName()

◆ getViewPositions()

◆ isLearningSequenceViewActive()

◆ isListPresentation()

◆ isMembershipsViewActive()

◆ isRecommendedContentViewActive()

◆ isSelectedItemsViewActive()

◆ isSortedByAlphabet()

◆ isSortedByLocation()

◆ isSortedByStartDate()

◆ isSortedByType()

◆ isStudyProgrammeViewActive()

◆ isTilePresentation()

◆ isValidView()

◆ isViewEnabled()

◆ parse()

◆ setViewPositions()

◆ storeActorPresentationMode()

◆ storeActorSortingMode()

◆ storeDefaultView()

◆ storeViewPresentation()

◆ storeViewSorting()

Field Documentation

◆ $access

◆ $actor

◆ $availablePresentations

◆ $availablePresentationsByView

◆ $availableSortOptions

◆ $availableSortOptionsByView

◆ $availableViews

◆ $currentPresentationOption

◆ $currentSortOption