class.ilPDSelectedItemsBlockViewSettings.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2017 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilPDSelectedItemsBlockViewSettings implements ilPDSelectedItemsBlockConstants
{
    protected static $availableViews = [
        self::VIEW_SELECTED_ITEMS,
        self::VIEW_MY_MEMBERSHIPS,
        self::VIEW_MY_STUDYPROGRAMME
    ];

    protected static $availableSortOptions = [
        self::SORT_BY_LOCATION,
        self::SORT_BY_TYPE,
        self::SORT_BY_START_DATE
    ];

    protected static $availablePresentations = [
        self::PRESENTATION_LIST,
        self::PRESENTATION_TILE
    ];

    protected static $availableSortOptionsByView = [
        self::VIEW_SELECTED_ITEMS => [
            self::SORT_BY_LOCATION,
            self::SORT_BY_TYPE
        ],
        self::VIEW_MY_MEMBERSHIPS => [
            self::SORT_BY_LOCATION,
            self::SORT_BY_TYPE,
            self::SORT_BY_START_DATE
        ],
        self::VIEW_MY_STUDYPROGRAMME => []
    ];

    protected static $availablePresentationsByView = [
        self::VIEW_SELECTED_ITEMS => [
            self::PRESENTATION_LIST,
            self::PRESENTATION_TILE
        ],
        self::VIEW_MY_MEMBERSHIPS => [
            self::PRESENTATION_LIST,
            self::PRESENTATION_TILE
        ],
        self::VIEW_MY_STUDYPROGRAMME => []
    ];

    protected $settings;

    protected $actor;

    protected $validViews = [];

    protected $currentView = self::VIEW_SELECTED_ITEMS;

    protected $currentSortOption = self::SORT_BY_LOCATION;

    protected $currentPresentationOption = self::PRESENTATION_LIST;

    protected $access;

    public function __construct(ilObjUser $actor, int $view = self::VIEW_SELECTED_ITEMS)
    {
        global $DIC;

        $ilSetting = $DIC->settings();

        $this->settings = $ilSetting;

        $this->actor = $actor;
        $this->currentView = $view;
        $this->access = new \ILIAS\Dashboard\Access\DashboardAccess();
    }

    public function getMembershipsView() : int
    {
        return self::VIEW_MY_MEMBERSHIPS;
    }

    public function getSelectedItemsView() : int
    {
        return self::VIEW_SELECTED_ITEMS;
    }

    public function getStudyProgrammeView() : int
    {
        return self::VIEW_MY_STUDYPROGRAMME;
    }

    public function getListPresentationMode() : string
    {
        return self::PRESENTATION_LIST;
    }

    public function getTilePresentationMode() : string
    {
        return self::PRESENTATION_TILE;
    }

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

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

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

    public function getSortByStartDateMode() : string
    {
        return self::SORT_BY_START_DATE;
    }

    public function getSortByLocationMode() : string
    {
        return self::SORT_BY_LOCATION;
    }

    public function getSortByTypeMode() : string
    {
        return self::SORT_BY_TYPE;
    }

    public function getAvailableSortOptionsByView(int $view) : array
    {
        return self::$availableSortOptionsByView[$view];
    }

    public function getAvailablePresentationsByView(int $view) : array
    {
        return self::$availablePresentationsByView[$view];
    }

    public function getDefaultSortingByView(int $view) : string
    {
        switch ($view) {
            case $this->getSelectedItemsView():
                return $this->settings->get('selected_items_def_sort', $this->getSortByLocationMode());

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


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

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

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

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

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

    public function storeViewSorting(int $view, string $type, array $active)
    {
        if (!in_array($type, $active)) {
            $active[] = $type;
        }

        assert(in_array($type, $this->getAvailableSortOptionsByView($view)));

        switch ($view) {
            case $this->getSelectedItemsView():
                $this->settings->set('selected_items_def_sort', $type);
                break;

            default:
                $this->settings->set('my_memberships_def_sort', $type);
                break;
        }

        $this->settings->set('pd_active_sort_view_' . $view, serialize($active));
    }

    public function getActiveSortingsByView(int $view)
    {
        $val = $this->settings->get('pd_active_sort_view_' . $view);
        return ($val == "")
            ? []
            : unserialize($val);
    }

    public function storeViewPresentation(int $view, string $default, array $active)
    {
        if (!in_array($default, $active)) {
            $active[] = $default;
        }
        $this->settings->set('pd_def_pres_view_' . $view, $default);
        $this->settings->set('pd_active_pres_view_' . $view, serialize($active));
    }

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

    public function getActivePresentationsByView(int $view) : array
    {
        $val = $this->settings->get('pd_active_pres_view_' . $view, '');

        return ('' === $val)
            ? []
            : unserialize($val);
    }

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

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

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

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

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

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

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

    public function storeDefaultView(int $view)
    {
        $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 (1 === count($this->validViews)) {
            $this->storeDefaultView($this->getSelectedItemsView());
            $this->validViews[] = $this->getSelectedItemsView();
        }

        if (!$this->isValidView($this->getCurrentView())) {
            $this->currentView = $this->getDefaultView();
        }*/

        $this->currentSortOption = $this->getEffectiveSortingMode();
        $this->currentPresentationOption = $this->getEffectivePresentationMode();
    }

    public function getEffectivePresentationMode() : string
    {
        $mode = $this->actor->getPref('pd_view_pres_' . $this->currentView);

        if (!in_array($mode, $this->getSelectablePresentationModes())) {
            $mode = $this->getDefaultPresentationByView($this->currentView);
        }

        return $mode;
    }


    public function getEffectiveSortingMode() : string
    {
        $mode = $this->actor->getPref('pd_order_items_' . $this->currentView);

        if (!in_array($mode, $this->getSelectableSortingModes())) {
            $mode = $this->getDefaultSortingByView($this->currentView);
        }

        return $mode;
    }

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

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

    public function storeActorPresentationMode(string $presentationMode)
    {
        if (in_array($presentationMode, $this->getSelectablePresentationModes())) {
            $this->actor->writePref(
                'pd_view_pres_' . $this->currentView,
                $presentationMode
            );
        }
    }

    public function storeActorSortingMode(string $sortingMode)
    {
        if (in_array($sortingMode, $this->getSelectableSortingModes())) {
            $this->actor->writePref(
                'pd_order_items_' . $this->currentView,
                $sortingMode
            );
        }
    }

    public function getActor() : ilObjUser
    {
        return $this->actor;
    }

    public function getCurrentView() : int
    {
        return $this->currentView;
    }

    public function getCurrentSortOption() : int
    {
        return $this->currentSortOption;
    }

    public function isValidView(int $view) : bool
    {
        return in_array($view, $this->validViews);
    }
}