ilContainerSessionsContentGUI Class Reference

Shows all items in one block. More...

Inheritance diagram for ilContainerSessionsContentGUI:

Collaboration diagram for ilContainerSessionsContentGUI:

Public Member Functions
	__construct ($container_gui_obj)
	Constructor. More...
	getDetailsLevel ($a_session_id)
	get details level More...
	getMainContent ()
	Get content HTML for main column. More...
	__showMaterials ($a_tpl)
	Show Materials. More...
	addFooterRow ($tpl)
	add footer row 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...

Static Public Member Functions
static	prepareSessionPresentationLimitation (array $items, ilContainer $container, bool $admin_panel_enabled=false, bool $include_side_block=false)

Protected Member Functions
	renderSessionLimitLink ($a_previous=true)
	Show link to show/hide all previous/next sessions. More...
	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
	$tabs
	$force_details = array()
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 in one block.

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.ilContainerSessionsContentGUI.php.

Constructor & Destructor Documentation

__construct()

ilContainerSessionsContentGUI::__construct

(

$container_gui_obj

)

Constructor.

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

References $DIC, ilContainerContentGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), initDetails(), and user().

    {
        global $DIC;

        $this->tabs = $DIC->tabs();
        $this->user = $DIC->user();
        $this->ctrl = $DIC->ctrl();
        $lng = $DIC->language();
        
        parent::__construct($container_gui_obj);
        $this->lng = $lng;
        $this->initDetails();
    }

Here is the call graph for this function:

Member Function Documentation

__showMaterials()

ilContainerSessionsContentGUI::__showMaterials

(

$a_tpl

)

Show Materials.

Definition at line 113 of file class.ilContainerSessionsContentGUI.php.

References ilContainerContentGUI\$lng, ilContainerContentGUI\clearAdminCommandsDetermination(), ilContainerContentGUI\getContainerGUI(), ilContainerContentGUI\getContainerObject(), ilContainerContentGUI\getItemGroupsHTML(), ilContainerContentGUI\initRenderer(), ilContainerContentGUI\insertPageEmbeddedBlocks(), ilContainerContentGUI\renderItem(), renderSessionLimitLink(), and ilUtil\sortArray().

Referenced by getMainContent().

    {
        $lng = $this->lng;

        $this->items = $this->getContainerObject()->getSubItems($this->getContainerGUI()->isActiveAdministrationPanel());
        $this->clearAdminCommandsDetermination();
        
        $this->initRenderer();
        
        $output_html = $this->getContainerGUI()->getContainerPageHTML();
        
        // get embedded blocks
        if ($output_html != "") {
            $output_html = $this->insertPageEmbeddedBlocks($output_html);
        }

        $prefix = $postfix = '';
        if (is_array($this->items["sess"]) ||
            $this->items['sess_link']['prev']['value'] ||
            $this->items['sess_link']['next']['value']) {
            $this->items['sess'] = ilUtil::sortArray($this->items['sess'], 'start', 'asc', true, false);
            
            if ($this->items['sess_link']['prev']['value']) {
                $prefix = $this->renderSessionLimitLink(true);
            }
            if ($this->items['sess_link']['next']['value']) {
                $postfix = $this->renderSessionLimitLink(false);
            }
            
            $this->renderer->addTypeBlock("sess", $prefix, $postfix);
            $this->renderer->setBlockPosition("sess", 1);
            
            $position = 1;
            foreach ($this->items["sess"] as $item_data) {
                if (!$this->renderer->hasItem($item_data["child"])) {
                    $html = $this->renderItem($item_data, $position++, true);
                    if ($html != "") {
                        $this->renderer->addItemToBlock("sess", $item_data["type"], $item_data["child"], $html);
                    }
                }
            }
            #22328 render session block if previous or next session link is available
            if (
                !count($this->items['sess'] ?? []) &&
                ($prefix !== '' || $postfix !== '')
            ) {
                $this->renderer->addItemToBlock('sess', '', 0, ' ');
            }
        }
        $pos = $this->getItemGroupsHTML(1);
        if (is_array($this->items["_all"])) {
            $this->renderer->addCustomBlock("_all", $lng->txt("content"));
            $this->renderer->setBlockPosition("_all", ++$pos);
                        
            $position = 1;
            
            foreach ($this->items["_all"] as $item_data) {
                // #14599
                if ($item_data["type"] == "sess" || $item_data["type"] == "itgr") {
                    continue;
                }
                
                if (!$this->renderer->hasItem($item_data["child"])) {
                    $html = $this->renderItem($item_data, $position++, true);
                    if ($html != "") {
                        $this->renderer->addItemToBlock("_all", $item_data["type"], $item_data["child"], $html);
                    }
                }
            }
        }

        $output_html .= $this->renderer->getHTML();
        
        $a_tpl->setVariable("CONTAINER_PAGE_CONTENT", $output_html);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addFooterRow()

ilContainerSessionsContentGUI::addFooterRow

(

$tpl

)

add footer row

public

Parameters

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

References $_GET, ilContainerContentGUI\$ctrl, and ilContainerContentGUI\$tpl.

    {
        $ilCtrl = $this->ctrl;

        $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $_GET["ref_id"]);
        
        $tpl->setCurrentBlock('container_details_row');
        $tpl->setVariable('TXT_DETAILS', $this->lng->txt('details'));
        $tpl->parseCurrentBlock();
    }

getDetailsLevel()

ilContainerSessionsContentGUI::getDetailsLevel

(

$a_session_id

)

get details level

public

Parameters

int

$a_session_id

Returns

int DEATAILS_LEVEL

Definition at line 68 of file class.ilContainerSessionsContentGUI.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 (in_array($a_session_id, $this->force_details)) {
            return self::DETAILS_ALL;
        } else {
            return self::DETAILS_TITLE;
        }
    }

Here is the call graph for this function:

getMainContent()

ilContainerSessionsContentGUI::getMainContent

(

)

Get content HTML for main column.

Definition at line 87 of file class.ilContainerSessionsContentGUI.php.

References ilContainerContentGUI\$lng, $tabs, ilContainerContentGUI\$tpl, and __showMaterials().

    {
        $lng = $this->lng;
        $ilTabs = $this->tabs;

        // see bug #7452
        //              $ilTabs->setSubTabActive($this->getContainerObject()->getType().'_content');


        include_once 'Services/Object/classes/class.ilObjectListGUIFactory.php';

        $tpl = new ilTemplate(
            "tpl.container_page.html",
            true,
            true,
            "Services/Container"
        );

        $this->__showMaterials($tpl);
            
        return $tpl->get();
    }

Here is the call graph for this function:

initDetails()

ilContainerSessionsContentGUI::initDetails ( )

protected

init details

protected

Parameters

Definition at line 266 of file class.ilContainerSessionsContentGUI.php.

References $_GET, $_SESSION, $ilUser, $session, ilContainerContentGUI\$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;
            }
        }

        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 = array($session);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

prepareSessionPresentationLimitation()

static ilContainerSessionsContentGUI::prepareSessionPresentationLimitation ( array  $items, ilContainer  $container, bool  $admin_panel_enabled = false, bool  $include_side_block = false  )

static

Parameters

array	$items
ilContainer	$container

Returns

array

Definition at line 291 of file class.ilContainerSessionsContentGUI.php.

References $_GET, ilContainerContentGUI\$access, $DIC, ilContainerContentGUI\$user, ilDateTime\_after(), ilDateTime\_before(), ilContainerSorting\_getInstance(), ilDateTime\_within(), ilObject\getId(), ilObjectFactory\getInstanceByRefId(), ilObject\getRefId(), ilContainer\getViewMode(), IL_CAL_DATE, IL_CAL_DAY, IL_CAL_UNIX, ilUtil\sortArray(), ilContainer\VIEW_INHERIT, and ilContainer\VIEW_SESSIONS.

Referenced by ilObjCourse\getSubItems(), and ilObjGroup\getSubItems().

      : array {
        global $DIC;

        $user = $DIC->user();
        $access = $DIC->access();
        $tree = $DIC->repositoryTree();

        $limit_sessions = false;
        if (
            !$admin_panel_enabled &&
            !$include_side_block &&
            $items['sess'] &&
            is_array($items['sess']) &&
            (($container->getViewMode() == ilContainer::VIEW_SESSIONS) || ($container->getViewMode() == ilContainer::VIEW_INHERIT)) &&
            $container->isSessionLimitEnabled()
        ) {
            $limit_sessions = true;
        }

        if ($container->getViewMode() == ilContainer::VIEW_INHERIT) {
            $parent = $tree->checkForParentType($container->getRefId(), 'crs');
            $crs = ilObjectFactory::getInstanceByRefId($parent, false);
            if (!$crs instanceof ilObjCourse) {
                return $items;
            }

            if (!$container->isSessionLimitEnabled()) {
                $limit_sessions = false;
            }
            $limit_next = $crs->getNumberOfNextSessions();
            $limit_prev = $crs->getNumberOfPreviousSessions();
        } else {
            $limit_next = $container->getNumberOfNextSessions();
            $limit_prev = $container->getNumberOfPreviousSessions();
        }

        if (!$limit_sessions) {
            return  $items;
        }



        // do session limit
        if (isset($_GET['crs_prev_sess'])) {
            $user->writePref('crs_sess_show_prev_' . $container->getId(), (string) (int) $_GET['crs_prev_sess']);
        }
        if (isset($_GET['crs_next_sess'])) {
            $user->writePref('crs_sess_show_next_' . $container->getId(), (string) (int) $_GET['crs_next_sess']);
        }

        $session_rbac_checked = [];
        foreach ($items['sess'] as $session_tree_info) {
            if ($access->checkAccess('visible', '', $session_tree_info['ref_id'])) {
                $session_rbac_checked[] = $session_tree_info;
            }
        }
        $sessions = ilUtil::sortArray($session_rbac_checked, 'start', 'ASC', true, false);
        //$sessions = ilUtil::sortArray($this->items['sess'],'start','ASC',true,false);
        $today = new ilDate(date('Ymd', time()), IL_CAL_DATE);
        $previous = $current = $next = array();
        foreach ($sessions as $key => $item) {
            $start = new ilDateTime($item['start'], IL_CAL_UNIX);
            $end = new ilDateTime($item['end'], IL_CAL_UNIX);

            if (ilDateTime::_within($today, $start, $end, IL_CAL_DAY)) {
                $current[] = $item;
            } elseif (ilDateTime::_before($start, $today, IL_CAL_DAY)) {
                $previous[] = $item;
            } elseif (ilDateTime::_after($start, $today, IL_CAL_DAY)) {
                $next[] = $item;
            }
        }
        $num_previous_remove = max(
            count($previous) - $limit_prev,
            0
        );
        while ($num_previous_remove--) {
            if (!$user->getPref('crs_sess_show_prev_' . $container->getId())) {
                array_shift($previous);
            }
            $items['sess_link']['prev']['value'] = 1;
        }

        $num_next_remove = max(
            count($next) - $limit_next,
            0
        );
        while ($num_next_remove--) {
            if (!$user->getPref('crs_sess_show_next_' . $container->getId())) {
                array_pop($next);
            }
            // @fixme
            $items['sess_link']['next']['value'] = 1;
        }

        $sessions = array_merge($previous, $current, $next);
        $items['sess'] = $sessions;

        // #15389 - see ilContainer::getSubItems()
        $sort = ilContainerSorting::_getInstance($container->getId());
        $items[(int) $admin_panel_enabled][(int) $include_side_block] = $sort->sortItems($items);
        return $items;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderSessionLimitLink()

ilContainerSessionsContentGUI::renderSessionLimitLink (   $a_previous = true )

protected

Show link to show/hide all previous/next sessions.

Returns

string

Definition at line 193 of file class.ilContainerSessionsContentGUI.php.

References ilContainerContentGUI\$ctrl, $ilUser, ilContainerContentGUI\$lng, ilContainerContentGUI\$tpl, ilContainerContentGUI\$user, ilContainerContentGUI\getContainerGUI(), and ilContainerContentGUI\getContainerObject().

Referenced by __showMaterials().

    {
        $lng = $this->lng;
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        
        $lng->loadLanguageModule('crs');

        $tpl = new ilTemplate(
            'tpl.container_list_item.html',
            true,
            true,
            "Services/Container"
        );
        $tpl->setVariable('DIV_CLASS', 'ilContainerListItemOuter');
        $tpl->setCurrentBlock('item_title_linked');

        if ($a_previous) {
            $prefp = $ilUser->getPref('crs_sess_show_prev_' . $this->getContainerObject()->getId());
            
            if ($prefp) {
                $tpl->setVariable('TXT_TITLE_LINKED', $lng->txt('crs_link_hide_prev_sessions'));
                $ilCtrl->setParameterByClass(get_class($this->getContainerGUI()), 'crs_prev_sess', (int) !$prefp);
                $tpl->setVariable('HREF_TITLE_LINKED', $ilCtrl->getLinkTargetByClass(get_class($this->getContainerGUI()), 'view'));
            } else {
                $tpl->setVariable('TXT_TITLE_LINKED', $lng->txt('crs_link_show_all_prev_sessions'));
                $ilCtrl->setParameterByClass(get_class($this->getContainerGUI()), 'crs_prev_sess', (int) !$prefp);
                $tpl->setVariable('HREF_TITLE_LINKED', $ilCtrl->getLinkTargetByClass(get_class($this->getContainerGUI()), 'view'));
            }
            $ilCtrl->clearParametersByClass(get_class($this->getContainerGUI()));
        } else {
            $prefn = $ilUser->getPref('crs_sess_show_next_' . $this->getContainerObject()->getId());

            if ($prefn) {
                $tpl->setVariable('TXT_TITLE_LINKED', $lng->txt('crs_link_hide_next_sessions'));
            } else {
                $tpl->setVariable('TXT_TITLE_LINKED', $lng->txt('crs_link_show_all_next_sessions'));
            }
            $ilCtrl->setParameterByClass(get_class($this->getContainerGUI()), 'crs_next_sess', (int) !$prefn);
            $tpl->setVariable('HREF_TITLE_LINKED', $ilCtrl->getLinkTargetByClass(get_class($this->getContainerGUI()), 'view'));
            $ilCtrl->clearParametersByClass(get_class($this->getContainerGUI()));
        }
        $tpl->parseCurrentBlock();

        return $tpl->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$force_details

ilContainerSessionsContentGUI::$force_details = array()

protected

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

$tabs

ilContainerSessionsContentGUI::$tabs

protected

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

Referenced by getMainContent().

---

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

• Services/Container/classes/class.ilContainerSessionsContentGUI.php