Shows all items grouped by type. More...

Inheritance diagram for ilContainerByTypeContentGUI:

Collaboration diagram for ilContainerByTypeContentGUI:

Public Member Functions
	__construct ($container_gui_obj, \ilContainerUserFilter $container_user_filter=null)
	Constructor. More...

	getDetailsLevel ($a_session_id)
	get details level More...

	getMainContent ()
	Get content HTML for main column. More...

	renderItemList ()
	Render Items. More...

Public Member Functions inherited from ilContainerContentGUI
	__construct (&$container_gui_obj)
	Constructor. More...

	getContainerObject ()
	Get container object. More...

	getContainerGUI ()
	Get container GUI object. More...

	setOutput ()
	Sets view output into column layout. More...

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

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

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

	getEmbeddedBlocks ()
	Get page embedded blocks. More...

	renderPageEmbeddedBlocks ()
	Render Page Embedded Blocks. More...

	renderItem ($a_item_data, $a_position=0, $a_force_icon=false, $a_pos_prefix="")
	Render an item. More...

	renderCard ($a_item_data, $a_position=0, $a_force_icon=false, $a_pos_prefix="")
	Render card. More...

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

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

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

	getIntroduction ()
	Get introduction. More...

	getItemGroupsHTML ($a_pos=0)
	Get item groups HTML. More...

	renderItemGroup ($a_itgr)
	Render item group. More...

Protected Member Functions
	initDetails ()
	init details More...

Protected Member Functions inherited from ilContainerContentGUI
	getViewMode ()
	Get view mode. More...

	getDetailsLevel ($a_item_id)
	get details level More...

	getRightColumnHTML ()
	Get HTML for right column. More...

	getCenterColumnHTML ()
	Get HTML for center column. More...

	initRenderer ()
	Init container renderer. More...

	clearAdminCommandsDetermination ()
	cleaer administration commands determination More...

	determineAdminCommands ($a_ref_id, $a_admin_com_included_in_list=false)
	determin admin commands More...

	getItemGUI ($item_data, $a_show_path=false)
	Get ListGUI object for item. More...

	hasForcedOrderByStartDate (string $type)

Protected Attributes
	$access

	$user

	$force_details

	$block_limit

	$container_user_filter

Protected Attributes inherited from ilContainerContentGUI
	$tpl

	$ctrl

	$user

	$lng

	$access

	$plugin_admin

	$db

	$rbacsystem

	$settings

	$obj_definition

	$details_level = self::DETAILS_DEACTIVATED

	$renderer

	$log

	$view_mode

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

	$container_gui

	$container_obj

Detailed Description

Shows all items grouped by type.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

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

References $container_user_filter, $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilContainer\_lookupContainerSetting(), initDetails(), and user().

     {
         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->object->getId(), "block_limit");
         $this->container_user_filter = $container_user_filter;
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDetailsLevel()

ilContainerByTypeContentGUI::getDetailsLevel ( $a_session_id )

get details level

public

Parameters

int $a_session_id

Returns: int DEATAILS_LEVEL

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

References $_SESSION, and ilContainerContentGUI\getContainerGUI().

     {
         if ($this->getContainerGUI()->isActiveAdministrationPanel()) {
             return self::DETAILS_DEACTIVATED;
         }
         if (isset($_SESSION['sess']['expanded'][$a_session_id])) {
             return $_SESSION['sess']['expanded'][$a_session_id];
         }
         if ($a_session_id == $this->force_details) {
             return self::DETAILS_ALL;
         } else {
             return self::DETAILS_TITLE;
         }
     }

Here is the call graph for this function:

◆ getMainContent()

ilContainerByTypeContentGUI::getMainContent ( )

Get content HTML for main column.

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

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

     {
         $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();
             $tpl->setVariable("CONTAINER_PAGE_CONTENT", $html);
         } else {        // show item list otherwise
             $html = $this->renderItemList();
             $tpl->setVariable("CONTAINER_PAGE_CONTENT", $html);
         }
 
         return $tpl->get();
     }

Here is the call graph for this function:

◆ initDetails()

ilContainerByTypeContentGUI::initDetails ( )

protected

init details

protected

Parameters

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

References $_GET, $_SESSION, $ilUser, $session, $user, ilContainerContentGUI\getContainerObject(), ilSessionAppointment\lookupLastSessionByCourse(), and ilSessionAppointment\lookupNextSessionByCourse().

Referenced by __construct().

     {
         $ilUser = $this->user;
         
         if ($_GET['expand']) {
             if ($_GET['expand'] > 0) {
                 $_SESSION['sess']['expanded'][abs((int) $_GET['expand'])] = self::DETAILS_ALL;
             } else {
                 $_SESSION['sess']['expanded'][abs((int) $_GET['expand'])] = self::DETAILS_TITLE;
             }
         }
         
         
         if ($this->getContainerObject()->getType() == 'crs') {
             include_once('./Modules/Session/classes/class.ilSessionAppointment.php');
             if ($session = ilSessionAppointment::lookupNextSessionByCourse($this->getContainerObject()->getRefId())) {
                 $this->force_details = $session;
             } elseif ($session = ilSessionAppointment::lookupLastSessionByCourse($this->getContainerObject()->getRefId())) {
                 $this->force_details = $session;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderItemList()

ilContainerByTypeContentGUI::renderItemList ( )

Render Items.

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

References $type, ilContainerContentGUI\clearAdminCommandsDetermination(), ilContainerContentGUI\getContainerGUI(), ilContainerContentGUI\getGroupedObjTypes(), ilContainerContentGUI\getItemGroupsHTML(), ilContainerContentGUI\initRenderer(), ilContainerContentGUI\insertPageEmbeddedBlocks(), and ilContainerContentGUI\renderItem().

Referenced by getMainContent().

     {
         include_once("Services/Object/classes/class.ilObjectListGUIFactory.php");
     
         $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 (is_array($this->items[$type]) &&
                 $this->renderer->addTypeBlock($type)) {
                 $this->renderer->setBlockPosition($type, ++$pos);
                 
                 $position = 1;
                 
                 foreach ($this->items[$type] as $item_data) {
                     $item_ref_id = $item_data["child"];
                     if ($this->block_limit > 0 && !$this->getContainerGUI()->isActiveItemOrdering() && $position == $this->block_limit + 1) {
                         if ($position == $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 != "") {
                             $position++;
                             $this->renderer->addItemToBlock($type, $item_data["type"], $item_ref_id, $html);
                         }
                     }
                 }
             }
         }
         
         $output_html .= $this->renderer->getHTML();
         
         return $output_html;
     }