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

Inheritance diagram for ilContainerByTypeContentGUI:

Collaboration diagram for ilContainerByTypeContentGUI:

Public Member Functions
	__construct (ilContainerGUI $container_gui_obj, ilContainerUserFilter $container_user_filter=null)

	getMainContent ()
	Get content HTML for main column, this one must be overwritten in derived classes. More...

	renderItemList ()

Public Member Functions inherited from ilContainerContentGUI
	getContainerObject ()

	getContainerGUI ()

	setOutput ()
	This method sets the output of the right and main column in the global standard template. More...

	getMainContent ()
	Get content HTML for main column, this one must be overwritten in derived classes. More...

	determinePageEmbeddedBlocks (string $a_container_page_html)
	Determine all blocks that are embedded in the container page. More...

	addEmbeddedBlock (string $block_type, $block_parameter)
	Add embedded block. More...

	getEmbeddedBlocks ()

	renderPageEmbeddedBlocks ()

	renderItem (array $a_item_data, int $a_position=0, bool $a_force_icon=false, string $a_pos_prefix="", string $item_group_list_presentation="")
	Render an item. More...

	renderCard (array $a_item_data, int $a_position=0, bool $a_force_icon=false, string $a_pos_prefix="")

	insertPageEmbeddedBlocks (string $a_output_html)
	Insert blocks into container page. More...

	getSingleTypeBlockAsynch (string $type)
	Render single block. More...

	getGroupedObjTypes ()
	Get grouped repository object types. More...

	getIntroduction ()

	getItemGroupsHTML (int $a_pos=0)

	renderItemGroup (array $a_itgr)

Protected Member Functions
	getDetailsLevel (int $a_item_id)

	initDetails ()

Protected Member Functions inherited from ilContainerContentGUI
	getViewMode ()

	getDetailsLevel (int $a_item_id)

	getRightColumnHTML ()

	getCenterColumnHTML ()

	initRenderer ()
	Init container renderer. More...

	clearAdminCommandsDetermination ()

	determineAdminCommands (int $a_ref_id, bool $a_admin_com_included_in_list=false)

	getItemGUI (array $item_data)

	hasForcedOrderByStartDate (string $type)

	handleSessionExpand ()

Protected Attributes
	$force_details = null

int	$block_limit

ilContainerUserFilter	$container_user_filter

Protected Attributes inherited from ilContainerContentGUI
ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilObjUser	$user

ilLanguage	$lng

ilAccessHandler	$access

ilDBInterface	$db

ilRbacSystem	$rbacsystem

ilSetting	$settings

ilObjectDefinition	$obj_definition

int	$details_level = self::DETAILS_DEACTIVATED

ilContainerRenderer	$renderer

ilLogger	$log

int	$view_mode

array	$embedded_block = []

array	$items = []

array	$list_gui = []

ClipboardManager	$clipboard

StandardGUIRequest	$request

ItemManager	$item_manager

BlockSessionRepository	$block_repo

Additional Inherited Members
Data Fields inherited from ilContainerContentGUI
const	DETAILS_DEACTIVATED = 0

const	DETAILS_TITLE = 1

const	DETAILS_ALL = 2

const	VIEW_MODE_LIST = 0

const	VIEW_MODE_TILE = 1

ilContainerGUI	$container_gui

ilContainer	$container_obj

bool	$adminCommands = false

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 Shows all items grouped by type.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilContainerByTypeContentGUI::__construct	(	ilContainerGUI	$container_gui_obj,
		ilContainerUserFilter	$container_user_filter = `null`
	)

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

      {
        global $DIC;
 
        $this->access = $DIC->access();
        $this->user = $DIC->user();
        parent::__construct($container_gui_obj);
        $this->initDetails();
        $this->block_limit = (int) ilContainer::_lookupContainerSetting($container_gui_obj->getObject()->getId(), "block_limit");
        $this->container_user_filter = $container_user_filter;
    }

References $container_user_filter, $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilContainer\_lookupContainerSetting(), ILIAS\Repository\access(), ilObjectGUI\getObject(), initDetails(), ILIAS\Repository\int(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ getDetailsLevel()

ilContainerByTypeContentGUI::getDetailsLevel ( int $a_item_id )

protected

Reimplemented from ilContainerContentGUI.

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

                                                      : int
    {
        if ($this->getContainerGUI()->isActiveAdministrationPanel()) {
            return self::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 self::DETAILS_ALL;
        }
 
        return self::DETAILS_TITLE;
    }

References ilContainerContentGUI\DETAILS_ALL, ilContainerContentGUI\DETAILS_DEACTIVATED, ilContainerContentGUI\DETAILS_TITLE, and ilContainerContentGUI\getContainerGUI().

Here is the call graph for this function:

◆ getMainContent()

ilContainerByTypeContentGUI::getMainContent ( )

Get content HTML for main column, this one must be overwritten in derived classes.

Reimplemented from ilContainerContentGUI.

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

                                    : string
    {
        $ilAccess = $this->access;
 
        $tpl = new ilTemplate(
            "tpl.container_page.html",
            true,
            true,
            "Services/Container"
        );
 
        // get all sub items
        $this->items = $this->getContainerObject()->getSubItems(
            $this->getContainerGUI()->isActiveAdministrationPanel(),
            false,
            0,
            $this->container_user_filter
        );
 
        //$this->items = $this->applyFilterToItems($this->items);
 
        // Show introduction, if repository is empty
        // @todo: maybe we move this
        if ((!is_array($this->items) || count($this->items) === 0) &&
            $this->getContainerObject()->getRefId() === ROOT_FOLDER_ID &&
            $ilAccess->checkAccess("write", "", $this->getContainerObject()->getRefId())) {
            $html = $this->getIntroduction();
        } else {        // show item list otherwise
            $html = $this->renderItemList();
        }
        $tpl->setVariable("CONTAINER_PAGE_CONTENT", $html);
 
        return $tpl->get();
    }

References ilContainerContentGUI\$access, ilContainerContentGUI\$tpl, ilGlobalTemplateInterface\get(), ilContainerContentGUI\getContainerGUI(), ilContainerContentGUI\getContainerObject(), ilContainerContentGUI\getIntroduction(), renderItemList(), ROOT_FOLDER_ID, and ilGlobalTemplateInterface\setVariable().

Here is the call graph for this function:

◆ initDetails()

ilContainerByTypeContentGUI::initDetails ( )

protected

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

                                    : void
    {
        $this->handleSessionExpand();
 
        if ($this->getContainerObject()->getType() === 'crs') {
            if ($session = ilSessionAppointment::lookupNextSessionByCourse($this->getContainerObject()->getRefId())) {
                $this->force_details = $session;
            } elseif ($session = ilSessionAppointment::lookupLastSessionByCourse($this->getContainerObject()->getRefId())) {
                $this->force_details = $session;
            }
        }
    }

References $session, ilContainerContentGUI\getContainerObject(), ilContainerContentGUI\handleSessionExpand(), ilSessionAppointment\lookupLastSessionByCourse(), and ilSessionAppointment\lookupNextSessionByCourse().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderItemList()

ilContainerByTypeContentGUI::renderItemList ( )

Definition at line 97 of file class.ilContainerByTypeContentGUI.php.

                                    : string
    {
        $this->clearAdminCommandsDetermination();
 
        $this->initRenderer();
 
        // text/media page content
        $output_html = $this->getContainerGUI()->getContainerPageHTML();
 
        // get embedded blocks
        if ($output_html !== "") {
            $output_html = $this->insertPageEmbeddedBlocks($output_html);
        }
 
        // item groups
        $pos = $this->getItemGroupsHTML();
 
        // iterate all types
        foreach ($this->getGroupedObjTypes() as $type => $v) {
            if (isset($this->items[$type]) && is_array($this->items[$type]) &&
                $this->renderer->addTypeBlock($type)) {
                $this->renderer->setBlockPosition($type, ++$pos);
 
                $position = 1;
                $counter = 1;
                foreach ($this->items[$type] as $item_data) {
                    $item_ref_id = $item_data["child"];
 
                    if ($this->block_limit > 0 && $counter == $this->block_limit + 1 && !$this->getContainerGUI()->isActiveItemOrdering()) {
                        if ($counter == $this->block_limit + 1) {
                            // render more button
                            $this->renderer->addShowMoreButton($type);
                        }
                        continue;
                    }
 
                    if (!$this->renderer->hasItem($item_ref_id)) {
                        $html = $this->renderItem($item_data, $position++);
                        if ($html != "") {
                            $counter++;
                            $this->renderer->addItemToBlock($type, $item_data["type"], $item_ref_id, $html);
                        }
                    }
                }
            }
        }
 
        $output_html .= $this->renderer->getHTML();
 
        return $output_html;
    }