Collaboration diagram for ilContainerRenderer:

Public Member Functions
	__construct ($a_enable_manage_select_all=false, $a_enable_multi_download=false, $a_active_block_ordering=false, $a_block_custom_positions, $container_gui_obj, $a_view_mode=ilContainerContentGUI::VIEW_MODE_LIST)
	Constructor. More...

	addTypeBlock ($a_type, $a_prefix=null, $a_postfix=null)
	Add type block. More...

	hasTypeBlock ($a_type)
	Type block already exists? More...

	addCustomBlock ($a_id, $a_caption, $a_actions=null, $a_data=array())
	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, $a_item_type, $a_item_id, $a_item_html, $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 ($a_level, $a_url, $a_active=false)
	Add details level. More...

	resetDetails ()
	Reset/remove all detail levels. More...

	setBlockPosition ($a_block_id, $a_pos)
	Set block position. More...

	getHTML ()
	Get rendered html (of all blocks) More...

	renderSingleTypeBlock ($a_type)
	Get rendered html of single type block. More...

	renderSingleCustomBlock ($a_id)
	Get rendered html of single custom block. More...

	renderDetails (ilTemplate $a_tpl)
	Render detail level. More...

Data Fields
const	UNIQUE_SEPARATOR = "-"

Protected Member Functions
	getViewMode ()
	Get view mode. More...

	processBlockPositions ()
	Process block positions. More...

	renderHelperCustomBlock (ilTemplate $a_block_tpl, $a_block_id, $a_is_single=false)
	Render custom block. More...

	renderHelperTypeBlock (ilTemplate $a_block_tpl, $a_type, $a_is_single=false)
	Render type block. More...

	renderHelperGeneric (ilTemplate $a_block_tpl, $a_block_id, array $a_block, $a_is_single=false)
	Render block. More...

	initBlockTemplate ()
	Init template. More...

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

	addStandardRow (ilTemplate $a_tpl, $a_html, $a_ref_id=0)
	Render item row. More...

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

	addSeparatorRow (ilTemplate $a_tpl)
	Render separator row. More...

	resetRowType ()
	Reset internal row type. More...

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

Protected Attributes
	$lng

	$settings

	$obj_definition

	$enable_manage_select_all

	$enable_multi_download

	$active_block_ordering

	$type_blocks = array()

	$custom_blocks = array()

	$items = array()

	$hidden_items = array()

	$block_items = array()

	$details = array()

	$item_ids = array()

	$rendered_blocks = array()

	$bl_cnt = 0

	$cur_row_type

	$block_pos = array()

	$block_custom_pos = array()

	$order_cnt = 0

	$show_more = []

	$view_mode

	$ui

	$ctrl

Detailed Description

Class ilContainerRenderer.

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

Version

Id: class.ilContainerGUI.php 52026 2014-08-05 10:22:06Z smeyer

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

Constructor & Destructor Documentation

◆ __construct()

ilContainerRenderer::__construct	(	$a_enable_manage_select_all = `false`,
		$a_enable_multi_download = `false`,
		$a_active_block_ordering = `false`,
		$a_block_custom_positions,
		$container_gui_obj,
		$a_view_mode = `ilContainerContentGUI::VIEW_MODE_LIST`
	)

Constructor.

Parameters

bool	$a_enable_manage_select_all
bool	$a_enable_multi_download
bool	$a_active_block_ordering
array	$a_block_custom_positions

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->settings = $DIC->settings();
        $this->ui = $DIC->ui();
        $this->obj_definition = $DIC["objDefinition"];
        $this->enable_manage_select_all = (bool) $a_enable_manage_select_all;
        $this->enable_multi_download = (bool) $a_enable_multi_download;
        $this->active_block_ordering = (bool) $a_active_block_ordering;
        $this->block_custom_pos = $a_block_custom_positions;
        $this->view_mode = $a_view_mode;
        $this->container_gui = $container_gui_obj;
        $this->ctrl = $DIC->ctrl();
    }

References $DIC, settings(), and ui().

Here is the call graph for this function:

Member Function Documentation

◆ addCustomBlock()

ilContainerRenderer::addCustomBlock	(	$a_id,
		$a_caption,
		$a_actions = `null`,
		$a_data = `array()`
	)

Add custom block.

Parameters

mixed	$a_id
string	$a_caption
string	$a_actions	html snippet

Returns: boolean

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

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

References hasCustomBlock().

Here is the call graph for this function:

◆ addDetailsLevel()

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

Add details level.

Parameters

int	$a_level
string	$a_url
bool	$a_active

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

    {
        $this->details[$a_level] = array(
            "url" => $a_url
            ,"active" => (bool) $a_active
        );
    }

◆ addHeaderRow()

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

protected

Render block header.

Parameters

ilTemplate	$a_tpl
string	$a_type
string	$a_text
array	$a_types_in_block
string	$a_commands_html
int	$a_order_id

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

    {
        $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 = array($a_type);
            }
            foreach ($a_types_in_block as $type) {
                if (in_array($type, $this->getDownloadableTypes())) {
                    $this->renderSelectAllBlock($a_tpl);
                    break;
                }
            }
        }
                
        if ($a_text == "" && $a_type != "") {
            if (!$objDefinition->isPlugin($a_type)) {
                $title = $lng->txt("objs_" . $a_type);
            } else {
                include_once("./Services/Component/classes/class.ilPlugin.php");
                $pl = ilObjectPlugin::getPluginObjectByType($a_type);
                $title = $pl->txt("objs_" . $a_type);
            }
        } else {
            $title = $a_text;
        }
 
        include_once("./Modules/ItemGroup/classes/class.ilItemGroupBehaviour.php");
        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 ($ilSetting->get("icon_position_in_lists") != "item_rows" &&
            $a_type != "") {
            $icon = ilUtil::getImagePath("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) {
            $a_tpl->setVariable("BLOCK_HEADER_ORDER_NAME", "position[blocks][" . $a_order_id . "]");
            $a_tpl->setVariable("BLOCK_HEADER_ORDER_NUM", (++$this->order_cnt) * 10);
        }
        
        $a_tpl->setVariable("BLOCK_HEADER_CONTENT", $title);
        $a_tpl->setVariable("CHR_COMMANDS", $a_commands_html);
        $a_tpl->parseCurrentBlock();
        
        //$a_tpl->touchBlock("container_row");
        
        $this->resetRowType();
    }

References $ilSetting, $lng, $obj_definition, $settings, $type, ilItemGroupBehaviour\EXPANDABLE_CLOSED, getDownloadableTypes(), ilUtil\getImagePath(), ilObjectPlugin\getPluginObjectByType(), ilTemplate\parseCurrentBlock(), renderSelectAllBlock(), resetRowType(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilTemplate\touchBlock().

Referenced by renderHelperGeneric().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addItemId()

ilContainerRenderer::addItemId ( $a_item_id )

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

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

Referenced by addItemToBlock().

Here is the caller graph for this function:

◆ addItemToBlock()

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

Add item to existing block.

Parameters

mixed	$a_block_id
string	$a_item_type	repository object type
mixed	$a_item_id
string	$a_item_html	html snippet
bool	$a_force	enable multiple rendering

Returns: boolean

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

    {
        if ($this->isValidBlock($a_block_id) &&
            $a_item_type != "itgr" &&
            (!$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] = array(
                "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;
    }

References addItemId(), hasItem(), and isValidBlock().

Here is the call graph for this function:

◆ addSeparatorRow()

ilContainerRenderer::addSeparatorRow ( ilTemplate $a_tpl )

protected

Render separator row.

Parameters

ilTemplate $a_tpl

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

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

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

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addShowMoreButton()

ilContainerRenderer::addShowMoreButton ( $a_block_id )

Add show more button to a block.

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

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

◆ addStandardRow()

ilContainerRenderer::addStandardRow	(	ilTemplate	$a_tpl,
			$a_html,
			$a_ref_id = `0`
	)

protected

Render item row.

Parameters

ilTemplate	$a_tpl
string	$a_html
int	$a_ref_id

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

    {
        // :TODO: obsolete?
        $this->cur_row_type = ($this->cur_row_type == "row_type_1")
            ? "row_type_2"
            : "row_type_1";
 
        if ($a_ref_id > 0) {
            $a_tpl->setCurrentBlock($this->cur_row_type);
            $a_tpl->setVariable("ROW_ID", 'id="item_row_' . $a_ref_id . '"');
            $a_tpl->parseCurrentBlock();
        } else {
            $a_tpl->touchBlock($this->cur_row_type);
        }
        
        $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(), HTML_Template_IT\setVariable(), and ilTemplate\touchBlock().

Referenced by renderHelperGeneric().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addTypeBlock()

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

Add type block.

Parameters

string	$a_type	repository object type
string	$a_prefix	html snippet
string	$a_postfix	html snippet

Returns: boolean

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

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

References hasTypeBlock().

Here is the call graph for this function:

◆ getDownloadableTypes()

ilContainerRenderer::getDownloadableTypes ( )

protected

Get downloadable repository object types.

Returns: array

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

    {
        return array("fold", "file");
    }

Referenced by addHeaderRow().

Here is the caller graph for this function:

◆ getHTML()

ilContainerRenderer::getHTML ( )

Get rendered html (of all blocks)

Returns: string

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

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

References $valid, addSeparatorRow(), initBlockTemplate(), processBlockPositions(), renderDetails(), renderHelperCustomBlock(), and renderHelperTypeBlock().

Here is the call graph for this function:

◆ getViewMode()

ilContainerRenderer::getViewMode ( )

protected

Get view mode.

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

    {
        return $this->view_mode;
    }

References $view_mode.

Referenced by renderHelperGeneric().

Here is the caller graph for this function:

◆ hasCustomBlock()

ilContainerRenderer::hasCustomBlock ( $a_id )

Custom block already exists?

Parameters

mixed $a_id

Returns: bool

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

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

Referenced by addCustomBlock(), isValidBlock(), and renderHelperCustomBlock().

Here is the caller graph for this function:

◆ hasItem()

ilContainerRenderer::hasItem ( $a_id )

Item with id exists?

Parameters

mixed $a_id

Returns: bool

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

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

Referenced by addItemToBlock(), and removeItem().

Here is the caller graph for this function:

◆ hasTypeBlock()

ilContainerRenderer::hasTypeBlock ( $a_type )

Type block already exists?

Parameters

string $a_type repository object type

Returns: bool

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

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

Referenced by addTypeBlock(), isValidBlock(), and renderHelperTypeBlock().

Here is the caller graph for this function:

◆ hideItem()

ilContainerRenderer::hideItem ( $a_id )

Mark item id as used, but do not render.

Parameters

mixed $a_id

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

    {
        // 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

Init template.

Returns: ilTemplate

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

    {
        // :TODO: obsolete?
        $this->cur_row_type = "row_type_1";
 
        return new ilTemplate("tpl.container_list_block.html", true, true, "Services/Container");
    }

Referenced by getHTML(), renderSingleCustomBlock(), and renderSingleTypeBlock().

Here is the caller graph for this function:

◆ isValidBlock()

ilContainerRenderer::isValidBlock ( $a_id )

Any block with id exists?

Parameters

mixed $a_id

Returns: bool

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

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

References hasCustomBlock(), and hasTypeBlock().

Referenced by addItemToBlock(), processBlockPositions(), and setBlockPosition().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processBlockPositions()

ilContainerRenderer::processBlockPositions ( )

protected

Process block positions.

Returns: array block ids

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

    {
        // manual order
        if (is_array($this->block_custom_pos) && sizeof($this->block_custom_pos)) {
            $tmp = $this->block_pos;
            $this->block_pos = array();
            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 (sizeof($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 = sizeof($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);
    }

References $block_pos, and isValidBlock().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeItem()

ilContainerRenderer::removeItem ( $a_id )

Remove item (from any block)

Parameters

mixed $a_id

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

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

References $items, and hasItem().

Here is the call graph for this function:

◆ renderDetails()

ilContainerRenderer::renderDetails ( ilTemplate $a_tpl )

Render detail level.

Parameters

ilTemplate $a_tpl

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

    {
        $lng = $this->lng;
        
        if (sizeof($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().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderHelperCustomBlock()

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

protected

Render custom block.

Parameters

ilTemplate	$a_block_tpl
mixed	$a_block_id
bool	$a_is_single

Returns: boolean

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

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

References hasCustomBlock(), and renderHelperGeneric().

Referenced by getHTML(), and renderSingleCustomBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderHelperGeneric()

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

protected

Render block.

Parameters

ilTemplate	$a_block_tpl
mixed	$a_block_id
array	$a_block	block properties
bool	$a_is_single

Returns: boolean

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

    {
        $ctrl = $this->ctrl;
        if (!in_array($a_block_id, $this->rendered_blocks)) {
            $this->rendered_blocks[] = $a_block_id;
        
            $block_types = array();
            if (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"];
                    }
                }
            }
 
            // #14610 - manage empty item groups
            if (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
                    : null;
                $this->addHeaderRow($a_block_tpl, $a_block["type"], $a_block["caption"], array_unique($block_types), $a_block["actions"], $order_id, $a_block["data"]);
 
                if ($this->getViewMode() == ilContainerContentGUI::VIEW_MODE_LIST) {
                    if ($a_block["prefix"]) {
                        $this->addStandardRow($a_block_tpl, $a_block["prefix"]);
                    }
                }
 
                if (is_array($this->block_items[$a_block_id])) {
                    foreach ($this->block_items[$a_block_id] as $item_id) {
                        if ($this->getViewMode() == ilContainerContentGUI::VIEW_MODE_LIST) {
                            $this->addStandardRow($a_block_tpl, $this->items[$item_id]["html"], $item_id);
                        } else {
                            $cards[] = $this->items[$item_id]["html"];
                        }
                    }
                }
 
                if ($this->getViewMode() == ilContainerContentGUI::VIEW_MODE_LIST) {
                    if ($a_block["postfix"]) {
                        $this->addStandardRow($a_block_tpl, $a_block["postfix"]);
                    }
                }
 
                if ($this->getViewMode() == ilContainerContentGUI::VIEW_MODE_TILE) {
                    $f = $this->ui->factory();
                    $renderer = $this->ui->renderer();
 
                    //Create a deck with large cards
                    $deck = $f->deck($cards)->withNormalCardsSize();
                    //$deck = $f->deck($cards)->withSmallCardsSize();
 
 
                    $html = $renderer->render($deck);
                    $a_block_tpl->setCurrentBlock("tile_rows");
                    $a_block_tpl->setVariable("TILE_ROWS", $html);
                    $a_block_tpl->parseCurrentBlock();
                }
 
                // show more
                if (in_array($a_block_id, $this->show_more)) {
                    $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 $active_block_ordering, $ctrl, Vendor\Package\$f, $url, addHeaderRow(), addStandardRow(), getViewMode(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), ui(), ilContainerContentGUI\VIEW_MODE_LIST, and ilContainerContentGUI\VIEW_MODE_TILE.

Referenced by renderHelperCustomBlock(), and renderHelperTypeBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderHelperTypeBlock()

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

protected

Render type block.

Parameters

ilTemplate	$a_block_tpl
string	$a_type	repository object type
bool	$a_is_single

Returns: boolean

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

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

References hasTypeBlock(), and renderHelperGeneric().

Referenced by getHTML(), and renderSingleTypeBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderSelectAllBlock()

ilContainerRenderer::renderSelectAllBlock ( ilTemplate $a_tpl )

protected

Render "select all".

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

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

Referenced by addHeaderRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderSingleCustomBlock()

ilContainerRenderer::renderSingleCustomBlock ( $a_id )

Get rendered html of single custom block.

Parameters

mixed $a_id

Returns: html

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

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

References initBlockTemplate(), and renderHelperCustomBlock().

Here is the call graph for this function:

◆ renderSingleTypeBlock()

ilContainerRenderer::renderSingleTypeBlock ( $a_type )

Get rendered html of single type block.

Parameters

string $a_type repository object type

Returns: html

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

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

References initBlockTemplate(), and renderHelperTypeBlock().

Here is the call graph for this function:

◆ resetDetails()

ilContainerRenderer::resetDetails ( )

Reset/remove all detail levels.

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

    {
        $this->details = array();
    }

◆ resetRowType()

ilContainerRenderer::resetRowType ( )

protected

Reset internal row type.

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

    {
        // :TODO: obsolete?
        $this->cur_row_type = "";
    }

Referenced by addHeaderRow().

Here is the caller graph for this function:

◆ setBlockPosition()

ilContainerRenderer::setBlockPosition	(	$a_block_id,
		$a_pos
	)

Set block position.

Parameters

mixed	$a_block_id
int	$a_pos

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

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

References isValidBlock().

Here is the call graph for this function:

Field Documentation

◆ $active_block_ordering

ilContainerRenderer::$active_block_ordering

protected

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

Referenced by renderHelperGeneric().

◆ $bl_cnt

ilContainerRenderer::$bl_cnt = 0

protected

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

◆ $block_custom_pos

ilContainerRenderer::$block_custom_pos = array()

protected

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

◆ $block_items

ilContainerRenderer::$block_items = array()

protected

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

◆ $block_pos

ilContainerRenderer::$block_pos = array()

protected

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

Referenced by processBlockPositions().

◆ $ctrl

ilContainerRenderer::$ctrl

protected

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

Referenced by renderHelperGeneric().

◆ $cur_row_type

ilContainerRenderer::$cur_row_type

protected

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

◆ $custom_blocks

ilContainerRenderer::$custom_blocks = array()

protected

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

◆ $details

ilContainerRenderer::$details = array()

protected

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

◆ $enable_manage_select_all

ilContainerRenderer::$enable_manage_select_all

protected

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

◆ $enable_multi_download

ilContainerRenderer::$enable_multi_download

protected

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

◆ $hidden_items

ilContainerRenderer::$hidden_items = array()

protected

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

◆ $item_ids

ilContainerRenderer::$item_ids = array()

protected

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

◆ $items

ilContainerRenderer::$items = array()

protected

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

Referenced by removeItem().

◆ $lng

ilContainerRenderer::$lng

protected

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

Referenced by addHeaderRow(), renderDetails(), and renderSelectAllBlock().

◆ $obj_definition

ilContainerRenderer::$obj_definition

protected

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

Referenced by addHeaderRow().

◆ $order_cnt

ilContainerRenderer::$order_cnt = 0

protected

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

◆ $rendered_blocks

ilContainerRenderer::$rendered_blocks = array()

protected

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

◆ $settings

ilContainerRenderer::$settings

protected

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

Referenced by addHeaderRow().

◆ $show_more

ilContainerRenderer::$show_more = []

protected

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

◆ $type_blocks

ilContainerRenderer::$type_blocks = array()

protected

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

◆ $ui

ilContainerRenderer::$ui

protected

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

◆ $view_mode

ilContainerRenderer::$view_mode

protected

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

Referenced by getViewMode().

◆ UNIQUE_SEPARATOR

const ilContainerRenderer::UNIQUE_SEPARATOR = "-"

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

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

Services/Container/classes/class.ilContainerRenderer.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCustomBlock()

◆ addDetailsLevel()

◆ addHeaderRow()

◆ addItemId()

◆ addItemToBlock()

◆ addSeparatorRow()

◆ addShowMoreButton()

◆ addStandardRow()

◆ addTypeBlock()

◆ getDownloadableTypes()

◆ getHTML()

◆ getViewMode()

◆ hasCustomBlock()

◆ hasItem()

◆ hasTypeBlock()

◆ hideItem()

◆ initBlockTemplate()

◆ isValidBlock()

◆ processBlockPositions()

◆ removeItem()

◆ renderDetails()

◆ renderHelperCustomBlock()

◆ renderHelperGeneric()

◆ renderHelperTypeBlock()

◆ renderSelectAllBlock()

◆ renderSingleCustomBlock()

◆ renderSingleTypeBlock()

◆ resetDetails()

◆ resetRowType()

◆ setBlockPosition()

Field Documentation

◆ $active_block_ordering

◆ $bl_cnt

◆ $block_custom_pos

◆ $block_items

◆ $block_pos

◆ $ctrl

◆ $cur_row_type

◆ $custom_blocks

◆ $details

◆ $enable_manage_select_all

◆ $enable_multi_download

◆ $hidden_items

◆ $item_ids

◆ $items

◆ $lng

◆ $obj_definition

◆ $order_cnt

◆ $rendered_blocks

◆ $settings

◆ $show_more

◆ $type_blocks

◆ $ui

◆ $view_mode

◆ UNIQUE_SEPARATOR