ilPDSelectedItemsBlockViewGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilPDSelectedItemsBlockViewGUI:

Collaboration diagram for ilPDSelectedItemsBlockViewGUI:

Public Member Functions
	getScreenId ()
	getTitle ()
	supportsSelectAll ()
	getIntroductionHtml ()
	getGroups ()
	mayRemoveItem (int $refId)
	setIsInManageMode (bool $isInManageMode)
	isInManageMode ()
	getItemGroups ()

Static Public Member Functions
static	bySettings (ilPDSelectedItemsBlockViewSettings $viewSettings)

Protected Member Functions
	isRootNode (int $refId)
	getRepositoryTitle ()
	preloadItemGroups (array $item_groups)
	groupItemsByType ()
	groupItemsByStartDate ()
	groupItemsByLocation ()
	sortItemsByAlphabetInOneGroup ()

Protected Attributes
ilPDSelectedItemsBlockViewSettings	$viewSettings
ilPDSelectedItemsBlockProvider	$provider
ilLanguage	$lng
ilTree	$tree
ilObjectDataCache	$object_cache
ilRbacSystem	$accessHandler
bool	$isInManageMode = false

Private Member Functions
	__construct (ilPDSelectedItemsBlockViewSettings $viewSettings, ilPDSelectedItemsBlockProvider $provider)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 19 of file class.ilPDSelectedItemsBlockViewGUI.php.

Constructor & Destructor Documentation

__construct()

ilPDSelectedItemsBlockViewGUI::__construct ( ilPDSelectedItemsBlockViewSettings  $viewSettings, ilPDSelectedItemsBlockProvider  $provider  )

private

Definition at line 29 of file class.ilPDSelectedItemsBlockViewGUI.php.

References $DIC, $provider, $viewSettings, getGroups(), getIntroductionHtml(), getScreenId(), getTitle(), ILIAS\Repository\lng(), and supportsSelectAll().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->tree = $DIC->repositoryTree();
        $this->object_cache = $DIC['ilObjDataCache'];
        $this->accessHandler = $DIC->rbac()->system();

        $this->viewSettings = $viewSettings;
        $this->provider = $provider;
    }

Here is the call graph for this function:

Member Function Documentation

bySettings()

static ilPDSelectedItemsBlockViewGUI::bySettings ( ilPDSelectedItemsBlockViewSettings  $viewSettings )

static

Definition at line 81 of file class.ilPDSelectedItemsBlockViewGUI.php.

References ilPDSelectedItemsBlockViewSettings\getActor(), and ilPDSelectedItemsBlockViewSettings\isMembershipsViewActive().

Referenced by ilFavouritesListGUI\__construct(), ilPDMembershipBlockGUI\initViewSettings(), and ilPDSelectedItemsBlockGUI\initViewSettings().

                                                                                       : ilPDSelectedItemsBlockViewGUI
    {
        if ($viewSettings->isMembershipsViewActive()) {
            return new ilPDSelectedItemsBlockMembershipsViewGUI(
                $viewSettings,
                new ilPDSelectedItemsBlockMembershipsProvider($viewSettings->getActor())
            );
        }

        return new ilPDSelectedItemsBlockSelectedItemsViewGUI(
            $viewSettings,
            new ilPDSelectedItemsBlockSelectedItemsProvider($viewSettings->getActor())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getGroups()

ilPDSelectedItemsBlockViewGUI::getGroups ( )

abstract

Returns

ilPDSelectedItemsBlockGroup[]

Referenced by __construct(), and getItemGroups().

Here is the caller graph for this function:

getIntroductionHtml()

ilPDSelectedItemsBlockViewGUI::getIntroductionHtml ( )

abstract

Referenced by __construct().

Here is the caller graph for this function:

getItemGroups()

ilPDSelectedItemsBlockViewGUI::getItemGroups

(

)

Returns

ilPDSelectedItemsBlockGroup[]

Definition at line 73 of file class.ilPDSelectedItemsBlockViewGUI.php.

References getGroups(), and preloadItemGroups().

                                   : array
    {
        $items_groups = $this->getGroups();
        $this->preloadItemGroups($items_groups);

        return $items_groups;
    }

Here is the call graph for this function:

getRepositoryTitle()

ilPDSelectedItemsBlockViewGUI::getRepositoryTitle ( )

protected

Definition at line 101 of file class.ilPDSelectedItemsBlockViewGUI.php.

References $nd, and ILIAS\Repository\lng().

Referenced by ilPDSelectedItemsBlockSelectedItemsViewGUI\getIntroductionHtml(), and groupItemsByLocation().

                                           : string
    {
        $nd = $this->tree->getNodeData($this->tree->getRootId());
        $title = $nd['title'];

        if ($title == 'ILIAS') {
            $title = $this->lng->txt('repository');
        }

        return $title;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getScreenId()

ilPDSelectedItemsBlockViewGUI::getScreenId ( )

abstract

Referenced by __construct().

Here is the caller graph for this function:

getTitle()

ilPDSelectedItemsBlockViewGUI::getTitle ( )

abstract

Referenced by __construct().

Here is the caller graph for this function:

groupItemsByLocation()

ilPDSelectedItemsBlockViewGUI::groupItemsByLocation ( )

protected

Returns

ilPDSelectedItemsBlockGroup[]

Definition at line 258 of file class.ilPDSelectedItemsBlockViewGUI.php.

References ILIAS\LTI\ToolProvider\$key, getRepositoryTitle(), and isRootNode().

Referenced by ilPDSelectedItemsBlockMembershipsViewGUI\getGroups(), and ilPDSelectedItemsBlockSelectedItemsViewGUI\getGroups().

                                             : array
    {
        $grouped_items = array();

        $items = $this->provider->getItems();

        $parent_ref_ids = array_values(array_unique(array_map(function ($item) {
            return $item['parent_ref'];
        }, $items)));
        $this->object_cache->preloadReferenceCache($parent_ref_ids);

        foreach ($items as $key => $item) {
            if (!array_key_exists('grp_' . $item['parent_ref'], $grouped_items)) {
                $group = new ilPDSelectedItemsBlockGroup();
                /* The parent objects of items grouped by location do not need an image (per current concept), so
                   we do not determine images to reduced the runtime/memory */
                if ($this->isRootNode($item['parent_ref'])) {
                    $group->setLabel($this->getRepositoryTitle());
                } else {
                    $group->setLabel($this->object_cache->lookupTitle($this->object_cache->lookupObjId((int) $item['parent_ref'])));
                }
                $grouped_items['grp_' . $item['parent_ref']] = $group;
            }

            $grouped_items['grp_' . $item['parent_ref']]->pushItem($item);
        }

        return $grouped_items;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

groupItemsByStartDate()

ilPDSelectedItemsBlockViewGUI::groupItemsByStartDate ( )

protected

Returns

ilPDSelectedItemsBlockGroup[]

Definition at line 167 of file class.ilPDSelectedItemsBlockViewGUI.php.

References ILIAS\LTI\ToolProvider\$key, ilPDSelectedItemsBlockGroup\getItems(), IL_CAL_UNIX, and ILIAS\Repository\lng().

Referenced by ilPDSelectedItemsBlockMembershipsViewGUI\getGroups().

                                              : array
    {
        $items = $this->provider->getItems();

        if (0 == count($items)) {
            return array();
        }

        $groups = array(
            'upcoming' => array(),
            'ongoing' => array(),
            'ended' => array(),
            'not_dated' => array()
        );
        foreach ($items as $key => $item) {
            if ($item['start'] && $item['start']->get(IL_CAL_UNIX) > 0 && $item['start'] instanceof ilDateTime) {
                if ($item['start']->get(IL_CAL_UNIX) > time()) {
                    $groups['upcoming'][] = $item;
                } elseif ($item['end']->get(IL_CAL_UNIX) > time()) {
                    $groups['ongoing'][] = $item;
                } else {
                    $groups['ended'][] = $item;
                }
            } else {
                $groups['not_dated'][] = $item;
            }
        }

        uasort($groups['upcoming'], function ($left, $right) {
            if ($left['start']->get(IL_CAL_UNIX) < $right['start']->get(IL_CAL_UNIX)) {
                return -1;
            } elseif ($left['start']->get(IL_CAL_UNIX) > $right['start']->get(IL_CAL_UNIX)) {
                return 1;
            }

            return strcmp($left['title'], $right['title']);
        });

        uasort($groups['ongoing'], function ($left, $right) {
            if ($left['start']->get(IL_CAL_UNIX) < $right['start']->get(IL_CAL_UNIX)) {
                return 1;
            } elseif ($left['start']->get(IL_CAL_UNIX) > $right['start']->get(IL_CAL_UNIX)) {
                return -1;
            }

            return strcmp($left['title'], $right['title']);
        });

        uasort($groups['ended'], function ($left, $right) {
            if ($left['start']->get(IL_CAL_UNIX) < $right['start']->get(IL_CAL_UNIX)) {
                return 1;
            } elseif ($left['start']->get(IL_CAL_UNIX) > $right['start']->get(IL_CAL_UNIX)) {
                return -1;
            }

            return strcmp($left['title'], $right['title']);
        });

        uasort($groups['not_dated'], function ($left, $right) {
            return strcmp($left['title'], $right['title']);
        });

        $upcoming = new ilPDSelectedItemsBlockGroup();
        $upcoming->setLabel($this->lng->txt('pd_upcoming'));
        $upcoming->setItems($groups['upcoming']);

        $ongoing = new ilPDSelectedItemsBlockGroup();
        $ongoing->setLabel($this->lng->txt('pd_ongoing'));
        $ongoing->setItems($groups['ongoing']);

        $ended = new ilPDSelectedItemsBlockGroup();
        $ended->setLabel($this->lng->txt('pd_ended'));
        $ended->setItems($groups['ended']);

        $not_dated = new ilPDSelectedItemsBlockGroup();
        $not_dated->setLabel($this->lng->txt('pd_not_date'));
        $not_dated->setItems($groups['not_dated']);

        return array_filter([
            $upcoming,
            $ongoing,
            $ended,
            $not_dated
        ], function (ilPDSelectedItemsBlockGroup $group) {
            return count($group->getItems()) > 0;
        });
    }

Here is the call graph for this function:

Here is the caller graph for this function:

groupItemsByType()

ilPDSelectedItemsBlockViewGUI::groupItemsByType ( )

protected

Returns

ilPDSelectedItemsBlockGroup[]

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

References $DIC, ilObjectPlugin\getPluginObjectByType(), and ILIAS\Repository\lng().

Referenced by ilPDSelectedItemsBlockMembershipsViewGUI\getGroups(), and ilPDSelectedItemsBlockSelectedItemsViewGUI\getGroups().

                                         : array
    {
        global $DIC;

        $objDefinition = $DIC["objDefinition"];

        $object_types_by_container = $DIC['objDefinition']->getGroupedRepositoryObjectTypes(array('cat', 'crs', 'grp', 'fold'));

        $grouped_items = array();

        foreach ($object_types_by_container as $container_object_type => $container_data) {
            $group = new ilPDSelectedItemsBlockGroup();
            // Icons are currently not determined for section header objects
            if (!$objDefinition->isPlugin($container_object_type)) {
                $title = $this->lng->txt('objs_' . $container_object_type);
            } else {
                $pl = ilObjectPlugin::getPluginObjectByType($container_object_type);
                $title = $pl->txt("objs_" . $container_object_type);
            }

            $group->setLabel($title);
            $group->setItems($this->provider->getItems($container_data['objs']));

            $grouped_items[] = $group;
        }

        return $grouped_items;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isInManageMode()

ilPDSelectedItemsBlockViewGUI::isInManageMode

(

)

Definition at line 65 of file class.ilPDSelectedItemsBlockViewGUI.php.

References $isInManageMode.

Referenced by setIsInManageMode().

                                    : bool
    {
        return $this->isInManageMode;
    }

Here is the caller graph for this function:

isRootNode()

ilPDSelectedItemsBlockViewGUI::isRootNode ( int  $refId )

protected

Definition at line 96 of file class.ilPDSelectedItemsBlockViewGUI.php.

References $refId.

Referenced by groupItemsByLocation().

                                             : bool
    {
        return $this->tree->getRootId() == $refId;
    }

Here is the caller graph for this function:

mayRemoveItem()

ilPDSelectedItemsBlockViewGUI::mayRemoveItem

(

int

$refId

)

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

                                             : bool
    {
        return true;
    }

preloadItemGroups()

ilPDSelectedItemsBlockViewGUI::preloadItemGroups ( array  $item_groups )

protected

Parameters

ilPDSelectedItemsBlockGroup[]

$item_groups

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

References ilObjectListGUI\CONTEXT_PERSONAL_DESKTOP, ILIAS\Repository\int(), and ilAdvancedMDValues\preloadByObjIds().

Referenced by getItemGroups().

    {
        $listPreloader = new ilObjectListGUIPreloader(ilObjectListGUI::CONTEXT_PERSONAL_DESKTOP);

        $obj_ids = [];
        foreach ($item_groups as $item_group) {
            foreach ($item_group->getItems() as $item) {
                $obj_ids[] = (int) $item['obj_id'];
                $listPreloader->addItem($item['obj_id'], $item['type'], $item['ref_id']);
            }
        }

        $listPreloader->preload();
        ilAdvancedMDValues::preloadByObjIds($obj_ids);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setIsInManageMode()

ilPDSelectedItemsBlockViewGUI::setIsInManageMode

(

bool

$isInManageMode

)

Definition at line 60 of file class.ilPDSelectedItemsBlockViewGUI.php.

References $isInManageMode, and isInManageMode().

                                                           : void
    {
        $this->isInManageMode = $isInManageMode;
    }

Here is the call graph for this function:

sortItemsByAlphabetInOneGroup()

ilPDSelectedItemsBlockViewGUI::sortItemsByAlphabetInOneGroup ( )

protected

Returns

ilPDSelectedItemsBlockGroup[]

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

Referenced by ilPDSelectedItemsBlockMembershipsViewGUI\getGroups(), and ilPDSelectedItemsBlockSelectedItemsViewGUI\getGroups().

                                                      : array
    {
        $items = array_values($this->provider->getItems());

        usort($items, static function (array $first, array $second): int {
            return strnatcmp(strtolower($first['title']), strtolower($second['title']));
        });

        $group = new ilPDSelectedItemsBlockGroup();
        array_map([$group, 'pushItem'], $items);

        return [$group];
    }

Here is the caller graph for this function:

supportsSelectAll()

ilPDSelectedItemsBlockViewGUI::supportsSelectAll ( )

abstract

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

$accessHandler

ilRbacSystem ilPDSelectedItemsBlockViewGUI::$accessHandler

protected

Definition at line 26 of file class.ilPDSelectedItemsBlockViewGUI.php.

$isInManageMode

bool ilPDSelectedItemsBlockViewGUI::$isInManageMode = false

protected

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

Referenced by isInManageMode(), and setIsInManageMode().

$lng

ilLanguage ilPDSelectedItemsBlockViewGUI::$lng

protected

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

$object_cache

ilObjectDataCache ilPDSelectedItemsBlockViewGUI::$object_cache

protected

Definition at line 25 of file class.ilPDSelectedItemsBlockViewGUI.php.

$provider

ilPDSelectedItemsBlockProvider ilPDSelectedItemsBlockViewGUI::$provider

protected

Definition at line 22 of file class.ilPDSelectedItemsBlockViewGUI.php.

Referenced by __construct().

$tree

ilTree ilPDSelectedItemsBlockViewGUI::$tree

protected

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

$viewSettings

ilPDSelectedItemsBlockViewSettings ilPDSelectedItemsBlockViewGUI::$viewSettings

protected

Definition at line 21 of file class.ilPDSelectedItemsBlockViewGUI.php.

Referenced by __construct().

---

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

• Services/Dashboard/ItemsBlock/classes/class.ilPDSelectedItemsBlockViewGUI.php