class.ilPDSelectedItemsBlockViewSettings.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2017 ILIAS open source, Extended GPL, see docs/LICENSE */
 
require_once 'Services/PersonalDesktop/ItemsBlock/interfaces/interface.ilPDSelectedItemsBlockConstants.php';
 
class ilPDSelectedItemsBlockViewSettings implements ilPDSelectedItemsBlockConstants
{
    protected static $availableViews = array(
        self::VIEW_SELECTED_ITEMS,
        self::VIEW_MY_MEMBERSHIPS,
        self::VIEW_MY_STUDYPROGRAMME
    );
 
    protected static $availableSortOptions = array(
        self::SORT_BY_LOCATION,
        self::SORT_BY_TYPE,
        self::SORT_BY_START_DATE
    );
 
    protected static $availableSortOptionsByView = 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(
        )
    );
 
    protected $settings;
 
    protected $actor;
 
    protected $validViews = array();
 
    protected $currentView = self::VIEW_SELECTED_ITEMS;
 
    protected $currentSortOption = self::SORT_BY_LOCATION;
 
    public function __construct($actor, $view = self::VIEW_SELECTED_ITEMS)
    {
        global $DIC;
 
        $ilSetting = $DIC->settings();
 
        $this->settings = $ilSetting;
 
        $this->actor       = $actor;
        $this->currentView = $view;
    }
 
    public function getMembershipsView()
    {
        return self::VIEW_MY_MEMBERSHIPS;
    }
 
    public function getSelectedItemsView()
    {
        return self::VIEW_SELECTED_ITEMS;
    }
 
    public function getStudyProgrammeView()
    {
        return self::VIEW_MY_STUDYPROGRAMME;
    }
 
    public function isMembershipsViewActive()
    {
        return $this->currentView == $this->getMembershipsView();
    }
 
    public function isSelectedItemsViewActive()
    {
        return $this->currentView == $this->getSelectedItemsView();
    }
 
    public function isStudyProgrammeViewActive()
    {
        return $this->currentView == $this->getStudyProgrammeView();
    }
 
    public function getSortByStartDateMode()
    {
        return self::SORT_BY_START_DATE;
    }
 
    public function getSortByLocationMode()
    {
        return self::SORT_BY_LOCATION;
    }
 
    public function getSortByTypeMode()
    {
        return self::SORT_BY_TYPE;
    }
 
    public function getDefaultSortType()
    {
        return $this->settings->get('my_memberships_def_sort', $this->getSortByLocationMode());
    }
 
    public function isSortedByType()
    {
        return $this->currentSortOption == $this->getSortByTypeMode();
    }
 
    public function isSortedByLocation()
    {
        return $this->currentSortOption == $this->getSortByLocationMode();
    }
 
    public function isSortedByStartDate()
    {
        return $this->currentSortOption == $this->getSortByStartDateMode();
    }
 
    public function storeDefaultSortType($type)
    {
        assert(in_array($type, self::$availableSortOptions));
        $this->settings->set('my_memberships_def_sort', $type);
    }
 
    public function enabledMemberships()
    {
        return $this->settings->get('disable_my_memberships', 0) == 0;
    }
 
    public function enabledSelectedItems()
    {
        return $this->settings->get('disable_my_offers', 0) == 0;
    }
 
    public function enableMemberships($status)
    {
        $this->settings->set('disable_my_memberships', (int) !$status);
    }
 
    public function enableSelectedItems($status)
    {
        $this->settings->set('disable_my_offers', (int) !$status);
    }
 
    public function allViewsEnabled()
    {
        return $this->enabledMemberships() && $this->enabledSelectedItems();
    }
 
    protected function allViewsDisabled()
    {
        return !$this->enabledMemberships() && !$this->enabledSelectedItems();
    }
 
    public function getDefaultView()
    {
        return (int) $this->settings->get('personal_items_default_view', $this->getSelectedItemsView());
    }
 
    public function storeDefaultView($view)
    {
        assert(in_array($view, self::$availableViews));
        $this->settings->set('personal_items_default_view', $view);
    }
 
    public function parse()
    {
        $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();
            }
        }
    }
 
    public function getActor()
    {
        return $this->actor;
    }
 
    public function getCurrentView()
    {
        return $this->currentView;
    }
 
    public function getCurrentSortOption()
    {
        return $this->currentSortOption;
    }
 
    public function isValidView($view)
    {
        return in_array($view, $this->validViews);
    }
}