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

Collaboration diagram for ilContainerRenderer:

Public Member Functions
	setBlockPrefixClosure (Closure $f)

	setBlockPostfixClosure (Closure $f)

	setItemHiddenClosure (Closure $f)

	setItemModifierClosure (Closure $f)

	addTypeBlock (string $a_type, ?string $a_prefix=null, ?string $a_postfix=null)

	hasTypeBlock (string $a_type)

	addCustomBlock ( $a_id, string $a_caption, ?string $a_actions=null, array $a_data=[])
	Add custom block. More...

	hasCustomBlock ($a_id)
	Custom block already exists? More...

	isValidBlock ($a_id)
	Any block with id exists? More...

	hideItem ($a_id)
	Mark item id as used, but do not render. More...

	removeItem ($a_id)
	Remove item (from any block) More...

	hasItem ($a_id)
	Item with id exists? More...

	addItemToBlock ( $a_block_id, string $a_item_type, $a_item_id, $a_item_html, bool $a_force=false)
	Add item to existing block. More...

	addItemId ($a_item_id)

	addShowMoreButton ($a_block_id)
	Add show more button to a block. More...

	addDetailsLevel (int $a_level, string $a_url, bool $a_active=false)

	resetDetails ()

	setBlockPosition ( $a_block_id, int $a_pos)

	getHTML ()

	renderSingleTypeBlock (string $a_type, bool $exhausted=false)

	renderSingleCustomBlock ($a_id)

	renderDetails (ilTemplate $a_tpl)

	getItemRenderer ()
	Render Item Block Sequence. More...

	renderItemBlockSequence (\ILIAS\Container\Content\ItemBlock\ItemBlockSequence $sequence)

Protected Member Functions
	getViewMode ()

	processBlockPositions ()

	renderHelperCustomBlock (ilTemplate $a_block_tpl, $a_block_id, bool $a_is_single=false, bool $is_exhausted=false)

	renderHelperTypeBlock (ilTemplate $a_block_tpl, string $a_type, bool $a_is_single=false, bool $is_exhausted=false)

	getViewModeOfItemGroup (int $ref_id)

	getListPresentationOfItemGroup (int $ref_id)

	renderHelperGeneric (ilTemplate $a_block_tpl, $a_block_id, array $a_block, bool $a_is_single=false, bool $is_exhausted=false)

	initBlockTemplate ()

	addHeaderRow (ilTemplate $a_tpl, string $a_type="", string $a_text="", ?array $a_types_in_block=null, string $a_commands_html="", string $a_order_id="", array $a_data=[])
	Render block header. More...

	addStandardRow (ilTemplate $a_tpl, string $a_html, ?string $a_item_id=null)

	renderSelectAllBlock (ilTemplate $a_tpl)
	Render "select all". More...

	addSeparatorRow (ilTemplate $a_tpl)

	getDownloadableTypes ()
	Get downloadable repository object types. More...

	renderContainerPage ()

	getDetailsLevel (int $a_item_id)

	addItemGroupBlock (string $block_id, int $block_pos=0)
	replaces ilContainerContentGUI::renderItemGroup More...

	getBlockPrefix ($block_id)

	getBlockPostfix ($block_id)

	isItemHidden (string $block_id, int $ref_id)

Protected Attributes
const	UNIQUE_SEPARATOR = "-"

ILIAS Container Content ItemManager	$item_manager

ilAccessHandler	$access

ilObjUser	$user

ILIAS Containter Content ObjectiveRenderer	$objective_renderer

ILIAS Containter Content ItemRenderer	$item_renderer

ILIAS Container Content ItemPresentationManager	$item_presentation

bool	$admin_panel

ilLanguage	$lng

ilSetting	$settings

ilObjectDefinition	$obj_definition

ilContainerGUI	$container_gui

bool	$enable_manage_select_all

bool	$enable_multi_download

bool	$active_block_ordering

array	$type_blocks = []

array	$custom_blocks = []

array	$items = []

array	$hidden_items = []

array	$block_items = []

array	$details = []

array	$item_ids = []

array	$rendered_blocks = []

int	$bl_cnt = 0

array	$block_pos = []

array	$block_custom_pos = []

int	$order_cnt = 0

array	$show_more = []

int	$view_mode

ILIAS DI UIServices	$ui

ilCtrl	$ctrl

Closure	$block_prefix_closure = null

Closure	$block_postfix_closure = null

Closure	$item_hidden_closure = null

Closure	$item_modifier_closure = null

ILIAS Container Content BlockSessionRepository	$block_repo

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 Class ilContainerRenderer

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Member Function Documentation

◆ addCustomBlock()

ilContainerRenderer::addCustomBlock	(		$a_id,
		string	$a_caption,
		?string	$a_actions = `null`,
		array	$a_data = `[]`
	)

Add custom block.

Parameters

mixed $a_id

Definition at line 189 of file class.ilContainerRenderer.php.

     : bool {
        if (!$this->hasCustomBlock($a_id)) {
            $this->custom_blocks[$a_id] = [
                "caption" => $a_caption
                ,"actions" => $a_actions
                ,"data" => $a_data
            ];
            return true;
        }
        return false;
    }

◆ addDetailsLevel()

ilContainerRenderer::addDetailsLevel	(	int	$a_level,
		string	$a_url,
		bool	$a_active = `false`
	)

Definition at line 346 of file class.ilContainerRenderer.php.

     : void {
        $this->details[$a_level] = [
            "url" => $a_url
            ,"active" => $a_active
        ];
    }

◆ addHeaderRow()

ilContainerRenderer::addHeaderRow	(	ilTemplate	$a_tpl,
		string	$a_type = `""`,
		string	$a_text = `""`,
		?array	$a_types_in_block = `null`,
		string	$a_commands_html = `""`,
		string	$a_order_id = `""`,
		array	$a_data = `[]`
	)

protected

Render block header.

Parameters

string $a_order_id item group id or type, e.g. "crs"

Exceptions

ilTemplateException

Definition at line 684 of file class.ilContainerRenderer.php.

     : void {
        $lng = $this->lng;
        $ilSetting = $this->settings;
        $objDefinition = $this->obj_definition;
 
        $a_tpl->setVariable("CB_ID", ' id="bl_cntr_' . (++$this->bl_cnt) . '"');
 
        if ($this->enable_manage_select_all) {
            $this->renderSelectAllBlock($a_tpl);
        } elseif ($this->enable_multi_download) {
            if ($a_type) {
                $a_types_in_block = [$a_type];
            }
            foreach ($a_types_in_block as $type) {
                if (in_array($type, $this->getDownloadableTypes(), true)) {
                    $this->renderSelectAllBlock($a_tpl);
                    break;
                }
            }
        }
 
        if ($a_text === "" && $a_type !== "") {
            if (!$objDefinition->isPlugin($a_type)) {
                $title = $lng->txt("objs_" . $a_type);
            } else {
                $pl = ilObjectPlugin::getPluginObjectByType($a_type);
                $title = $pl->txt("objs_" . $a_type);
            }
        } else {
            $title = $a_text;
        }
 
        if (is_array($a_data)) {
            foreach ($a_data as $k => $v) {
                $a_tpl->setCurrentBlock("cb_data");
                $a_tpl->setVariable("DATA_KEY", $k);
                $a_tpl->setVariable("DATA_VALUE", $v);
                $a_tpl->parseCurrentBlock();
 
                if ($k === "behaviour" && $v == ilItemGroupBehaviour::EXPANDABLE_CLOSED) {
                    $a_tpl->touchBlock("container_items_hide");
                }
            }
        }
 
        if ($a_type !== "" && $ilSetting->get("icon_position_in_lists") !== "item_rows") {
            $icon = ilUtil::getImagePath("standard/icon_" . $a_type . ".svg");
 
            $a_tpl->setCurrentBlock("container_header_row_image");
            $a_tpl->setVariable("HEADER_IMG", $icon);
            $a_tpl->setVariable("HEADER_ALT", $title);
        } else {
            $a_tpl->setCurrentBlock("container_header_row");
        }
 
        if ($a_order_id !== "") {
            /* blocks are ordered in page editor
            $a_tpl->setVariable("BLOCK_HEADER_ORDER_NAME", "position[blocks][" . $a_order_id . "]");
            $a_tpl->setVariable("BLOCK_HEADER_ORDER_NUM", (++$this->order_cnt) * 10);
            */
        }
 
        $presentation_title = $title;
        $sr_only = "";
        if (trim($title) === "") {
            $presentation_title = $this->lng->txt("cont_no_title");
            $sr_only = "sr-only";
        }
        $a_tpl->setVariable("BLOCK_HEADER_CONTENT", $presentation_title);
        $a_tpl->setVariable("SR_ONLY", $sr_only);
        $a_tpl->setVariable("CHR_COMMANDS", $a_commands_html);
        $a_tpl->parseCurrentBlock();
    }

◆ addItemGroupBlock()

ilContainerRenderer::addItemGroupBlock	(	string	$block_id,
		int	$block_pos = `0`
	)

protected

replaces ilContainerContentGUI::renderItemGroup

Definition at line 1061 of file class.ilContainerRenderer.php.

                                                                              : void
    {
        $item_data = $this->item_presentation->getRawDataByRefId((int) $block_id);
        $item_list_gui = $this->item_renderer->getItemGUI($item_data);
 
        $perm_ok = true;
        /*
        $ilAccess = $this->access;
        $ilUser = $this->user;
 
        // #16493
        $perm_ok = ($ilAccess->checkAccess("visible", "", $item_data['ref_id']) &&
            $ilAccess->checkAccess("read", "", $item_data['ref_id']));
 
        $items = ilObjectActivation::getItemsByItemGroup($item_data['ref_id']);
 
        // get all valid ids (this is filtered)
        $all_ids = array_map(static function (array $i) : int {
            return (int) $i["child"];
        }, $this->items["_all"]);
 
        // remove filtered items
        $items = array_filter($items, static function (array $i) use ($all_ids) : bool {
            return in_array($i["ref_id"], $all_ids);
        });
 
        // if no permission is given, set the items to "rendered" but
        // do not display the whole block
        if (!$perm_ok) {
            foreach ($items as $item) {
                $this->renderer->hideItem($item["child"]);
            }
            return;
        }
        */
 
        $item_list_gui->enableNotes(false);
        $item_list_gui->enableTags(false);
        $item_list_gui->enableComments(false);
        $item_list_gui->enableTimings(false);
        $item_list_gui->initItem(
            (int) $item_data["ref_id"],
            (int) $item_data["obj_id"],
            "itgr",
            $item_data["title"],
            $item_data["description"]
        );
        $commands_html = $item_list_gui->getCommandsHTML();
 
        // determine behaviour
        $item_group = new ilObjItemGroup($item_data["ref_id"]);
        $beh = $item_group->getBehaviour();
        $stored_val = $this->block_repo->getProperty(
            "itgr_" . $item_data["ref_id"],
            $this->user->getId(),
            "opened"
        );
        if ($stored_val !== "" && $beh !== ilItemGroupBehaviour::ALWAYS_OPEN) {
            $beh = ($stored_val === "1")
                ? ilItemGroupBehaviour::EXPANDABLE_OPEN
                : ilItemGroupBehaviour::EXPANDABLE_CLOSED;
        }
 
        $data = [
            "behaviour" => $beh,
            "store-url" => "./ilias.php?baseClass=ilcontainerblockpropertiesstoragegui&cmd=store" .
                "&cont_block_id=itgr_" . $item_data['ref_id']
        ];
        if (ilObjItemGroup::lookupHideTitle($item_data["obj_id"]) &&
            !$this->container_gui->isActiveAdministrationPanel()) {
            $this->addCustomBlock($block_id, "", $commands_html, $data);
        } else {
            $this->addCustomBlock($block_id, $item_data["title"], $commands_html, $data);
        }
    }

References $data, ilItemGroupBehaviour\ALWAYS_OPEN, ilItemGroupBehaviour\EXPANDABLE_CLOSED, ilItemGroupBehaviour\EXPANDABLE_OPEN, ilObjItemGroup\lookupHideTitle(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ addItemId()

ilContainerRenderer::addItemId ( $a_item_id )

Parameters

mixed $a_item_id

Definition at line 332 of file class.ilContainerRenderer.php.

                                         : void
    {
        $this->item_ids[$a_item_id] = true;
    }

◆ addItemToBlock()

ilContainerRenderer::addItemToBlock	(		$a_block_id,
		string	$a_item_type,
			$a_item_id,
			$a_item_html,
		bool	$a_force = `false`
	)

Add item to existing block.

Parameters

mixed	$a_block_id
mixed	$a_item_id
mixed	$a_item_html

Definition at line 295 of file class.ilContainerRenderer.php.

     : bool {
        if ($a_item_type !== "itgr" &&
            $this->isValidBlock($a_block_id) &&
            (!$this->hasItem($a_item_id) || $a_force)) {
            if (is_string($a_item_html) && trim($a_item_html) === "") {
                return false;
            }
            if (!$a_item_html) {
                return false;
            }
 
 
            // #16563 - item_id (== ref_id) is NOT unique, adding parent block id
            $uniq_id = $a_block_id . self::UNIQUE_SEPARATOR . $a_item_id;
 
            $this->items[$uniq_id] = [
                "type" => $a_item_type
                ,"html" => $a_item_html
            ];
 
            // #18326
            $this->addItemId($a_item_id);
            $this->block_items[$a_block_id][] = $uniq_id;
            return true;
        }
        return false;
    }

◆ addSeparatorRow()

ilContainerRenderer::addSeparatorRow ( ilTemplate $a_tpl )

protected

Definition at line 801 of file class.ilContainerRenderer.php.

                                                         : void
    {
        $a_tpl->setCurrentBlock("container_block");
        $a_tpl->parseCurrentBlock();
    }

References ilTemplate\parseCurrentBlock(), and ilTemplate\setCurrentBlock().

Here is the call graph for this function:

◆ addShowMoreButton()

ilContainerRenderer::addShowMoreButton ( $a_block_id )

Add show more button to a block.

Parameters

mixed $a_block_id

Definition at line 341 of file class.ilContainerRenderer.php.

                                                  : void
    {
        $this->show_more[] = $a_block_id;
    }

◆ addStandardRow()

ilContainerRenderer::addStandardRow	(	ilTemplate	$a_tpl,
		string	$a_html,
		?string	$a_item_id = `null`
	)

protected

Definition at line 766 of file class.ilContainerRenderer.php.

     : void {
        if ($a_item_id) {
            $a_tpl->setCurrentBlock("row");
            $a_tpl->setVariable("ROW_ID", 'id="item_row_' . $a_item_id . '"');
            $a_tpl->parseCurrentBlock();
        } else {
            $a_tpl->touchBlock("row");
        }
 
        $a_tpl->setCurrentBlock("container_standard_row");
        $a_tpl->setVariable("BLOCK_ROW_CONTENT", $a_html);
        $a_tpl->parseCurrentBlock();
 
        $a_tpl->touchBlock("container_row");
    }

References ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

◆ addTypeBlock()

ilContainerRenderer::addTypeBlock	(	string	$a_type,
		?string	$a_prefix = `null`,
		?string	$a_postfix = `null`
	)

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

     : bool {
        if ($a_type !== "itgr" &&
            !$this->hasTypeBlock($a_type)) {
            $this->type_blocks[$a_type] = [
                "prefix" => $a_prefix
                ,"postfix" => $a_postfix
            ];
            return true;
        }
        return false;
    }

◆ getBlockPostfix()

ilContainerRenderer::getBlockPostfix ( $block_id )

protected

Definition at line 1146 of file class.ilContainerRenderer.php.

                                                 : string
    {
        if ($this->block_postfix_closure instanceof Closure) {
            $c = $this->block_postfix_closure;
            return (string) $c($block_id);
        }
        return "";
    }

References $c.

◆ getBlockPrefix()

ilContainerRenderer::getBlockPrefix ( $block_id )

protected

Definition at line 1137 of file class.ilContainerRenderer.php.

                                                : string
    {
        if ($this->block_prefix_closure instanceof Closure) {
            $c = $this->block_prefix_closure;
            return (string) $c($block_id);
        }
        return "";
    }

References $c.

◆ getDetailsLevel()

ilContainerRenderer::getDetailsLevel ( int $a_item_id )

protected

Definition at line 840 of file class.ilContainerRenderer.php.

                                                      : int
    {
        if ($this->container_gui->isActiveAdministrationPanel()) {
            return ilContainerContentGUI::DETAILS_DEACTIVATED;
        }
        if ($this->item_manager->getExpanded($a_item_id) !== null) {
            return $this->item_manager->getExpanded($a_item_id);
        }
        /*if ($a_item_id === $this->force_details) {
            return ilContainerContentGUI::DETAILS_ALL;
        }*/
        return ilContainerContentGUI::DETAILS_TITLE;
    }

References ilContainerContentGUI\DETAILS_DEACTIVATED, and ilContainerContentGUI\DETAILS_TITLE.

◆ getDownloadableTypes()

ilContainerRenderer::getDownloadableTypes ( )

protected

Get downloadable repository object types.

Definition at line 810 of file class.ilContainerRenderer.php.

                                             : array
    {
        return ["fold", "file"];
    }

◆ getHTML()

ilContainerRenderer::getHTML ( )

Definition at line 379 of file class.ilContainerRenderer.php.

                             : string
    {
        $valid = false;
 
        $block_tpl = $this->initBlockTemplate();
 
        foreach ($this->processBlockPositions() as $block_id) {
            if (array_key_exists($block_id, $this->custom_blocks) && $this->renderHelperCustomBlock(
                $block_tpl,
                $block_id
            )) {
                $this->addSeparatorRow($block_tpl);
                $valid = true;
            }
            if (array_key_exists($block_id, $this->type_blocks) && $this->renderHelperTypeBlock(
                $block_tpl,
                $block_id
            )) {
                $this->addSeparatorRow($block_tpl);
                $valid = true;
            }
        }
 
        if ($valid) {
            $this->renderDetails($block_tpl);
 
            return $block_tpl->get();
        }
        return "";
    }

References $valid.

◆ getItemRenderer()

ilContainerRenderer::getItemRenderer ( )

Render Item Block Sequence.

Definition at line 830 of file class.ilContainerRenderer.php.

                                     : \ILIAS\Containter\Content\ItemRenderer
    {
        return $this->item_renderer;
    }

◆ getListPresentationOfItemGroup()

ilContainerRenderer::getListPresentationOfItemGroup ( int $ref_id )

protected

Definition at line 525 of file class.ilContainerRenderer.php.

                                                                  : string
    {
        $item_group = new ilObjItemGroup($ref_id);
        return $item_group->getListPresentation();
    }

References $ref_id.

◆ getViewMode()

ilContainerRenderer::getViewMode ( )

protected

Definition at line 155 of file class.ilContainerRenderer.php.

                                    : int
    {
        return $this->view_mode;
    }

References $view_mode.

◆ getViewModeOfItemGroup()

ilContainerRenderer::getViewModeOfItemGroup ( int $ref_id )

protected

Definition at line 513 of file class.ilContainerRenderer.php.

                                                          : int
    {
        $item_group = new ilObjItemGroup($ref_id);
        $view_mode = ilContainerContentGUI::VIEW_MODE_LIST;
        if ($item_group->getListPresentation() !== "") {
            $view_mode = ($item_group->getListPresentation() === "tile")
                ? ilContainerContentGUI::VIEW_MODE_TILE
                : ilContainerContentGUI::VIEW_MODE_LIST;
        }
        return $view_mode;
    }

References $ref_id, ilContainerContentGUI\VIEW_MODE_LIST, and ilContainerContentGUI\VIEW_MODE_TILE.

◆ hasCustomBlock()

ilContainerRenderer::hasCustomBlock ( $a_id )

Custom block already exists?

Parameters

mixed $a_id

Definition at line 210 of file class.ilContainerRenderer.php.

                                         : bool
    {
        return array_key_exists($a_id, $this->custom_blocks);
    }

◆ hasItem()

ilContainerRenderer::hasItem ( $a_id )

Item with id exists?

Parameters

mixed $a_id

Definition at line 282 of file class.ilContainerRenderer.php.

                                  : bool
    {
        return (array_key_exists($a_id, $this->item_ids) ||
            array_key_exists($a_id, $this->hidden_items));
    }

◆ hasTypeBlock()

ilContainerRenderer::hasTypeBlock ( string $a_type )

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

                                                : bool
    {
        return array_key_exists($a_type, $this->type_blocks);
    }

◆ hideItem()

ilContainerRenderer::hideItem ( $a_id )

Mark item id as used, but do not render.

Parameters

mixed $a_id

Definition at line 235 of file class.ilContainerRenderer.php.

                                   : void
    {
        // see hasItem();
        $this->hidden_items[$a_id] = true;
 
        // #16629 - do not remove hidden items from other blocks
        // $this->removeItem($a_id);
    }

◆ initBlockTemplate()

ilContainerRenderer::initBlockTemplate ( )

protected

Definition at line 674 of file class.ilContainerRenderer.php.

                                          : ilTemplate
    {
        return new ilTemplate("tpl.container_list_block.html", true, true, "components/ILIAS/Container");
    }

◆ isItemHidden()

ilContainerRenderer::isItemHidden	(	string	$block_id,
		int	$ref_id
	)

protected

Definition at line 1155 of file class.ilContainerRenderer.php.

                                                                  : bool
    {
        if ($this->item_hidden_closure instanceof Closure) {
            $c = $this->item_hidden_closure;
            return (bool) $c($block_id, $ref_id);
        }
        return false;
    }

References $c, and $ref_id.

◆ isValidBlock()

ilContainerRenderer::isValidBlock ( $a_id )

Any block with id exists?

Parameters

mixed $a_id

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

                                       : bool
    {
        return ($this->hasTypeBlock($a_id) ||
            $this->hasCustomBlock($a_id));
    }

◆ processBlockPositions()

ilContainerRenderer::processBlockPositions ( )

protected

Definition at line 437 of file class.ilContainerRenderer.php.

                                              : array
    {
        // manual order
        if (is_array($this->block_custom_pos) && count($this->block_custom_pos)) {
            $tmp = $this->block_pos;
            $this->block_pos = [];
            foreach ($this->block_custom_pos as $idx => $block_id) {
                if ($this->isValidBlock($block_id)) {
                    $this->block_pos[$block_id] = $idx;
                }
            }
 
            // at least some manual are valid
            if (count($this->block_pos)) {
                // append missing blocks from default order
                $last = max($this->block_pos);
                foreach (array_keys($tmp) as $block_id) {
                    if (!array_key_exists($block_id, $this->block_pos)) {
                        $this->block_pos[$block_id] = ++$last;
                    }
                }
            }
            // all manual invalid, use default
            else {
                $this->block_pos = $tmp;
            }
        }
 
        // add missing blocks to order
        $last = count($this->block_pos)
            ? max($this->block_pos)
            : 0;
        foreach (array_keys($this->custom_blocks) as $block_id) {
            if (!array_key_exists($block_id, $this->block_pos)) {
                $this->block_pos[$block_id] = ++$last;
            }
        }
        foreach (array_keys($this->type_blocks) as $block_id) {
            if (!array_key_exists($block_id, $this->block_pos)) {
                $this->block_pos[$block_id] = ++$last;
            }
        }
 
        asort($this->block_pos);
        return array_keys($this->block_pos);
    }

◆ removeItem()

ilContainerRenderer::removeItem ( $a_id )

Remove item (from any block)

Parameters

mixed $a_id

Definition at line 248 of file class.ilContainerRenderer.php.

                                     : void
    {
        if (!$this->hasItem($a_id)) {
            return;
        }
 
        unset($this->item_ids[$a_id], $this->hidden_items[$a_id]);
 
        foreach (array_keys($this->items) as $item_id) {
            $parts = explode(self::UNIQUE_SEPARATOR, $item_id);
            if (array_pop($parts) == $a_id) {
                unset($this->items[$item_id]);
            }
        }
 
        foreach ($this->block_items as $block_id => $items) {
            foreach ($items as $idx => $item_id) {
                $parts = explode(self::UNIQUE_SEPARATOR, $item_id);
                if (array_pop($parts) == $a_id) {
                    unset($this->block_items[$block_id][$idx]);
                    if (!count($this->block_items[$block_id])) {
                        unset($this->block_items[$block_id]);
                    }
                    break;
                }
            }
        }
    }

References $parts.

◆ renderContainerPage()

ilContainerRenderer::renderContainerPage ( )

protected

Definition at line 835 of file class.ilContainerRenderer.php.

                                            : string
    {
        return $this->container_gui->getContainerPageHTML();
    }

◆ renderDetails()

ilContainerRenderer::renderDetails ( ilTemplate $a_tpl )

Definition at line 815 of file class.ilContainerRenderer.php.

                                                    : void
    {
        $lng = $this->lng;
 
        if (count($this->details)) {
            $a_tpl->setCurrentBlock('container_details_row');
            $a_tpl->setVariable('TXT_DETAILS', $lng->txt('details'));
            $a_tpl->parseCurrentBlock();
        }
    }

References $lng, ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

◆ renderHelperCustomBlock()

ilContainerRenderer::renderHelperCustomBlock	(	ilTemplate	$a_block_tpl,
			$a_block_id,
		bool	$a_is_single = `false`,
		bool	$is_exhausted = `false`
	)

protected

Parameters

mixed $a_block_id

Definition at line 487 of file class.ilContainerRenderer.php.

     : bool {
        if ($this->hasCustomBlock($a_block_id)) {
            return $this->renderHelperGeneric($a_block_tpl, $a_block_id, $this->custom_blocks[$a_block_id], $a_is_single, $is_exhausted);
        }
        return false;
    }

◆ renderHelperGeneric()

ilContainerRenderer::renderHelperGeneric	(	ilTemplate	$a_block_tpl,
			$a_block_id,
		array	$a_block,
		bool	$a_is_single = `false`,
		bool	$is_exhausted = `false`
	)

protected

Parameters

mixed $a_block_id

Definition at line 534 of file class.ilContainerRenderer.php.

     : bool {
        $ctrl = $this->ctrl;
        if (!in_array($a_block_id, $this->rendered_blocks)) {
            $this->rendered_blocks[] = $a_block_id;
            $block_types = [];
            if (isset($this->block_items[$a_block_id]) && is_array($this->block_items[$a_block_id])) {
                foreach ($this->block_items[$a_block_id] as $item_id) {
                    if (isset($this->items[$item_id]["type"])) {
                        $block_types[] = $this->items[$item_id]["type"];
                    }
                }
            }
 
            // determine view mode and tile size
            $tile_size = ilContainer::TILE_SMALL;
            $view_mode = $this->getViewMode();
            if ($view_mode === ilContainerContentGUI::VIEW_MODE_TILE) {
                $tile_size = ilContainer::_lookupContainerSetting($this->container_gui->getObject()->getId(), "tile_size");
            }
            if (is_numeric($a_block_id)) {
                $item_group = new ilObjItemGroup($a_block_id);
                if ($item_group->getListPresentation() !== "") {
                    $view_mode = ($item_group->getListPresentation() === "tile" && !$this->active_block_ordering && !$this->admin_panel)
                        ? ilContainerContentGUI::VIEW_MODE_TILE
                        : ilContainerContentGUI::VIEW_MODE_LIST;
                    $tile_size = $item_group->getTileSize();
                }
            }
 
 
            // #14610 - manage empty item groups
            if ((isset($this->block_items[$a_block_id]) && is_array($this->block_items[$a_block_id])) ||
                is_numeric($a_block_id)) {
                $cards = [];
 
                $order_id = (!$a_is_single && $this->active_block_ordering)
                    ? $a_block_id
                    : "";
                $this->addHeaderRow(
                    $a_block_tpl,
                    $a_block["type"] ?? '',
                    $a_block["caption"] ?? '',
                    array_unique($block_types),
                    $a_block["actions"] ?? '',
                    $order_id,
                    $a_block["data"] ?? []
                );
 
                if ($view_mode === ilContainerContentGUI::VIEW_MODE_LIST) {
                    if (isset($a_block["prefix"]) && $a_block["prefix"]) {
                        $this->addStandardRow($a_block_tpl, $a_block["prefix"]);
                    }
                }
 
                if (isset($this->block_items[$a_block_id])) {
                    foreach ($this->block_items[$a_block_id] as $item_id) {
                        if ($view_mode === ilContainerContentGUI::VIEW_MODE_LIST) {
                            $this->addStandardRow($a_block_tpl, $this->items[$item_id]["html"], $item_id);
                        } else {
                            $cards[] = $this->items[$item_id]["html"];
                        }
                    }
                }
 
                if ($view_mode === ilContainerContentGUI::VIEW_MODE_LIST) {
                    if (isset($a_block["postfix"]) && $a_block["postfix"]) {
                        $this->addStandardRow($a_block_tpl, $a_block["postfix"]);
                    }
                }
 
                if ($view_mode === ilContainerContentGUI::VIEW_MODE_TILE) {
                    $f = $this->ui->factory();
                    $renderer = $this->ui->renderer();
 
                    //Create a deck with large cards
                    switch ($tile_size) {
                        case ilContainer::TILE_SMALL:
                            $deck = $f->deck($cards)->withSmallCardsSize();
                            break;
 
                        case ilContainer::TILE_LARGE:
                            $deck = $f->deck($cards)->withLargeCardsSize();
                            break;
 
                        case ilContainer::TILE_EXTRA_LARGE:
                            $deck = $f->deck($cards)->withExtraLargeCardsSize();
                            break;
 
                        case ilContainer::TILE_FULL:
                            $deck = $f->deck($cards)->withFullSizedCardsSize();
                            break;
 
                        default:
                            $deck = $f->deck($cards)->withNormalCardsSize();
                            break;
                    }
 
                    $html = $renderer->render($deck);
                    $a_block_tpl->setCurrentBlock("tile_rows");
                    $a_block_tpl->setVariable("TILE_ROWS", $html);
                    $a_block_tpl->parseCurrentBlock();
                }
                // show more
                if ($is_exhausted) {
                    $a_block_tpl->setCurrentBlock("show_more");
 
                    $ctrl->setParameter($this->container_gui, "type", $a_block_id);
                    $url = $ctrl->getLinkTarget($this->container_gui, "renderBlockAsynch", "", true);
                    $ctrl->setParameter($this->container_gui, "type", "");
 
                    $f = $this->ui->factory();
                    $renderer = $this->ui->renderer();
                    $button = $f->button()->standard($this->lng->txt("cont_show_more"), "")
                        ->withLoadingAnimationOnClick(true)
                        ->withOnLoadCode(function ($id) use ($a_block_id, $url) {
                            return "il.Container.initShowMore('$id', '$a_block_id', '" . $url . "');";
                        });
                    if ($ctrl->isAsynch()) {
                        $a_block_tpl->setVariable("SHOW_MORE_BUTTON", $renderer->renderAsync($button));
                    } else {
                        $a_block_tpl->setVariable("SHOW_MORE_BUTTON", $renderer->render($button));
                    }
                    $a_block_tpl->parseCurrentBlock();
                    $a_block_tpl->setCurrentBlock("show_more");
                    $a_block_tpl->parseCurrentBlock();
                }
 
                return true;
            }
        }
 
        return false;
    }

References Vendor\Package\$f, $id, $renderer, $url, ilContainer\_lookupContainerSetting(), ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), ilContainer\TILE_EXTRA_LARGE, ilContainer\TILE_FULL, ilContainer\TILE_LARGE, ilContainer\TILE_SMALL, ILIAS\Repository\ui(), ilContainerContentGUI\VIEW_MODE_LIST, and ilContainerContentGUI\VIEW_MODE_TILE.

Here is the call graph for this function:

◆ renderHelperTypeBlock()

ilContainerRenderer::renderHelperTypeBlock	(	ilTemplate	$a_block_tpl,
		string	$a_type,
		bool	$a_is_single = `false`,
		bool	$is_exhausted = `false`
	)

protected

Definition at line 499 of file class.ilContainerRenderer.php.

     : bool {
        if ($this->hasTypeBlock($a_type)) {
            $block = $this->type_blocks[$a_type];
            $block["type"] = $a_type;
            return $this->renderHelperGeneric($a_block_tpl, $a_type, $block, $a_is_single, $is_exhausted);
        }
        return false;
    }

◆ renderItemBlockSequence()

ilContainerRenderer::renderItemBlockSequence ( \ILIAS\Container\Content\ItemBlock\ItemBlockSequence $sequence )

Definition at line 854 of file class.ilContainerRenderer.php.

     : string {
        $valid = false;
 
        $page_html = $this->renderContainerPage();
        $block_tpl = $this->initBlockTemplate();
 
        $preloader = new ilObjectListGUIPreloader(ilObjectListGUI::CONTEXT_REPOSITORY);
        foreach ($this->item_presentation->getAllRefIds() as $ref_id) {
            $rd = $this->item_presentation->getRawDataByRefId($ref_id);
            $preloader->addItem($rd["obj_id"], $rd["type"], $ref_id);
            if ($rd["type"] === "sess") {
                $ev_items = ilObjectActivation::getItemsByEvent((int) $rd["obj_id"]);
                foreach ($ev_items as $ev_item) {
                    $preloader->addItem((int) $ev_item["obj_id"], $ev_item["type"], $ev_item["ref_id"]);
                }
            }
        }
        $preloader->preload();
 
        $embedded_block_ids = $this->item_presentation->getPageEmbeddedBlockIds();
        foreach ($sequence->getBlocks() as $block) {
            $block_id = "";
            $force_item_even_if_already_rendered = false;
            if ($block->getBlock() instanceof \ILIAS\Container\Content\ItemGroupBlock) {
                $block_id = (string) $block->getBlock()->getRefId();
                $force_item_even_if_already_rendered = true;
            }
            if ($block->getBlock() instanceof \ILIAS\Container\Content\TypeBlock) {
                $block_id = $block->getBlock()->getType();
                if ($block->getPageEmbedded()) {
                    $force_item_even_if_already_rendered = true;
                }
            }
            if ($block->getBlock() instanceof \ILIAS\Container\Content\SessionBlock) {
                $block_id = "sess";
            }
            if ($block->getBlock() instanceof \ILIAS\Container\Content\OtherBlock) {
                $block_id = "_other";
            }
            if ($block->getBlock() instanceof \ILIAS\Container\Content\ObjectivesBlock) {
                $block_id = "_lobj";
            }
 
            $position = 1;
            $pos_prefix = "";
 
            // (1) add block
            if ($block->getBlock() instanceof \ILIAS\Container\Content\ItemGroupBlock) {
                $this->addItemGroupBlock($block_id);
                $pos_prefix = "[itgr][" . \ilObject::_lookupObjId($block->getBlock()->getRefId()) . "]";
            }
            if ($block->getBlock() instanceof \ILIAS\Container\Content\OtherBlock) {
                $title = $this->item_presentation->filteredSubtree()
                    ? $this->lng->txt("cont_found_objects")
                    : $this->lng->txt("content");
                $this->addCustomBlock($block_id, $title);
            }
            if ($block->getBlock() instanceof \ILIAS\Container\Content\TypeBlock ||
                $block->getBlock() instanceof \ILIAS\Container\Content\SessionBlock) {
                $this->addTypeBlock(
                    $block_id,
                    $this->getBlockPrefix($block_id),
                    $this->getBlockPostfix($block_id)
                );
            }
 
            // (2) render and add items
            foreach ($block->getItemRefIds() as $ref_id) {
                if ($this->isItemHidden($block_id, $ref_id)) {
                    continue;
                }
                if (!$this->access->checkAccess('visible', '', $ref_id)) {
                    continue;
                }
 
                $item_data = $this->item_presentation->getRawDataByRefId($ref_id);
                if ($item_data === null) {
                    continue;
                }
                $checkbox = \ILIAS\Containter\Content\ItemRenderer::CHECKBOX_NONE;
                if ($this->container_gui->isActiveAdministrationPanel()) {
                    $checkbox = \ILIAS\Containter\Content\ItemRenderer::CHECKBOX_ADMIN;
                } elseif ($this->container_gui->isMultiDownloadEnabled()) {
                    $checkbox = \ILIAS\Containter\Content\ItemRenderer::CHECKBOX_DOWNLOAD;
                }
                $item_group_list_presentation = "";
                if ($block->getBlock() instanceof \ILIAS\Container\Content\ItemGroupBlock) {
                    if ($this->getListPresentationOfItemGroup((int) $block_id) === "tile") {
                        if (!$this->admin_panel && !$this->active_block_ordering) {
                            $item_group_list_presentation = "tile";
                        }
                    }
                    if ($this->getListPresentationOfItemGroup((int) $block_id) === "list") {
                        if (!$this->admin_panel && !$this->active_block_ordering) {
                            $item_group_list_presentation = "list";
                        }
                    }
                }
                $html = $this->item_renderer->renderItem(
                    $item_data,
                    $position++,
                    false,
                    $pos_prefix,
                    $item_group_list_presentation,
                    $checkbox,
                    $this->item_presentation->isActiveItemOrdering($item_data["type"]),
                    $this->getDetailsLevel($item_data["obj_id"])
                );
                if ($html != "") {
                    $this->addItemToBlock(
                        $block_id,
                        $item_data["type"],
                        $item_data["child"],
                        $html,
                        $force_item_even_if_already_rendered
                    );
                }
            }
 
            // (3) render blocks
            if ($block->getPageEmbedded()) {
                if ($block->getBlock() instanceof \ILIAS\Container\Content\TypeBlock ||
                    $block->getBlock() instanceof \ILIAS\Container\Content\SessionBlock) {
                    $page_html = preg_replace(
                        '~\[list-' . $block->getId() . '\]~i',
                        $this->renderSingleTypeBlock($block->getId(), $block->getLimitExhausted()),
                        $page_html
                    );
                    $valid = true;
                } elseif ($block->getBlock() instanceof \ILIAS\Container\Content\ItemGroupBlock) {
                    $page_html = preg_replace(
                        '~\[item-group-' . $block->getId() . '\]~i',
                        $this->renderSingleCustomBlock((int) $block->getId()),
                        $page_html
                    );
                    $valid = true;
                } elseif ($block->getBlock() instanceof \ILIAS\Container\Content\OtherBlock) {
                    $page_html = preg_replace(
                        '~\[list-_other\]~i',
                        $this->renderSingleCustomBlock($block->getId()),
                        $page_html
                    );
                    $valid = true;
                } elseif ($block->getBlock() instanceof \ILIAS\Container\Content\ObjectivesBlock) {
                    $page_html = preg_replace(
                        '~\[list-_lobj\]~i',
                        $this->objective_renderer->renderObjectives(),
                        $page_html
                    );
                    $valid = true;
                }
            } else {
                if ($block->getBlock() instanceof \ILIAS\Container\Content\ItemGroupBlock ||
                    $block->getBlock() instanceof \ILIAS\Container\Content\OtherBlock) {
                    if ($this->renderHelperCustomBlock($block_tpl, $block_id, false, $block->getLimitExhausted())) {
                        $this->addSeparatorRow($block_tpl);
                        $valid = true;
                    }
                }
                if ($block->getBlock() instanceof \ILIAS\Container\Content\TypeBlock ||
                    $block->getBlock() instanceof \ILIAS\Container\Content\SessionBlock) {
                    if ($this->renderHelperTypeBlock($block_tpl, $block_id, false, $block->getLimitExhausted())) {
                        $this->addSeparatorRow($block_tpl);
                        $valid = true;
                    }
                }
                if ($block->getBlock() instanceof \ILIAS\Container\Content\ObjectivesBlock) {
                    $this->objective_renderer->renderObjectives();
                    $block_tpl->setVariable(
                        "CONTENT",
                        $this->objective_renderer->getContent()
                    );
                    $this->addSeparatorRow($block_tpl);
                    $valid = true;
                }
            }
        }
 
        // remove embedded, but unrendered blocks
        foreach ($this->item_presentation->getPageEmbeddedBlockIds() as $id) {
            if (is_numeric($id)) {
                $page_html = preg_replace(
                    '~\[item-group-' . $id . '\]~i',
                    "",
                    $page_html
                );
            } else {
                $page_html = preg_replace(
                    '~\[list-' . $id . '\]~i',
                    "",
                    $page_html
                );
            }
        }
 
        if ($valid) {
            $this->renderDetails($block_tpl);
            return $page_html . $block_tpl->get();
        }
        return $page_html;
    }

◆ renderSelectAllBlock()

ilContainerRenderer::renderSelectAllBlock ( ilTemplate $a_tpl )

protected

Render "select all".

Definition at line 789 of file class.ilContainerRenderer.php.

                                                              : void
    {
        $lng = $this->lng;
 
        $a_tpl->setCurrentBlock("select_all_row");
        $a_tpl->setVariable("CHECKBOXNAME", "bl_cb_" . $this->bl_cnt);
        $a_tpl->setVariable("SEL_ALL_PARENT", "bl_cntr_" . $this->bl_cnt);
        $a_tpl->setVariable("SEL_ALL_PARENT", "bl_cntr_" . $this->bl_cnt);
        $a_tpl->setVariable("TXT_SELECT_ALL", $lng->txt("select_all"));
        $a_tpl->parseCurrentBlock();
    }

References $lng, ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

◆ renderSingleCustomBlock()

ilContainerRenderer::renderSingleCustomBlock ( $a_id )

Parameters

mixed $a_id

Definition at line 422 of file class.ilContainerRenderer.php.

                                                  : string
    {
        $block_tpl = $this->initBlockTemplate();
 
        if ($this->renderHelperCustomBlock($block_tpl, $a_id, true)) {
            return $block_tpl->get();
        }
        return "";
    }

◆ renderSingleTypeBlock()

ilContainerRenderer::renderSingleTypeBlock	(	string	$a_type,
		bool	$exhausted = `false`
	)

Definition at line 410 of file class.ilContainerRenderer.php.

                                                                                  : string
    {
        $block_tpl = $this->initBlockTemplate();
        if ($this->renderHelperTypeBlock($block_tpl, $a_type, true, $exhausted)) {
            return $block_tpl->get();
        }
        return "";
    }

◆ resetDetails()

ilContainerRenderer::resetDetails ( )

Definition at line 357 of file class.ilContainerRenderer.php.

                                  : void
    {
        $this->details = [];
    }

◆ setBlockPosition()

ilContainerRenderer::setBlockPosition	(		$a_block_id,
		int	$a_pos
	)

Parameters

mixed $a_block_id

Definition at line 370 of file class.ilContainerRenderer.php.

     : void {
        if ($this->isValidBlock($a_block_id)) {
            $this->block_pos[$a_block_id] = $a_pos;
        }
    }

◆ setBlockPostfixClosure()

ilContainerRenderer::setBlockPostfixClosure ( Closure $f )

Definition at line 139 of file class.ilContainerRenderer.php.

                                                      : void
    {
        $this->block_postfix_closure = $f;
    }

References Vendor\Package\$f.

◆ setBlockPrefixClosure()

ilContainerRenderer::setBlockPrefixClosure ( Closure $f )

Definition at line 134 of file class.ilContainerRenderer.php.

                                                     : void
    {
        $this->block_prefix_closure = $f;
    }

References Vendor\Package\$f.

◆ setItemHiddenClosure()

ilContainerRenderer::setItemHiddenClosure ( Closure $f )

Definition at line 144 of file class.ilContainerRenderer.php.

                                                    : void
    {
        $this->item_hidden_closure = $f;
    }

References Vendor\Package\$f.

◆ setItemModifierClosure()

ilContainerRenderer::setItemModifierClosure ( Closure $f )

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

                                                      : void
    {
        $this->item_renderer->setItemModifierClosure($f);
        $this->item_modifier_closure = $f;
    }