Class ilPDSelectedItemsBlockViewGUI. More...

Inheritance diagram for ilPDSelectedItemsBlockViewGUI:

Collaboration diagram for ilPDSelectedItemsBlockViewGUI:

Public Member Functions
	getScreenId ()

	getTitle ()

	getMinimumDetailLevelForSection ()

	supportsSelectAll ()

	getIntroductionHtml ()

	getGroups ()

	mayRemoveItem ($refId)

	setIsInManageMode (bool $isInManageMode)

	isInManageMode ()

	getItemGroups ()

Static Public Member Functions
static	bySettings (ilPDSelectedItemsBlockViewSettings $viewSettings)

Protected Member Functions
	isRootNode ($refId)

	getRepositoryTitle ()

	preloadItemGroups (array $item_groups)

	groupItemsByType ()

	groupItemsByStartDate ()

	groupItemsByLocation ()

Protected Attributes
	$viewSettings

	$provider

	$lng

	$tree

	$object_cache

	$accessHandler

	$isInManageMode = false

Private Member Functions
	__construct (ilPDSelectedItemsBlockViewSettings $viewSettings, ilPDSelectedItemsBlockProvider $provider)
	ilPDSelectedItemsBlockViewGUI constructor. More...

Detailed Description

Class ilPDSelectedItemsBlockViewGUI.

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

Constructor & Destructor Documentation

◆ __construct()

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

private

ilPDSelectedItemsBlockViewGUI constructor.

Parameters

ilPDSelectedItemsBlockViewSettings	$viewSettings
ilPDSelectedItemsBlockProvider	$provider

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

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

References $DIC, $provider, and $viewSettings.

Member Function Documentation

◆ bySettings()

static ilPDSelectedItemsBlockViewGUI::bySettings ( ilPDSelectedItemsBlockViewSettings $viewSettings )

static

Parameters

ilPDSelectedItemsBlockViewSettings $viewSettings

Returns: self

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

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

References $viewSettings.

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

Here is the caller graph for this function:

◆ getGroups()

ilPDSelectedItemsBlockViewGUI::getGroups ( )

abstract

Returns: ilPDSelectedItemsBlockGroup[]

Reimplemented in ilPDSelectedItemsBlockMembershipsViewGUI, and ilPDSelectedItemsBlockSelectedItemsViewGUI.

Referenced by getItemGroups().

Here is the caller graph for this function:

◆ getIntroductionHtml()

ilPDSelectedItemsBlockViewGUI::getIntroductionHtml ( )

abstract

Returns: string

Reimplemented in ilPDSelectedItemsBlockMembershipsViewGUI, and ilPDSelectedItemsBlockSelectedItemsViewGUI.

◆ getItemGroups()

ilPDSelectedItemsBlockViewGUI::getItemGroups ( )

Returns: ilPDSelectedItemsBlockGroup[]

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

    {
        $items_groups = $this->getGroups();
        $this->preloadItemGroups($items_groups);
 
        return $items_groups;
    }

References getGroups(), and preloadItemGroups().

Here is the call graph for this function:

◆ getMinimumDetailLevelForSection()

ilPDSelectedItemsBlockViewGUI::getMinimumDetailLevelForSection ( )

Returns: int

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

    {
        if ($this->viewSettings->isSortedByLocation()) {
            return 1;
        }
 
        return 3;
    }

◆ getRepositoryTitle()

ilPDSelectedItemsBlockViewGUI::getRepositoryTitle ( )

protected

Returns: string

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

    {
        $nd = $this->tree->getNodeData($this->tree->getRootId());
        $title = $nd['title'];
 
        if ($title == 'ILIAS') {
            $title = $this->lng->txt('repository');
        }
 
        return $title;
    }

References $nd.

Referenced by groupItemsByLocation().

Here is the caller graph for this function:

◆ getScreenId()

ilPDSelectedItemsBlockViewGUI::getScreenId ( )

abstract

Returns: string

Reimplemented in ilPDSelectedItemsBlockMembershipsViewGUI, and ilPDSelectedItemsBlockSelectedItemsViewGUI.

◆ getTitle()

ilPDSelectedItemsBlockViewGUI::getTitle ( )

abstract

Returns: string

Reimplemented in ilPDSelectedItemsBlockMembershipsViewGUI, and ilPDSelectedItemsBlockSelectedItemsViewGUI.

◆ groupItemsByLocation()

ilPDSelectedItemsBlockViewGUI::groupItemsByLocation ( )

protected

Returns: ilPDSelectedItemsBlockGroup[]

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

    {
        $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($item['parent_ref'])));
                }
                $grouped_items['grp_' . $item['parent_ref']] = $group;
            }
 
            $grouped_items['grp_' . $item['parent_ref']]->pushItem($item);
        }
 
        return $grouped_items;
    }

References getRepositoryTitle(), and isRootNode().

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

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 232 of file class.ilPDSelectedItemsBlockViewGUI.php.

    {
        $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;
        });
    }

References ilPDSelectedItemsBlockGroup\getItems(), and IL_CAL_UNIX.

Referenced by ilPDSelectedItemsBlockMembershipsViewGUI\getGroups().

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 199 of file class.ilPDSelectedItemsBlockViewGUI.php.

    {
        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 {
                include_once("./Services/Component/classes/class.ilPlugin.php");
                $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;
    }

References $DIC, and ilObjectPlugin\getPluginObjectByType().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isInManageMode()

ilPDSelectedItemsBlockViewGUI::isInManageMode ( )

Returns: bool

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

                                     : bool
    {
        return $this->isInManageMode;
    }

References $isInManageMode.

Referenced by setIsInManageMode().

Here is the caller graph for this function:

◆ isRootNode()

ilPDSelectedItemsBlockViewGUI::isRootNode ( $refId )

protected

Parameters

int $refId

Returns: bool

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

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

References $refId.

Referenced by groupItemsByLocation().

Here is the caller graph for this function:

◆ mayRemoveItem()

ilPDSelectedItemsBlockViewGUI::mayRemoveItem ( $refId )

Parameters

int $refId

Returns: bool

Reimplemented in ilPDSelectedItemsBlockMembershipsViewGUI.

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

    {
        return true;
    }

◆ preloadItemGroups()

ilPDSelectedItemsBlockViewGUI::preloadItemGroups ( array $item_groups )

protected

Parameters

ilPDSelectedItemsBlockGroup[] $item_groups

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

    {
        require_once 'Services/Object/classes/class.ilObjectListGUIPreloader.php';
        $listPreloader = new ilObjectListGUIPreloader(ilObjectListGUI::CONTEXT_PERSONAL_DESKTOP);
 
        $obj_ids = [];
        foreach ($item_groups as $item_group) {
            foreach ($item_group->getItems() as $item) {
                $obj_ids[] = $item['obj_id'];
                $listPreloader->addItem($item['obj_id'], $item['type'], $item['ref_id']);
            }
        }
 
        $listPreloader->preload();
        ilAdvancedMDValues::preloadByObjIds($obj_ids);
    }

References ilObjectListGUI\CONTEXT_PERSONAL_DESKTOP, and ilAdvancedMDValues\preloadByObjIds().

Referenced by getItemGroups().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIsInManageMode()

ilPDSelectedItemsBlockViewGUI::setIsInManageMode ( bool $isInManageMode )

Parameters

bool $isInManageMode

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

    {
        $this->isInManageMode = $isInManageMode;
    }

References $isInManageMode, and isInManageMode().

Here is the call graph for this function:

◆ supportsSelectAll()

ilPDSelectedItemsBlockViewGUI::supportsSelectAll ( )

abstract

Returns: boolean

Reimplemented in ilPDSelectedItemsBlockMembershipsViewGUI, and ilPDSelectedItemsBlockSelectedItemsViewGUI.

Field Documentation

◆ $accessHandler

ilPDSelectedItemsBlockViewGUI::$accessHandler

protected

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

◆ $isInManageMode

ilPDSelectedItemsBlockViewGUI::$isInManageMode = false

protected

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

Referenced by isInManageMode(), and setIsInManageMode().

◆ $lng

ilPDSelectedItemsBlockViewGUI::$lng

protected

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

◆ $object_cache

ilPDSelectedItemsBlockViewGUI::$object_cache

protected

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

◆ $provider

ilPDSelectedItemsBlockViewGUI::$provider

protected

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

Referenced by __construct().

◆ $tree

ilPDSelectedItemsBlockViewGUI::$tree

protected

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

◆ $viewSettings

ilPDSelectedItemsBlockViewGUI::$viewSettings

protected

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

Referenced by __construct(), and bySettings().

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ bySettings()

◆ getGroups()

◆ getIntroductionHtml()

◆ getItemGroups()

◆ getMinimumDetailLevelForSection()

◆ getRepositoryTitle()

◆ getScreenId()

◆ getTitle()

◆ groupItemsByLocation()

◆ groupItemsByStartDate()

◆ groupItemsByType()

◆ isInManageMode()

◆ isRootNode()

◆ mayRemoveItem()

◆ preloadItemGroups()

◆ setIsInManageMode()

◆ supportsSelectAll()

Field Documentation

◆ $accessHandler

◆ $isInManageMode

◆ $lng

◆ $object_cache

◆ $provider

◆ $tree

◆ $viewSettings