Class ilPDSelectedItemsBlockViewSettings. More...

Inheritance diagram for ilPDSelectedItemsBlockViewSettings:

Collaboration diagram for ilPDSelectedItemsBlockViewSettings:

Public Member Functions
	__construct ($actor, $view=self::VIEW_SELECTED_ITEMS)
	ilPDSelectedItemsBlockViewSettings constructor. More...

	getMembershipsView ()

	getSelectedItemsView ()

	getStudyProgrammeView ()

	isMembershipsViewActive ()

	isSelectedItemsViewActive ()

	isStudyProgrammeViewActive ()

	getSortByStartDateMode ()

	getSortByLocationMode ()

	getSortByTypeMode ()

	getDefaultSortType ()

	isSortedByType ()

	isSortedByLocation ()

	isSortedByStartDate ()

	storeDefaultSortType ($type)

	enabledMemberships ()

	enabledSelectedItems ()

	enableMemberships ($status)

	enableSelectedItems ($status)

	allViewsEnabled ()

	getDefaultView ()

	storeDefaultView ($view)

	parse ()

	getActor ()

	getCurrentView ()

	getCurrentSortOption ()

	isValidView ($view)

Protected Member Functions
	allViewsDisabled ()

Protected Attributes
	$settings

	$actor

	$validViews = array()

	$currentView = self::VIEW_SELECTED_ITEMS

	$currentSortOption = self::SORT_BY_LOCATION

Static Protected Attributes
static	$availableViews

static	$availableSortOptions

static	$availableSortOptionsByView

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

const	VIEW_MY_MEMBERSHIPS = 1

const	VIEW_MY_STUDYPROGRAMME = 2

const	SORT_BY_TYPE = 'type'

const	SORT_BY_LOCATION = 'location'

const	SORT_BY_START_DATE = 'start_date'

Detailed Description

Class ilPDSelectedItemsBlockViewSettings.

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

Constructor & Destructor Documentation

◆ __construct()

ilPDSelectedItemsBlockViewSettings::__construct	(	$actor,
		$view = `self::VIEW_SELECTED_ITEMS`
	)

ilPDSelectedItemsBlockViewSettings constructor.

Parameters

ilObjUser	$actor
int	$view

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

References $actor, $DIC, $ilSetting, and settings().

     {
         global $DIC;
 
         $ilSetting = $DIC->settings();
 
         $this->settings = $ilSetting;
 
         $this->actor       = $actor;
         $this->currentView = $view;
     }

Here is the call graph for this function:

Member Function Documentation

◆ allViewsDisabled()

ilPDSelectedItemsBlockViewSettings::allViewsDisabled ( )

protected

Returns: boolean

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

References enabledMemberships(), and enabledSelectedItems().

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

Here is the call graph for this function:

◆ allViewsEnabled()

ilPDSelectedItemsBlockViewSettings::allViewsEnabled ( )

Returns: boolean

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

References enabledMemberships(), and enabledSelectedItems().

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

Here is the call graph for this function:

◆ enabledMemberships()

ilPDSelectedItemsBlockViewSettings::enabledMemberships ( )

Returns: boolean

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

References settings().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enabledSelectedItems()

ilPDSelectedItemsBlockViewSettings::enabledSelectedItems ( )

Returns: boolean

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

References settings().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableMemberships()

ilPDSelectedItemsBlockViewSettings::enableMemberships ( $status )

Parameters

$status boolean

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

References settings().

     {
         $this->settings->set('disable_my_memberships', (int) !$status);
     }

Here is the call graph for this function:

◆ enableSelectedItems()

ilPDSelectedItemsBlockViewSettings::enableSelectedItems ( $status )

Parameters

$status boolean

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

References settings().

     {
         $this->settings->set('disable_my_offers', (int) !$status);
     }

Here is the call graph for this function:

◆ getActor()

ilPDSelectedItemsBlockViewSettings::getActor ( )

Returns: ilObjUser

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

References $actor.

Referenced by ilPDSelectedItemsBlockViewGUI\bySettings().

     {
         return $this->actor;
     }

Here is the caller graph for this function:

◆ getCurrentSortOption()

ilPDSelectedItemsBlockViewSettings::getCurrentSortOption ( )

Returns: int

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

References $currentSortOption.

     {
         return $this->currentSortOption;
     }

◆ getCurrentView()

ilPDSelectedItemsBlockViewSettings::getCurrentView ( )

Returns: int

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

References $currentView.

Referenced by parse().

     {
         return $this->currentView;
     }

Here is the caller graph for this function:

◆ getDefaultSortType()

ilPDSelectedItemsBlockViewSettings::getDefaultSortType ( )

Returns: string

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

References getSortByLocationMode(), and settings().

Referenced by parse().

     {
         return $this->settings->get('my_memberships_def_sort', $this->getSortByLocationMode());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultView()

ilPDSelectedItemsBlockViewSettings::getDefaultView ( )

Returns: int

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

References getSelectedItemsView(), and settings().

Referenced by parse().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMembershipsView()

ilPDSelectedItemsBlockViewSettings::getMembershipsView ( )

Returns: int

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

Referenced by isMembershipsViewActive(), and parse().

     {
         return self::VIEW_MY_MEMBERSHIPS;
     }

Here is the caller graph for this function:

◆ getSelectedItemsView()

ilPDSelectedItemsBlockViewSettings::getSelectedItemsView ( )

Returns: int

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

Referenced by getDefaultView(), isSelectedItemsViewActive(), and parse().

     {
         return self::VIEW_SELECTED_ITEMS;
     }

Here is the caller graph for this function:

◆ getSortByLocationMode()

ilPDSelectedItemsBlockViewSettings::getSortByLocationMode ( )

Returns: string

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

Referenced by getDefaultSortType(), and isSortedByLocation().

     {
         return self::SORT_BY_LOCATION;
     }

Here is the caller graph for this function:

◆ getSortByStartDateMode()

ilPDSelectedItemsBlockViewSettings::getSortByStartDateMode ( )

Returns: string

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

Referenced by isSortedByStartDate().

     {
         return self::SORT_BY_START_DATE;
     }

Here is the caller graph for this function:

◆ getSortByTypeMode()

ilPDSelectedItemsBlockViewSettings::getSortByTypeMode ( )

Returns: string

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

Referenced by isSortedByType().

     {
         return self::SORT_BY_TYPE;
     }

Here is the caller graph for this function:

◆ getStudyProgrammeView()

ilPDSelectedItemsBlockViewSettings::getStudyProgrammeView ( )

Returns: int

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

Referenced by isStudyProgrammeViewActive().

     {
         return self::VIEW_MY_STUDYPROGRAMME;
     }

Here is the caller graph for this function:

◆ isMembershipsViewActive()

ilPDSelectedItemsBlockViewSettings::isMembershipsViewActive ( )

Returns: boolean

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

References getMembershipsView().

Referenced by ilPDSelectedItemsBlockViewGUI\bySettings().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSelectedItemsViewActive()

ilPDSelectedItemsBlockViewSettings::isSelectedItemsViewActive ( )

Returns: boolean

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

References getSelectedItemsView().

Referenced by parse().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSortedByLocation()

ilPDSelectedItemsBlockViewSettings::isSortedByLocation ( )

Returns: boolean

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

References getSortByLocationMode().

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

Here is the call graph for this function:

◆ isSortedByStartDate()

ilPDSelectedItemsBlockViewSettings::isSortedByStartDate ( )

Returns: boolean

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

References getSortByStartDateMode().

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

Here is the call graph for this function:

◆ isSortedByType()

ilPDSelectedItemsBlockViewSettings::isSortedByType ( )

Returns: boolean

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

References getSortByTypeMode().

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

Here is the call graph for this function:

◆ isStudyProgrammeViewActive()

ilPDSelectedItemsBlockViewSettings::isStudyProgrammeViewActive ( )

Returns: boolean

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

References getStudyProgrammeView().

Referenced by parse().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValidView()

ilPDSelectedItemsBlockViewSettings::isValidView ( $view )

Parameters

string $view

Returns: boolean

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

Referenced by parse().

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

Here is the caller graph for this function:

◆ parse()

ilPDSelectedItemsBlockViewSettings::parse ( )

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

References $key, enabledMemberships(), enabledSelectedItems(), getCurrentView(), getDefaultSortType(), getDefaultView(), getMembershipsView(), getSelectedItemsView(), isSelectedItemsViewActive(), isStudyProgrammeViewActive(), isValidView(), and storeDefaultView().

     {
         $this->validViews = self::$availableViews;
 
         foreach (array_filter([
             $this->getMembershipsView()   => !$this->enabledMemberships(),
             $this->getSelectedItemsView() => !$this->enabledSelectedItems()
         ]) as $viewId => $status) {
             $key = array_search($viewId, $this->validViews);
             if ($key !== false) {
                 unset($this->validViews[$key]);
             }
         }
 
         if (count($this->validViews) == 1) {
             $this->storeDefaultView($this->getSelectedItemsView());
             $this->validViews[] = $this->getSelectedItemsView();
         }
 
         if (!$this->isValidView($this->getCurrentView())) {
             $this->currentView = $this->getDefaultView();
         }
 
         $this->currentSortOption = $this->actor->getPref('pd_order_items');
         if (!in_array($this->currentSortOption, self::$availableSortOptionsByView[$this->currentView])) {
             if ($this->isSelectedItemsViewActive()) {
                 $this->currentSortOption = self::SORT_BY_LOCATION;
             } elseif ($this->isStudyProgrammeViewActive()) {
                 $this->currentSortOption = $this->getDefaultSortType();
             }
         }
     }

Here is the call graph for this function:

◆ storeDefaultSortType()

ilPDSelectedItemsBlockViewSettings::storeDefaultSortType ( $type )

Parameters

string $type

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

References $type, and settings().

     {
         assert(in_array($type, self::$availableSortOptions));
         $this->settings->set('my_memberships_def_sort', $type);
     }

Here is the call graph for this function:

◆ storeDefaultView()

ilPDSelectedItemsBlockViewSettings::storeDefaultView ( $view )

Parameters

$view int

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

References settings().

Referenced by parse().

     {
         assert(in_array($view, self::$availableViews));
         $this->settings->set('personal_items_default_view', $view);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $actor

ilPDSelectedItemsBlockViewSettings::$actor

protected

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

Referenced by __construct(), and getActor().

◆ $availableSortOptions

ilPDSelectedItemsBlockViewSettings::$availableSortOptions

staticprotected

Initial value:

= array(
        self::SORT_BY_LOCATION,
        self::SORT_BY_TYPE,
        self::SORT_BY_START_DATE
    )

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

◆ $availableSortOptionsByView

ilPDSelectedItemsBlockViewSettings::$availableSortOptionsByView

staticprotected

Initial value:

= array(
        self::VIEW_SELECTED_ITEMS => array(
            self::SORT_BY_LOCATION,
            self::SORT_BY_TYPE
        ),
        self::VIEW_MY_MEMBERSHIPS => array(
            self::SORT_BY_LOCATION,
            self::SORT_BY_TYPE,
            self::SORT_BY_START_DATE
        ),
        self::VIEW_MY_STUDYPROGRAMME => array(
        )
    )

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

◆ $availableViews

ilPDSelectedItemsBlockViewSettings::$availableViews

staticprotected

Initial value:

= array(
        self::VIEW_SELECTED_ITEMS,
        self::VIEW_MY_MEMBERSHIPS,
        self::VIEW_MY_STUDYPROGRAMME
    )

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

◆ $currentSortOption

ilPDSelectedItemsBlockViewSettings::$currentSortOption = self::SORT_BY_LOCATION

protected

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

Referenced by getCurrentSortOption().

◆ $currentView

ilPDSelectedItemsBlockViewSettings::$currentView = self::VIEW_SELECTED_ITEMS

protected

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

Referenced by getCurrentView().

◆ $settings

ilPDSelectedItemsBlockViewSettings::$settings

protected

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

◆ $validViews

ilPDSelectedItemsBlockViewSettings::$validViews = array()

protected

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

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

Services/PersonalDesktop/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()

◆ enabledMemberships()

◆ enabledSelectedItems()

◆ enableMemberships()

◆ enableSelectedItems()

◆ getActor()

◆ getCurrentSortOption()

◆ getCurrentView()

◆ getDefaultSortType()

◆ getDefaultView()

◆ getMembershipsView()

◆ getSelectedItemsView()

◆ getSortByLocationMode()

◆ getSortByStartDateMode()

◆ getSortByTypeMode()

◆ getStudyProgrammeView()

◆ isMembershipsViewActive()

◆ isSelectedItemsViewActive()

◆ isSortedByLocation()

◆ isSortedByStartDate()

◆ isSortedByType()

◆ isStudyProgrammeViewActive()

◆ isValidView()

◆ parse()

◆ storeDefaultSortType()

◆ storeDefaultView()

Field Documentation

◆ $actor

◆ $availableSortOptions

◆ $availableSortOptionsByView

◆ $availableViews

◆ $currentSortOption

◆ $currentView

◆ $settings

◆ $validViews