ilContainerSessionsContentGUI Class Reference

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

Inheritance diagram for ilContainerSessionsContentGUI:

Collaboration diagram for ilContainerSessionsContentGUI:

Public Member Functions
	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 may 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
	initRenderer ()
	getBlockPostfix (string $type)
	getBlockPrefix (string $type)
	renderSessionLimitLink (bool $a_previous=true)
	initSessionPresentationLimitation ()
	isItemHidden (string $type, int $ref_id)
Protected Member Functions inherited from ilContainerContentGUI
	getViewMode ()
	getRightColumnHTML ()
	getCenterColumnHTML ()
	initRenderer ()
	Init container renderer. More...
	getItemGUI (array $item_data)
	hasForcedOrderByStartDate (string $type)
	getUniqueItemId (array $a_item_data)

Protected Attributes
array	$visible_sessions = []
bool	$session_link_next = false
bool	$session_link_prev = false
bool	$session_limitation_initialised = false
Protected Attributes inherited from ilContainerContentGUI
ILIAS Container Content ItemPresentationManager	$item_presentation
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
int	$block_limit = 0
array	$type_grps = []
int	$force_details
ilContainerUserFilter	$container_user_filter

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

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 in one block.

Author

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

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

Member Function Documentation

getBlockPostfix()

ilContainerSessionsContentGUI::getBlockPostfix ( string  $type )

protected

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

References initSessionPresentationLimitation(), and renderSessionLimitLink().

Referenced by initRenderer().

                                                    : string
    {
        if ($type === "sess") {
            $this->initSessionPresentationLimitation();
            if ($this->session_link_next) {
                return (string) $this->renderSessionLimitLink(false);
            }
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getBlockPrefix()

ilContainerSessionsContentGUI::getBlockPrefix ( string  $type )

protected

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

References initSessionPresentationLimitation(), and renderSessionLimitLink().

Referenced by initRenderer().

                                                   : string
    {
        if ($type === "sess") {
            $this->initSessionPresentationLimitation();
            if ($this->session_link_prev) {
                return (string) $this->renderSessionLimitLink(true);
            }
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initRenderer()

ilContainerSessionsContentGUI::initRenderer ( )

protected

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

References $ref_id, getBlockPostfix(), getBlockPrefix(), isItemHidden(), and renderer().

Referenced by renderItemList().

                                     : void
    {
        parent::initRenderer();
        $this->renderer->setBlockPostfixClosure(function (string $type) {
            return $this->getBlockPostfix($type);
        });
        $this->renderer->setBlockPrefixClosure(function (string $type) {
            return $this->getBlockPrefix($type);
        });
        $this->renderer->setItemHiddenClosure(function (string $type, int $ref_id) {
            return $this->isItemHidden($type, $ref_id);
        });
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initSessionPresentationLimitation()

ilContainerSessionsContentGUI::initSessionPresentationLimitation ( )

protected

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

References ilContainerContentGUI\$access, $container, ilContainerContentGUI\$container_obj, $DIC, $ref_id, ilContainerContentGUI\$request, ilContainerContentGUI\$user, ilDateTime\_after(), ilDateTime\_before(), ilDateTime\_within(), ilObjectFactory\getInstanceByRefId(), ilObjUser\getPref(), IL_CAL_DATE, IL_CAL_DAY, IL_CAL_UNIX, null, ilArrayUtil\sortArray(), ilContainer\VIEW_INHERIT, and ilObjUser\writePref().

Referenced by getBlockPostfix(), getBlockPrefix(), and isItemHidden().

                                                          : void
    {
        global $DIC;
        if ($this->session_limitation_initialised) {
            return;
        }
        $this->session_limitation_initialised = true;


        $container = $this->container_obj;


        $mode_manager = $DIC->container()->internal()->domain()->content()->mode($container);
        $session_ref_ids = $this->item_presentation->getRefIdsOfType("sess");

        // see #38780
        if (!in_array($container->getType(), ["grp", "crs"])) {
            $this->visible_sessions = $session_ref_ids;
            return;
        }

        $user = $DIC->user();
        $access = $DIC->access();
        $tree = $DIC->repositoryTree();
        $request = $DIC->container()
            ->internal()
            ->gui()
            ->standardRequest();

        $limit_sessions = false;
        if (!$mode_manager->isAdminMode() &&
            count($session_ref_ids) > 0 &&
            $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;
            }

            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) {
            $this->visible_sessions = $session_ref_ids;
            return;
        }

        // do session limit
        if ($request->getPreviousSession() !== null) {
            $user->writePref(
                'crs_sess_show_prev_' . $container->getId(),
                (string) $request->getPreviousSession()
            );
        }
        if ($request->getNextSession() !== null) {
            $user->writePref(
                'crs_sess_show_next_' . $container->getId(),
                (string) $request->getNextSession()
            );
        }

        $sessions = array_map(function ($ref_id) {
            return $this->item_presentation->getRawDataByRefId($ref_id);
        }, $session_ref_ids);
        $sessions = ilArrayUtil::sortArray($sessions, 'start', 'ASC', true, false);
        //$sessions = ilUtil::sortArray($this->items['sess'],'start','ASC',true,false);
        $today = new ilDate(date('Ymd'), IL_CAL_DATE);
        $previous = $current = $next = [];
        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);
            }
            $this->session_link_prev = true;
        }

        $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
            $this->session_link_next = true;
        }

        $sessions = array_merge($previous, $current, $next);
        $this->visible_sessions = array_map(static function ($item) {
            return (int) $item["ref_id"];
        }, $sessions);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isItemHidden()

ilContainerSessionsContentGUI::isItemHidden ( string  $type, int  $ref_id  )

protected

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

References initSessionPresentationLimitation().

Referenced by initRenderer().

                                                              : bool
    {
        if ($type === "sess") {
            $this->initSessionPresentationLimitation();
            return !in_array($ref_id, $this->visible_sessions, true);
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderItemList()

ilContainerSessionsContentGUI::renderItemList

(

)

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

References initRenderer(), and renderer().

                                    : string
    {
        $this->initRenderer();
        return $this->renderer->renderItemBlockSequence($this->item_presentation->getItemBlockSequence());
    }

Here is the call graph for this function:

renderSessionLimitLink()

ilContainerSessionsContentGUI::renderSessionLimitLink ( bool  $a_previous = true )

protected

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

References ilContainerContentGUI\$ctrl, ilContainerContentGUI\$lng, ilContainerContentGUI\$tpl, ilContainerContentGUI\$user, ILIAS\UICore\GlobalTemplate\get(), ilContainerContentGUI\getContainerGUI(), ilContainerContentGUI\getContainerObject(), ILIAS\Survey\Mode\getId(), ilLanguage\loadLanguageModule(), ILIAS\UICore\GlobalTemplate\parseCurrentBlock(), ILIAS\UICore\GlobalTemplate\setCurrentBlock(), ILIAS\UICore\GlobalTemplate\setVariable(), and ilLanguage\txt().

Referenced by getBlockPostfix(), and getBlockPrefix().

     : string {
        $lng = $this->lng;
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;

        $lng->loadLanguageModule('crs');

        $tpl = new ilTemplate(
            'tpl.container_list_item.html',
            true,
            true,
            "components/ILIAS/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

$session_limitation_initialised

bool ilContainerSessionsContentGUI::$session_limitation_initialised = false

protected

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

$session_link_next

bool ilContainerSessionsContentGUI::$session_link_next = false

protected

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

$session_link_prev

bool ilContainerSessionsContentGUI::$session_link_prev = false

protected

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

$visible_sessions

array ilContainerSessionsContentGUI::$visible_sessions = []

protected

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

---

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

• components/ILIAS/Container/Content/SessionsView/class.ilContainerSessionsContentGUI.php