Manages container subitems set. More...

Collaboration diagram for ILIAS\Container\Content\ItemSetManager:

Public Member Functions
	__construct (InternalDomainService $domain, int $mode, int $parent_ref_id, ?\ilContainerUserFilter $user_filter=null, int $single_ref_id=0, bool $admin_mode=false, bool $force_session_order_by_date=true, protected bool $include_objective_items=false)

	setHiddenFilesFound (bool $a_hiddenfilesfound)

	getHiddenFilesFound ()

	hasItems ()

	getRefIdsOfType (string $type)

	getAllRefIds ()

	getRawDataByRefId (int $ref_id)

	isSideBlockItem (int $ref_id)

	isClassificationFilterActive ()

Data Fields
const	FLAT = 0

const	TREE = 1

const	SINGLE = 2

Protected Member Functions
	init ()

	addObjectiveItems ()

	addToItems (array $item)

	applySorting ()

	groupItems ()
	Internally group all items. More...

	sortSessions ()

	getAdditionalSubItemInformation ()

	addAdditionalSubItemInformationToObject (array &$object)

	applyUserFilter ()
	Apply container user filter on objects. More...

	getCompleteDescriptions ()
	From ilContainer. More...

	applyClassificationFilter ()
	From ilContainer. More...

	preloadAdvancedMDValues ()

Protected Attributes
bool	$force_session_order_by_date

bool	$admin_mode

bool	$hiddenfilesfound = false

string	$parent_type

int	$parent_obj_id

int	$parent_ref_id = 0

int	$single_ref_id = 0

InternalDomainService	$domain

array	$raw = []

array	$raw_by_type = []

array	$rendered = []

int	$mode = self::FLAT

ilContainerUserFilter	$user_filter = null

bool	$initialised = false

Detailed Description

Manages container subitems set.

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

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

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Container\Content\ItemSetManager::__construct	(	InternalDomainService	$domain,
		int	$mode,
		int	$parent_ref_id,
		?\ilContainerUserFilter	$user_filter = `null`,
		int	$single_ref_id = `0`,
		bool	$admin_mode = `false`,
		bool	$force_session_order_by_date = `true`,
		protected bool	$include_objective_items = `false`
	)

Parameters

int $mode self::TREE|self::FLAT|self::SINGLE

Definition at line 54 of file class.ItemSetManager.php.

      {
        $this->parent_ref_id = $parent_ref_id;
        $this->parent_obj_id = \ilObject::_lookupObjId($this->parent_ref_id);
        $this->parent_type = \ilObject::_lookupType($this->parent_obj_id);
        $this->user_filter = $user_filter;
        $this->force_session_order_by_date = $force_session_order_by_date;
 
        $this->single_ref_id = $single_ref_id;
        $this->domain = $domain;
        $this->mode = $mode;        // might be refactored as subclasses
        $this->admin_mode = $admin_mode;
        $this->init();
    }

References ILIAS\Container\Content\ItemSetManager\$admin_mode, ILIAS\Container\Content\ItemSetManager\$domain, ILIAS\Container\Content\ItemSetManager\$force_session_order_by_date, ILIAS\Container\Content\ItemSetManager\$mode, ILIAS\Container\Content\ItemSetManager\$parent_ref_id, ILIAS\Container\Content\ItemSetManager\$single_ref_id, ILIAS\Container\Content\ItemSetManager\$user_filter, ilObject\_lookupObjId(), ilObject\_lookupType(), and ILIAS\Container\Content\ItemSetManager\init().

Here is the call graph for this function:

Member Function Documentation

◆ addAdditionalSubItemInformationToObject()

ILIAS\Container\Content\ItemSetManager::addAdditionalSubItemInformationToObject ( array & $object )

protected

Definition at line 257 of file class.ItemSetManager.php.

                                                                              : void
    {
        \ilObjectActivation::addAdditionalSubItemInformation($object);
    }

References ilObjectActivation\addAdditionalSubItemInformation().

Referenced by ILIAS\Container\Content\ItemSetManager\getAdditionalSubItemInformation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addObjectiveItems()

ILIAS\Container\Content\ItemSetManager::addObjectiveItems ( )

protected

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

                                          : void
    {
        if (count($objective_ids = \ilCourseObjective::_getObjectiveIds(\ilObject::_lookupObjId($this->parent_ref_id), true)) > 0) {
            foreach ($objective_ids as $objective_id) {
                foreach (\ilObjectActivation::getItemsByObjective($objective_id) as $item) {
                    $this->addToItems($item);
                }
            }
        }
    }

References ilCourseObjective\_getObjectiveIds(), ilObject\_lookupObjId(), ILIAS\Container\Content\ItemSetManager\addToItems(), and ilObjectActivation\getItemsByObjective().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addToItems()

ILIAS\Container\Content\ItemSetManager::addToItems ( array $item )

protected

Definition at line 128 of file class.ItemSetManager.php.

                                              : void
    {
        if (($ref_id = $item["ref_id"] ?? 0) > 0) {
            foreach ($this->raw as $raw_item) {
                if ($raw_item["ref_id"] == $ref_id) {
                    return;
                }
            }
            $this->raw[] = $item;
        }
    }

References $ref_id, and ILIAS\Repository\raw().

Referenced by ILIAS\Container\Content\ItemSetManager\addObjectiveItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyClassificationFilter()

ILIAS\Container\Content\ItemSetManager::applyClassificationFilter ( )

protected

From ilContainer.

Todo:: remove there

Definition at line 355 of file class.ItemSetManager.php.

                                                  : void
    {
        // apply container classification filters
        $classification = $this->domain->classification($this->parent_ref_id);
        foreach (\ilClassificationProvider::getValidProviders(
            $this->parent_ref_id,
            $this->parent_obj_id,
            $this->parent_type
        ) as $class_provider) {
            $id = get_class($class_provider);
            $current = $classification->getSelectionOfProvider($id);
            if ($current) {
                $class_provider->setSelection($current);
                $filtered = $class_provider->getFilteredObjects();
                $this->raw = array_filter($this->raw, static function ($i) use ($filtered) {
                    return (is_array($filtered) && in_array($i["obj_id"], $filtered));
                });
            }
        }
    }

References $classification, $id, ilClassificationProvider\getValidProviders(), and ILIAS\Repository\raw().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applySorting()

ILIAS\Container\Content\ItemSetManager::applySorting ( )

protected

Definition at line 180 of file class.ItemSetManager.php.

                                     : void
    {
        $sort = \ilContainerSorting::_getInstance($this->parent_obj_id);
        $all = $sort->sortItems(["all" => $this->raw]);
        $this->raw = $all["all"];
        //$this->raw_by_type = $sort->sortItems($this->raw_by_type);
    }

References ilContainerSorting\_getInstance(), and ILIAS\Repository\raw().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyUserFilter()

ILIAS\Container\Content\ItemSetManager::applyUserFilter ( )

protected

Apply container user filter on objects.

Exceptions

ilException

Definition at line 288 of file class.ItemSetManager.php.

                                        : void
    {
        if (is_null($this->user_filter)) {
            return;
        }
        $filter = $this->domain->content()->filter(
            $this->raw,
            $this->user_filter,
            !\ilContainer::_lookupContainerSetting(
                $this->parent_obj_id,
                "filter_show_empty",
                "0"
            )
        );
        $this->raw = $filter->apply();
    }

References ilContainer\_lookupContainerSetting(), and ILIAS\Repository\raw().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdditionalSubItemInformation()

ILIAS\Container\Content\ItemSetManager::getAdditionalSubItemInformation ( )

protected

Definition at line 250 of file class.ItemSetManager.php.

                                                        : void
    {
        foreach ($this->raw as $key => $object) {
            $this->addAdditionalSubItemInformationToObject($this->raw[$key]);
        }
    }

References ILIAS\Container\Content\ItemSetManager\addAdditionalSubItemInformationToObject(), and ILIAS\Repository\raw().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllRefIds()

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

Definition at line 160 of file class.ItemSetManager.php.

                                  : array
    {
        $this->init();
        return array_keys($this->raw_by_type["_all"]);
    }

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

Here is the call graph for this function:

◆ getCompleteDescriptions()

ILIAS\Container\Content\ItemSetManager::getCompleteDescriptions ( )

protected

From ilContainer.

Todo:: remove there

Definition at line 308 of file class.ItemSetManager.php.

                                                : void
    {
        $ilSetting = $this->domain->settings();
        $ilObjDataCache = $this->domain->objectDataCache();
 
        // using long descriptions?
        $short_desc = $ilSetting->get("rep_shorten_description");
        $short_desc_max_length = (int) $ilSetting->get("rep_shorten_description_length");
        // using (part of) shortened description
        if ($short_desc && $short_desc_max_length && $short_desc_max_length < \ilObject::DESC_LENGTH) {
            foreach ($this->raw as $key => $object) {
                $this->raw[$key]["description"] = \ilStr::shortenTextExtended(
                    $object["description"],
                    $short_desc_max_length,
                    true
                );
            }
        }
        // using (part of) long description
        else {
            $obj_ids = array();
            foreach ($this->raw as $key => $object) {
                $obj_ids[] = $object["obj_id"];
            }
            if (count($obj_ids) > 0) {
                $long_desc = \ilObject::getLongDescriptions($obj_ids);
                foreach ($this->raw as $key => $object) {
                    // #12166 - keep translation, ignore long description
                    if ($ilObjDataCache->isTranslatedDescription((int) $object["obj_id"])) {
                        $long_desc[$object["obj_id"]] = $object["description"];
                    }
                    if ($short_desc && $short_desc_max_length) {
                        $long_desc[$object["obj_id"]] = \ilStr::shortenTextExtended(
                            (string) ($long_desc[$object["obj_id"]] ?? ""),
                            $short_desc_max_length,
                            true
                        );
                    }
                    $this->raw[$key]["description"] = $long_desc[$object["obj_id"]] ?? '';
                }
            }
        }
    }

References $ilSetting, ilObject\DESC_LENGTH, ilObject\getLongDescriptions(), ILIAS\Repository\int(), ILIAS\Repository\raw(), and ilStr\shortenTextExtended().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHiddenFilesFound()

ILIAS\Container\Content\ItemSetManager::getHiddenFilesFound ( )

Definition at line 82 of file class.ItemSetManager.php.

                                         : bool
    {
        return $this->hiddenfilesfound;
    }

References ILIAS\Container\Content\ItemSetManager\$hiddenfilesfound.

◆ getRawDataByRefId()

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

Definition at line 166 of file class.ItemSetManager.php.

                                                  : ?array
    {
        $this->init();
        return $this->raw_by_type["_all"][$ref_id] ?? null;
    }

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

Here is the call graph for this function:

◆ getRefIdsOfType()

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

Definition at line 149 of file class.ItemSetManager.php.

                                                 : array
    {
        $this->init();
        if (isset($this->raw_by_type[$type])) {
            return array_map(static function ($item) {
                return (int) $item["child"];
            }, $this->raw_by_type[$type]);
        }
        return [];
    }

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

Here is the call graph for this function:

◆ groupItems()

ILIAS\Container\Content\ItemSetManager::groupItems ( )

protected

Internally group all items.

Definition at line 191 of file class.ItemSetManager.php.

                                   : void
    {
        $obj_definition = $this->domain->objectDefinition();
        $classification_filter_active = $this->isClassificationFilterActive();
        $this->raw_by_type["_all"] = [];
        foreach ($this->raw as $key => $object) {
 
            // hide object types in devmode
            if ($object["type"] === "adm" || $object["type"] === "rolf" ||
                $obj_definition->getDevMode($object["type"])) {
                continue;
            }
 
            // remove inactive plugins
            if ($obj_definition->isInactivePlugin($object["type"])) {
                continue;
            }
 
            // BEGIN WebDAV: Don't display hidden Files, Folders and Categories
            /* this is an old webdav hack, which leads to issues in item groups
               these objects would be "invisible" but accessible (via url) which makes the behaviour very strange.
               They are hidden here, but shown in explorer trees and other places...
            if (in_array($object['type'], array('file','fold','cat'))) {
                if (\ilObjFileAccess::_isFileHidden($object['title'])) {
                    $this->setHiddenFilesFound(true);
                    if (!$this->admin_mode) {
                        continue;
                    }
                }
            }*/
            // END WebDAV: Don't display hidden Files, Folders and Categories
 
            // group object type groups together (e.g. learning resources)
            $type = $obj_definition->getGroupOfObj($object["type"]);
            if ($type == "") {
                $type = $object["type"];
            }
 
            $new_key = (int) $object["child"];
            $this->rendered[$new_key] = false;
            $this->raw_by_type[$type][$new_key] = $object;
 
            $this->raw_by_type["_all"][$new_key] = $object;
            if ($object["type"] !== "sess") {
                $this->raw_by_type["_non_sess"][$new_key] = $object;
            }
        }
    }

References ILIAS\Repository\int(), ILIAS\Container\Content\ItemSetManager\isClassificationFilterActive(), and ILIAS\Repository\raw().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasItems()

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

Todo:: from ilContainer, should be removed there

Definition at line 143 of file class.ItemSetManager.php.

                              : bool
    {
        $this->init();
        return count($this->raw) > 0;
    }

References ILIAS\Container\Content\ItemSetManager\init(), and ILIAS\Repository\raw().

Here is the call graph for this function:

◆ init()

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

protected

Todo:: from ilContainer, should be removed there

Definition at line 90 of file class.ItemSetManager.php.

                             : void
    {
        if ($this->initialised) {
            return;
        }
        $tree = $this->domain->repositoryTree();
        if ($this->mode === self::TREE) {
            $this->raw = $tree->getSubTree($tree->getNodeData($this->parent_ref_id));
        } elseif ($this->mode === self::FLAT) {
            $this->raw = $tree->getChilds($this->parent_ref_id, "title");
        } else {
            $this->raw[] = $tree->getNodeData($this->single_ref_id);
        }
        if ($this->include_objective_items) {
            $this->addObjectiveItems();
        }
        $this->applyUserFilter();
        $this->getCompleteDescriptions();
        $this->applyClassificationFilter();
        $this->getAdditionalSubItemInformation();
        $this->applySorting();
        $this->groupItems();
        $this->sortSessions();
        $this->preloadAdvancedMDValues();
        $this->initialised = true;
    }

Referenced by ILIAS\Container\Content\ItemSetManager\__construct(), ILIAS\Container\Content\ItemSetManager\getAllRefIds(), ILIAS\Container\Content\ItemSetManager\getRawDataByRefId(), ILIAS\Container\Content\ItemSetManager\getRefIdsOfType(), ILIAS\Container\Content\ItemSetManager\hasItems(), and ILIAS\Container\Content\ItemSetManager\isSideBlockItem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isClassificationFilterActive()

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

Todo:: from ilContainer, remove there

Definition at line 265 of file class.ItemSetManager.php.

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

References $classification, $id, and ilClassificationProvider\getValidProviders().

Referenced by ILIAS\Container\Content\ItemSetManager\groupItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSideBlockItem()

ILIAS\Container\Content\ItemSetManager::isSideBlockItem ( int $ref_id )

Definition at line 172 of file class.ItemSetManager.php.

                                                : bool
    {
        $this->init();
        $type = $this->raw_by_type["_all"][$ref_id]["type"] ?? "";
        $obj_definition = $this->domain->objectDefinition();
        return $obj_definition->isSideBlock($type);
    }

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

Here is the call graph for this function:

◆ preloadAdvancedMDValues()

ILIAS\Container\Content\ItemSetManager::preloadAdvancedMDValues ( )

protected

Definition at line 376 of file class.ItemSetManager.php.

                                                : void
    {
        $obj_ids = [];
        foreach ($this->raw_by_type["_all"] as $object) {
            $obj_ids[] = $object["obj_id"];
        }
        \ilAdvancedMDValues::preloadByObjIds($obj_ids);
    }

References ilAdvancedMDValues\preloadByObjIds().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHiddenFilesFound()

ILIAS\Container\Content\ItemSetManager::setHiddenFilesFound ( bool $a_hiddenfilesfound )

Definition at line 77 of file class.ItemSetManager.php.

                                                                 : void
    {
        $this->hiddenfilesfound = $a_hiddenfilesfound;
    }

◆ sortSessions()

ILIAS\Container\Content\ItemSetManager::sortSessions ( )

protected

Definition at line 240 of file class.ItemSetManager.php.

                                     : void
    {
        if (!$this->force_session_order_by_date) {
            return;
        }
        if (isset($this->raw_by_type["sess"]) && count($this->raw_by_type["sess"]) > 0) {
            $this->raw_by_type["sess"] = \ilArrayUtil::sortArray($this->raw_by_type["sess"], 'start', 'ASC', true, true);
        }
    }

References ilArrayUtil\sortArray().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $admin_mode

bool ILIAS\Container\Content\ItemSetManager::$admin_mode

protected

Definition at line 35 of file class.ItemSetManager.php.

Referenced by ILIAS\Container\Content\ItemSetManager\__construct().

◆ $domain

InternalDomainService ILIAS\Container\Content\ItemSetManager::$domain

protected

Definition at line 42 of file class.ItemSetManager.php.

Referenced by ILIAS\Container\Content\ItemSetManager\__construct().

◆ $force_session_order_by_date

bool ILIAS\Container\Content\ItemSetManager::$force_session_order_by_date

protected

Definition at line 34 of file class.ItemSetManager.php.

Referenced by ILIAS\Container\Content\ItemSetManager\__construct().

◆ $hiddenfilesfound

bool ILIAS\Container\Content\ItemSetManager::$hiddenfilesfound = false

protected

Definition at line 36 of file class.ItemSetManager.php.

Referenced by ILIAS\Container\Content\ItemSetManager\getHiddenFilesFound().

◆ $initialised

bool ILIAS\Container\Content\ItemSetManager::$initialised = false

protected

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

◆ $mode

int ILIAS\Container\Content\ItemSetManager::$mode = self::FLAT

protected

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

Referenced by ILIAS\Container\Content\ItemSetManager\__construct().

◆ $parent_obj_id

int ILIAS\Container\Content\ItemSetManager::$parent_obj_id

protected

Definition at line 38 of file class.ItemSetManager.php.

◆ $parent_ref_id

int ILIAS\Container\Content\ItemSetManager::$parent_ref_id = 0

protected

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

Referenced by ILIAS\Container\Content\ItemSetManager\__construct().

◆ $parent_type

string ILIAS\Container\Content\ItemSetManager::$parent_type

protected

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

◆ $raw

array ILIAS\Container\Content\ItemSetManager::$raw = []

protected

Definition at line 43 of file class.ItemSetManager.php.

◆ $raw_by_type

array ILIAS\Container\Content\ItemSetManager::$raw_by_type = []

protected

Definition at line 44 of file class.ItemSetManager.php.

◆ $rendered

array ILIAS\Container\Content\ItemSetManager::$rendered = []

protected

Definition at line 46 of file class.ItemSetManager.php.

◆ $single_ref_id

int ILIAS\Container\Content\ItemSetManager::$single_ref_id = 0

protected

Definition at line 41 of file class.ItemSetManager.php.

Referenced by ILIAS\Container\Content\ItemSetManager\__construct().

◆ $user_filter

ilContainerUserFilter ILIAS\Container\Content\ItemSetManager::$user_filter = null

protected

Definition at line 48 of file class.ItemSetManager.php.

Referenced by ILIAS\Container\Content\ItemSetManager\__construct().

◆ FLAT

const ILIAS\Container\Content\ItemSetManager::FLAT = 0

Definition at line 31 of file class.ItemSetManager.php.

Referenced by ILIAS\Container\Content\DomainService\itemSetFlat().

◆ SINGLE

const ILIAS\Container\Content\ItemSetManager::SINGLE = 2

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

◆ TREE

const ILIAS\Container\Content\ItemSetManager::TREE = 1

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

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

components/ILIAS/Container/Content/class.ItemSetManager.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAdditionalSubItemInformationToObject()

◆ addObjectiveItems()

◆ addToItems()

◆ applyClassificationFilter()

◆ applySorting()

◆ applyUserFilter()

◆ getAdditionalSubItemInformation()

◆ getAllRefIds()

◆ getCompleteDescriptions()

◆ getHiddenFilesFound()

◆ getRawDataByRefId()

◆ getRefIdsOfType()

◆ groupItems()

◆ hasItems()

◆ init()

◆ isClassificationFilterActive()

◆ isSideBlockItem()

◆ preloadAdvancedMDValues()

◆ setHiddenFilesFound()

◆ sortSessions()

Field Documentation

◆ $admin_mode

◆ $domain

◆ $force_session_order_by_date

◆ $hiddenfilesfound

◆ $initialised

◆ $mode

◆ $parent_obj_id

◆ $parent_ref_id

◆ $parent_type

◆ $raw

◆ $raw_by_type

◆ $rendered

◆ $single_ref_id

◆ $user_filter

◆ FLAT

◆ SINGLE

◆ TREE