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

Inheritance diagram for ilSubItemListGUI:

Collaboration diagram for ilSubItemListGUI:

Public Member Functions
	__construct (string $cmd_class)

	getCmdClass ()

	setHighlighter (?ilLuceneHighlighterResultParser $highlighter)

	getHighlighter ()

	getRefId ()

	getObjId ()

	getType ()

	getSubItemIds (bool $limited=false)

	getItemListGUI ()

	init (ilObjectListGUI $item_list_gui, int $ref_id, array $subitem_ids)

	getHTML ()

Static Public Member Functions
static	setShowDetails (int $obj_id)
	set show details. More...

static	resetDetails ()
	As long as static::resetDetails is not possible this method is final. More...

static	enabledDetails (int $obj_id)
	As long as static::enableDetails is not possible this method is final. More...

Protected Member Functions
	showDetailsLink ()

	parseRelevance (int $sub_item)

Protected Attributes
ilCtrlInterface	$ctrl

ilLanguage	$lng

string	$cmd_class = ''

ilTemplate	$tpl = null

ilLuceneHighlighterResultParser	$highlighter = null

array	$subitem_ids = []

ilObjectListGUI	$item_list_gui = null

int	$ref_id = 0

int	$obj_id = 0

string	$type = ''

Static Protected Attributes
static int	$MAX_SUBITEMS = 5

static array	$details = []

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 Base class for all sub item list gui's

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilSubItemListGUI::__construct ( string $cmd_class )

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

References $cmd_class, $DIC, ILIAS\Repository\ctrl(), ilSearchSettings\getInstance(), and ILIAS\Repository\lng().

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
 
         $this->cmd_class = $cmd_class;
         self::$MAX_SUBITEMS = ilSearchSettings::getInstance()->getMaxSubitems();
     }

Here is the call graph for this function:

Member Function Documentation

◆ enabledDetails()

static ilSubItemListGUI::enabledDetails ( int $obj_id )

staticfinal

As long as static::enableDetails is not possible this method is final.

Definition at line 76 of file class.ilSubItemListGUI.php.

References $obj_id.

                                                             : bool
     {
         return isset($_SESSION['lucene_search']['details'][$obj_id]) && $_SESSION['lucene_search']['details'][$obj_id];
     }

◆ getCmdClass()

ilSubItemListGUI::getCmdClass ( )

Definition at line 81 of file class.ilSubItemListGUI.php.

References $cmd_class.

Referenced by showDetailsLink().

                                  : string
     {
         return $this->cmd_class;
     }

Here is the caller graph for this function:

◆ getHighlighter()

ilSubItemListGUI::getHighlighter ( )

Definition at line 91 of file class.ilSubItemListGUI.php.

References $highlighter.

Referenced by ilObjMediaPoolSubItemListGUI\getHTML(), ilObjForumSubItemListGUI\getHTML(), ilObjLearningModuleSubItemListGUI\getHTML(), ilObjGlossarySubItemListGUI\getHTML(), ilObjLinkResourceSubItemListGUI\getHTML(), ilObjWikiSubItemListGUI\getHTML(), ilObjExerciseSubItemListGUI\getHTML(), and parseRelevance().

                                     : ?ilLuceneHighlighterResultParser
     {
         return $this->highlighter;
     }

Here is the caller graph for this function:

◆ getHTML()

ilSubItemListGUI::getHTML ( )

abstract

Referenced by parseRelevance().

Here is the caller graph for this function:

◆ getItemListGUI()

ilSubItemListGUI::getItemListGUI ( )

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

References $item_list_gui.

Referenced by ilObjMediaPoolSubItemListGUI\getHTML(), ilObjForumSubItemListGUI\getHTML(), ilObjLearningModuleSubItemListGUI\getHTML(), ilObjGlossarySubItemListGUI\getHTML(), and ilObjWikiSubItemListGUI\getHTML().

                                     : ?ilObjectListGUI
     {
         return $this->item_list_gui;
     }

Here is the caller graph for this function:

◆ getObjId()

ilSubItemListGUI::getObjId ( )

Definition at line 101 of file class.ilSubItemListGUI.php.

References $obj_id.

Referenced by ilObjMediaPoolSubItemListGUI\getHTML(), ilObjForumSubItemListGUI\getHTML(), ilObjLearningModuleSubItemListGUI\getHTML(), ilObjGlossarySubItemListGUI\getHTML(), ilObjLinkResourceSubItemListGUI\getHTML(), ilObjWikiSubItemListGUI\getHTML(), ilObjExerciseSubItemListGUI\getHTML(), getSubItemIds(), init(), parseRelevance(), and showDetailsLink().

                               : int
     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getRefId()

ilSubItemListGUI::getRefId ( )

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

References $ref_id.

Referenced by ilObjMediaPoolSubItemListGUI\getHTML(), ilObjGlossarySubItemListGUI\getHTML(), ilObjWikiSubItemListGUI\getHTML(), ilObjExerciseSubItemListGUI\getHTML(), init(), and ilObjMediaPoolSubItemListGUI\parseImage().

                               : int
     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ getSubItemIds()

ilSubItemListGUI::getSubItemIds ( bool $limited = false )

Definition at line 111 of file class.ilSubItemListGUI.php.

References $subitem_ids, and getObjId().

Referenced by ilObjMediaPoolSubItemListGUI\getHTML(), ilObjForumSubItemListGUI\getHTML(), ilObjLearningModuleSubItemListGUI\getHTML(), ilObjGlossarySubItemListGUI\getHTML(), ilObjLinkResourceSubItemListGUI\getHTML(), ilObjWikiSubItemListGUI\getHTML(), ilObjExerciseSubItemListGUI\getHTML(), and showDetailsLink().

                                                         : array
     {
         if ($limited && !self::enabledDetails($this->getObjId())) {
             return array_slice($this->subitem_ids, 0, self::$MAX_SUBITEMS);
         }
 
         return $this->subitem_ids;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

ilSubItemListGUI::getType ( )

Definition at line 106 of file class.ilSubItemListGUI.php.

References $type.

                              : string
     {
         return $this->type;
     }

◆ init()

ilSubItemListGUI::init	(	ilObjectListGUI	$item_list_gui,
		int	$ref_id,
		array	$subitem_ids
	)

Definition at line 125 of file class.ilSubItemListGUI.php.

References $item_list_gui, $ref_id, $subitem_ids, ilObject\_lookupObjId(), ilObject\_lookupType(), getObjId(), and getRefId().

                                                                                          : void
     {
         $this->tpl = new ilTemplate('tpl.subitem_list.html', true, true, 'Services/Object');
         $this->item_list_gui = $item_list_gui;
         $this->ref_id = $ref_id;
         $this->obj_id = ilObject::_lookupObjId($this->getRefId());
         $this->type = ilObject::_lookupType($this->getObjId());
         $this->subitem_ids = $subitem_ids;
     }

Here is the call graph for this function:

◆ parseRelevance()

ilSubItemListGUI::parseRelevance ( int $sub_item )

protected

Definition at line 157 of file class.ilSubItemListGUI.php.

References getHighlighter(), getHTML(), ilProgressBar\getInstance(), ilSearchSettings\getInstance(), and getObjId().

Referenced by ilObjMediaPoolSubItemListGUI\getHTML(), ilObjForumSubItemListGUI\getHTML(), ilObjLearningModuleSubItemListGUI\getHTML(), ilObjGlossarySubItemListGUI\getHTML(), ilObjLinkResourceSubItemListGUI\getHTML(), ilObjWikiSubItemListGUI\getHTML(), and ilObjExerciseSubItemListGUI\getHTML().

                                                     : void
     {
         if (
             !ilSearchSettings::getInstance()->isSubRelevanceVisible() ||
             !ilSearchSettings::getInstance()->enabledLucene()
         ) {
             return;
         }
 
         $relevance = $this->getHighlighter()->getRelevance($this->getObjId(), $sub_item);
 
         $pbar = ilProgressBar::getInstance();
         $pbar->setCurrent($relevance);
 
         $this->tpl->setVariable('REL_PBAR', $pbar->render());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetDetails()

static ilSubItemListGUI::resetDetails ( )

staticfinal

As long as static::resetDetails is not possible this method is final.

Definition at line 68 of file class.ilSubItemListGUI.php.

Referenced by ilLuceneUserSearchGUI\search(), ilLuceneAdvancedSearchGUI\search(), ilLuceneSearchGUI\search(), ilSearchGUI\storeRoot(), and ilLuceneSearchGUI\storeRoot().

                                                : void
     {
         $_SESSION['lucene_search']['details'] = [];
     }

Here is the caller graph for this function:

◆ setHighlighter()

ilSubItemListGUI::setHighlighter ( ?ilLuceneHighlighterResultParser $highlighter )

Definition at line 86 of file class.ilSubItemListGUI.php.

References $highlighter.

                                                                                  : void
     {
         $this->highlighter = $highlighter;
     }

◆ setShowDetails()

static ilSubItemListGUI::setShowDetails ( int $obj_id )

staticfinal

set show details.

Show all sub item links for a specific object As long as static::setShowDetails is not possible this method is final

Definition at line 60 of file class.ilSubItemListGUI.php.

References $obj_id.

Referenced by ilSearchResultPresentation\__construct().

                                                             : void
     {
         $_SESSION['lucene_search']['details'][$obj_id] = true;
     }

Here is the caller graph for this function:

◆ showDetailsLink()

ilSubItemListGUI::showDetailsLink ( )

protected

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

References ILIAS\Repository\ctrl(), getCmdClass(), getObjId(), getSubItemIds(), and ILIAS\Repository\lng().

Referenced by ilObjMediaPoolSubItemListGUI\getHTML(), ilObjForumSubItemListGUI\getHTML(), ilObjLearningModuleSubItemListGUI\getHTML(), ilObjGlossarySubItemListGUI\getHTML(), ilObjLinkResourceSubItemListGUI\getHTML(), ilObjWikiSubItemListGUI\getHTML(), and ilObjExerciseSubItemListGUI\getHTML().

                                         : void
     {
         if (count($this->getSubItemIds()) <= self::$MAX_SUBITEMS) {
             return;
         }
         if (self::enabledDetails($this->getObjId())) {
             return;
         }
 
         $additional = count($this->getSubItemIds()) - self::$MAX_SUBITEMS;
 
         $this->ctrl->setParameterByClass($this->getCmdClass(), 'details', $this->getObjId());
         $link = $this->ctrl->getLinkTargetByClass($this->getCmdClass(), '');
         $this->ctrl->clearParametersByClass($this->getCmdClass());
 
         $this->tpl->setCurrentBlock('choose_details');
         $this->tpl->setVariable('LUC_DETAILS_LINK', $link);
         $this->tpl->setVariable('LUC_NUM_HITS', sprintf($this->lng->txt('lucene_more_hits_link'), $additional));
         $this->tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $cmd_class

string ilSubItemListGUI::$cmd_class = ''

protected

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

Referenced by __construct(), and getCmdClass().

◆ $ctrl

ilCtrlInterface ilSubItemListGUI::$ctrl

protected

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

◆ $details

array ilSubItemListGUI::$details = []

staticprotected

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

◆ $highlighter

ilLuceneHighlighterResultParser ilSubItemListGUI::$highlighter = null

protected

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

Referenced by getHighlighter(), and setHighlighter().

◆ $item_list_gui

ilObjectListGUI ilSubItemListGUI::$item_list_gui = null

protected

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

Referenced by getItemListGUI(), and init().

◆ $lng

ilLanguage ilSubItemListGUI::$lng

protected

Definition at line 32 of file class.ilSubItemListGUI.php.

Referenced by ilObjMediaPoolSubItemListGUI\getHTML(), ilObjLearningModuleSubItemListGUI\getHTML(), ilObjGlossarySubItemListGUI\getHTML(), ilObjWikiSubItemListGUI\getHTML(), and ilObjExerciseSubItemListGUI\getHTML().

◆ $MAX_SUBITEMS

int ilSubItemListGUI::$MAX_SUBITEMS = 5

staticprotected

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

◆ $obj_id

int ilSubItemListGUI::$obj_id = 0

protected

Definition at line 41 of file class.ilSubItemListGUI.php.

Referenced by enabledDetails(), getObjId(), and setShowDetails().

◆ $ref_id

int ilSubItemListGUI::$ref_id = 0

protected

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

Referenced by getRefId(), and init().

◆ $subitem_ids

array ilSubItemListGUI::$subitem_ids = []

protected

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

Referenced by getSubItemIds(), and init().

◆ $tpl

ilTemplate ilSubItemListGUI::$tpl = null

protected

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

◆ $type

string ilSubItemListGUI::$type = ''

protected

Definition at line 42 of file class.ilSubItemListGUI.php.

Referenced by getType().

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

Services/Object/classes/class.ilSubItemListGUI.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ enabledDetails()

◆ getCmdClass()

◆ getHighlighter()

◆ getHTML()

◆ getItemListGUI()

◆ getObjId()

◆ getRefId()

◆ getSubItemIds()

◆ getType()

◆ init()

◆ parseRelevance()

◆ resetDetails()

◆ setHighlighter()

◆ setShowDetails()

◆ showDetailsLink()

Field Documentation

◆ $cmd_class

◆ $ctrl

◆ $details

◆ $highlighter

◆ $item_list_gui

◆ $lng

◆ $MAX_SUBITEMS

◆ $obj_id

◆ $ref_id

◆ $subitem_ids

◆ $tpl

◆ $type