ILIAS\Container\Content\ItemSetManager Class Reference

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)
	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 ()
	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 26 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
	)

Parameters

int

$mode

self::TREE|self::FLAT|self::SINGLE

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

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().

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

Here is the call graph for this function:

Member Function Documentation

addAdditionalSubItemInformationToObject()

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

protected

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

References ilObjectActivation\addAdditionalSubItemInformation().

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

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

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 324 of file class.ItemSetManager.php.

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

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

                                                  : 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));
                });
            }
        }
    }

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 150 of file class.ItemSetManager.php.

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

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

                                     : 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);
    }

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

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

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

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

                                        : 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();
    }

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 217 of file class.ItemSetManager.php.

References ILIAS\LTI\ToolProvider\$key, ILIAS\Container\Content\ItemSetManager\addAdditionalSubItemInformationToObject(), and ILIAS\Repository\raw().

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

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

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 130 of file class.ItemSetManager.php.

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

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

Here is the call graph for this function:

getCompleteDescriptions()

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

protected

From ilContainer.

Todo:

remove there

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

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

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

                                                : 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");
        if (!$short_desc || $short_desc_max_length != \ilObject::DESC_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"]] ?? '';
                    }
                }
            }
        }
    }

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 78 of file class.ItemSetManager.php.

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

                                         : bool
    {
        return $this->hiddenfilesfound;
    }

getRawDataByRefId()

ILIAS\Container\Content\ItemSetManager::getRawDataByRefId

(

int

$ref_id

)

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

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

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

Here is the call graph for this function:

getRefIdsOfType()

ILIAS\Container\Content\ItemSetManager::getRefIdsOfType

(

string

$type

)

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

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

                                                 : 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 [];
    }

Here is the call graph for this function:

groupItems()

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

protected

Internally group all items.

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

References ILIAS\LTI\ToolProvider\$key, ilObjFileAccess\_isFileHidden(), ILIAS\Repository\int(), ILIAS\Container\Content\ItemSetManager\isClassificationFilterActive(), ILIAS\Repository\raw(), and ILIAS\Container\Content\ItemSetManager\setHiddenFilesFound().

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

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

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 113 of file class.ItemSetManager.php.

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

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

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 86 of file class.ItemSetManager.php.

References ILIAS\Container\Content\ItemSetManager\applyClassificationFilter(), ILIAS\Container\Content\ItemSetManager\applySorting(), ILIAS\Container\Content\ItemSetManager\applyUserFilter(), ILIAS\Container\Content\ItemSetManager\getAdditionalSubItemInformation(), ILIAS\Container\Content\ItemSetManager\getCompleteDescriptions(), ILIAS\Container\Content\ItemSetManager\groupItems(), ILIAS\Container\Content\ItemSetManager\preloadAdvancedMDValues(), ILIAS\Repository\raw(), and ILIAS\Container\Content\ItemSetManager\sortSessions().

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().

                             : 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);
        }
        $this->applyUserFilter();
        $this->getCompleteDescriptions();
        $this->applyClassificationFilter();
        $this->getAdditionalSubItemInformation();
        $this->applySorting();
        $this->groupItems();
        $this->sortSessions();
        $this->preloadAdvancedMDValues();
        $this->initialised = true;
    }

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

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

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

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

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 142 of file class.ItemSetManager.php.

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

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

Here is the call graph for this function:

preloadAdvancedMDValues()

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

protected

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

References ilAdvancedMDValues\preloadByObjIds().

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

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

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 73 of file class.ItemSetManager.php.

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

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

Here is the caller graph for this function:

sortSessions()

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

protected

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

References ilArrayUtil\sortArray().

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

                                     : 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);
        }
    }

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 32 of file class.ItemSetManager.php.

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

$domain

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

protected

Definition at line 39 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 31 of file class.ItemSetManager.php.

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

$hiddenfilesfound

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

protected

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

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

$initialised

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

protected

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

$mode

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

protected

Definition at line 44 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 35 of file class.ItemSetManager.php.

$parent_ref_id

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

protected

Definition at line 37 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 34 of file class.ItemSetManager.php.

$raw

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

protected

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

$raw_by_type

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

protected

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

$rendered

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

protected

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

$single_ref_id

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

protected

Definition at line 38 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 45 of file class.ItemSetManager.php.

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

FLAT

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

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

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

SINGLE

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

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

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

TREE

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

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

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

---

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

• Services/Container/Content/class.ItemSetManager.php