High level business logic class. More...

Collaboration diagram for ILIAS\Container\Content\ItemPresentationManager:

Public Member Functions
	__construct (InternalDomainService $domain, \ilContainer $container, ?\ilContainerUserFilter $container_user_filter, ClipboardManager $repo_clipboard, bool $include_empty_blocks=true, ?string $lang=null)

	canManageItems ()

	canOrderItems ()
	Controls the ordering subtab. More...

	isActiveItemOrdering (string $type)
	Are we currently in ordering view and the items can be ordered? More...

	forceSessionOrderingByDate ()

	filteredSubtree ()

	hasItems ()

	getItemBlockSequence ()

	getPageEmbeddedBlockIds ()

	getRawDataByRefId (int $ref_id)

	getAllRefIds ()

	getRefIdsOfType (string $type)

Protected Member Functions
	isClassificationFilterActive ()

	init ()

Protected Attributes
string	$lang = null

bool	$include_empty_blocks

ModeManager	$mode_manager

bool	$can_order = null

ClipboardManager	$repo_clipboard

bool	$can_manage = null

ItemBlock ItemBlockSequenceGenerator	$sequence_generator

ilContainerUserFilter	$container_user_filter = null

array	$type_grps = null

ItemSetManager	$item_set = null

ilContainer	$container

ItemSessionRepository	$item_repo

InternalDomainService	$domain

Detailed Description

High level business logic class.

Orchestrates item set, view and block sequence generator.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 33 of file class.ItemPresentationManager.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Container\Content\ItemPresentationManager::__construct	(	InternalDomainService	$domain,
		\ilContainer	$container,
		?\ilContainerUserFilter	$container_user_filter,
		ClipboardManager	$repo_clipboard,
		bool	$include_empty_blocks = `true`,
		?string	$lang = `null`
	)

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

      {
        $this->container = $container;
        $this->domain = $domain;
        $this->container_user_filter = $container_user_filter;
        $this->repo_clipboard = $repo_clipboard;
        $this->mode_manager = $domain->content()->mode($container);
        $this->include_empty_blocks = $include_empty_blocks;
        $this->lang = $lang;
 
        // sequence from view manager
    }

References ILIAS\Container\Content\ItemPresentationManager\$container, ILIAS\Container\Content\ItemPresentationManager\$container_user_filter, ILIAS\Container\Content\ItemPresentationManager\$domain, ILIAS\Container\Content\ItemPresentationManager\$include_empty_blocks, ILIAS\Container\Content\ItemPresentationManager\$lang, ILIAS\Container\Content\ItemPresentationManager\$repo_clipboard, and ILIAS\Container\InternalDomainService\content().

Here is the call graph for this function:

Member Function Documentation

◆ canManageItems()

ILIAS\Container\Content\ItemPresentationManager::canManageItems ( )

Definition at line 68 of file class.ItemPresentationManager.php.

                                    : bool
    {
        if (!is_null($this->can_manage)) {
            return $this->can_manage;
        }
        $user = $this->domain->user();
        $rbacsystem = $this->domain->rbac()->system();
        if ($user->getId() === ANONYMOUS_USER_ID || !is_object($this->container)) {
            return false;
        }
 
        if ($rbacsystem->checkAccess("write", $this->container->getRefId()) ||
            $this->container->getHiddenFilesFound() ||
            $this->repo_clipboard->hasEntries()) {
            $this->can_manage = true;
            return true;
        }
        $this->init();
        $this->can_manage = false;
        /* this is time consuming and probably not necessary
        foreach ($this->item_set->getAllRefIds() as $ref_id) {
            if ($this->can_manage === true) {
                break;
            }
            if ($rbacsystem->checkAccess("delete", $ref_id)) {
                $this->can_manage = true;
            }
        }*/
        return $this->can_manage;
    }

References ILIAS\Container\Content\ItemPresentationManager\$can_manage, ANONYMOUS_USER_ID, and ILIAS\Container\Content\ItemPresentationManager\init().

Here is the call graph for this function:

◆ canOrderItems()

ILIAS\Container\Content\ItemPresentationManager::canOrderItems ( )

Controls the ordering subtab.

Definition at line 102 of file class.ItemPresentationManager.php.

                                   : bool
    {
        $user = $this->domain->user();
        $rbacsystem = $this->domain->rbac()->system();
 
        if (is_null($this->can_order)) {
            $this->can_order = false;
            if ($user->getId() !== ANONYMOUS_USER_ID &&
                is_object($this->container) &&
                $rbacsystem->checkAccess("write", $this->container->getRefId())) {
                $this->can_order = (\ilContainerSortingSettings::_lookupSortMode($this->container->getId()) === \ilContainer::SORT_MANUAL);
            }
        }
        return $this->can_order;
    }

References ILIAS\Container\Content\ItemPresentationManager\$can_order, ilContainerSortingSettings\_lookupSortMode(), ANONYMOUS_USER_ID, and ilContainer\SORT_MANUAL.

Here is the call graph for this function:

◆ filteredSubtree()

ILIAS\Container\Content\ItemPresentationManager::filteredSubtree ( )

Todo:: from ilContainer, should be removed there

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

                                     : bool
    {
        return $this->isClassificationFilterActive() && in_array(
            $this->container->getType(),
            ["grp", "crs"]
        );
    }

References ILIAS\Container\Content\ItemPresentationManager\isClassificationFilterActive().

Referenced by ILIAS\Container\Content\ItemPresentationManager\init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ forceSessionOrderingByDate()

ILIAS\Container\Content\ItemPresentationManager::forceSessionOrderingByDate ( )

Definition at line 133 of file class.ItemPresentationManager.php.

                                                : bool
    {
        // see #43205
        return ($this->container->getViewMode() === \ilContainer::VIEW_SESSIONS ||
            $this->container->getOrderType() !== \ilContainer::SORT_MANUAL);
    }

References ilContainer\SORT_MANUAL, and ilContainer\VIEW_SESSIONS.

Referenced by ILIAS\Container\Content\ItemPresentationManager\init().

Here is the caller graph for this function:

◆ getAllRefIds()

ILIAS\Container\Content\ItemPresentationManager::getAllRefIds ( )

Definition at line 231 of file class.ItemPresentationManager.php.

                                  : ?array
    {
        $this->init();
        return $this->item_set->getAllRefIds();
    }

References ILIAS\Container\Content\ItemPresentationManager\init().

Here is the call graph for this function:

◆ getItemBlockSequence()

ILIAS\Container\Content\ItemPresentationManager::getItemBlockSequence ( )

Definition at line 213 of file class.ItemPresentationManager.php.

                                          : ItemBlockSequence
    {
        $this->init();
        return $this->sequence_generator->getSequence();
    }

References ILIAS\Container\Content\ItemPresentationManager\init().

Here is the call graph for this function:

◆ getPageEmbeddedBlockIds()

ILIAS\Container\Content\ItemPresentationManager::getPageEmbeddedBlockIds ( )

Definition at line 219 of file class.ItemPresentationManager.php.

                                             : array
    {
        $this->init();
        return $this->sequence_generator->getPageEmbeddedBlockIds();
    }

References ILIAS\Container\Content\ItemPresentationManager\init().

Here is the call graph for this function:

◆ getRawDataByRefId()

ILIAS\Container\Content\ItemPresentationManager::getRawDataByRefId ( int $ref_id )

Definition at line 225 of file class.ItemPresentationManager.php.

                                                  : ?array
    {
        $this->init();
        return $this->item_set->getRawDataByRefId($ref_id);
    }

References $ref_id, and ILIAS\Container\Content\ItemPresentationManager\init().

Here is the call graph for this function:

◆ getRefIdsOfType()

ILIAS\Container\Content\ItemPresentationManager::getRefIdsOfType ( string $type )

Definition at line 237 of file class.ItemPresentationManager.php.

                                                 : array
    {
        $this->init();
        return $this->item_set->getRefIdsOfType($type);
    }

References ILIAS\Container\Content\ItemPresentationManager\init().

Here is the call graph for this function:

◆ hasItems()

ILIAS\Container\Content\ItemPresentationManager::hasItems ( )

Definition at line 207 of file class.ItemPresentationManager.php.

                              : bool
    {
        $this->init();
        return $this->item_set->hasItems();
    }

References ILIAS\Container\Content\ItemPresentationManager\init().

Here is the call graph for this function:

◆ init()

ILIAS\Container\Content\ItemPresentationManager::init ( )

protected

Definition at line 175 of file class.ItemPresentationManager.php.

                             : void
    {
        // already initialised?
        if (!is_null($this->item_set)) {
            return;
        }
 
        // get view
        $view = $this->domain->content()->view($this->container);
        // get item set
        $ref_id = $this->container->getRefId();
        if ($this->filteredSubtree()) {
            $this->item_set = $this->domain->content()->itemSetTree($ref_id, $this->container_user_filter);
        } else {
            $this->item_set = $this->domain->content()->itemSetFlat(
                $ref_id,
                $this->container_user_filter,
                $this->forceSessionOrderingByDate(),
                $view instanceof ObjectiveViewManager
            );
        }
 
        // get item block sequence generator
        $this->sequence_generator = $this->domain->content()->itemBlockSequenceGenerator(
            $this->container,
            $view->getBlockSequence(),
            $this->item_set,
            $this->include_empty_blocks,
            $this->lang
        );
    }

References $ref_id, ILIAS\Container\Content\ItemPresentationManager\filteredSubtree(), and ILIAS\Container\Content\ItemPresentationManager\forceSessionOrderingByDate().

Referenced by ILIAS\Container\Content\ItemPresentationManager\canManageItems(), ILIAS\Container\Content\ItemPresentationManager\getAllRefIds(), ILIAS\Container\Content\ItemPresentationManager\getItemBlockSequence(), ILIAS\Container\Content\ItemPresentationManager\getPageEmbeddedBlockIds(), ILIAS\Container\Content\ItemPresentationManager\getRawDataByRefId(), ILIAS\Container\Content\ItemPresentationManager\getRefIdsOfType(), and ILIAS\Container\Content\ItemPresentationManager\hasItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isActiveItemOrdering()

ILIAS\Container\Content\ItemPresentationManager::isActiveItemOrdering ( string $type )

Are we currently in ordering view and the items can be ordered?

Definition at line 121 of file class.ItemPresentationManager.php.

                                                      : bool
    {
        // see #43205
        if ($this->mode_manager->isActiveItemOrdering()) {
            if ($type === "sess" && $this->container->getViewMode() === \ilContainer::VIEW_SESSIONS) {
                return false;
            }
            return true;
        }
        return false;
    }

References ilContainer\VIEW_SESSIONS.

◆ isClassificationFilterActive()

ILIAS\Container\Content\ItemPresentationManager::isClassificationFilterActive ( )

protected

Todo:

from ilContainer, should be removed there

make proper service in classification component

Definition at line 145 of file class.ItemPresentationManager.php.

                                                     : bool
    {
        $ref_id = $this->container->getRefId();
        // apply container classification filters
        $classification = $this->domain->classification($ref_id);
        foreach (\ilClassificationProvider::getValidProviders(
            $this->container->getRefId(),
            $this->container->getId(),
            $this->container->getType()
        ) as $class_provider) {
            $id = get_class($class_provider);
            $current = $classification->getSelectionOfProvider($id);
            if ($current) {
                return true;
            }
        }
        return false;
    }