Base class for all sub item list gui's. More...

Inheritance diagram for ilSubItemListGUI:

Collaboration diagram for ilSubItemListGUI:

Public Member Functions
	__construct ($a_cmd_class)
	Constructor. More...

	getCmdClass ()
	get cmd class More...

	setHighlighter ($a_highlighter)
	set highlighter More...

	getHighlighter ()
	get highlighter More...

	getRefId ()
	get ref id More...

	getObjId ()
	get obj id More...

	getType ()
	get type More...

	getSubItemIds ($a_limited=false)
	get sub item ids More...

	getItemListGUI ()
	get item list gui More...

	init ($item_list_gui, $a_ref_id, $a_subitem_ids)
	init More...

	getHTML ()

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

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

static	enabledDetails ($a_obj_id)
	enabled show details As long as static::enableDetails is not possible this method is final More...

Protected Member Functions
	showDetailsLink ()
	show details link More...

	parseRelevance ($sub_item)

Protected Attributes
	$cmdClass = null

	$tpl

Static Protected Attributes
static	$MAX_SUBITEMS = 5

Private Attributes
	$highlighter = null

	$subitem_ids = array()

	$item_list_gui

	$ref_id

	$obj_id

	$type

Static Private Attributes
static	$details = array()

Detailed Description

Base class for all sub item list gui's.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilSubItemListGUI::__construct ( $a_cmd_class )

Constructor.

Parameters

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

References ilSearchSettings\getInstance().

         {
                 
                 $this->cmdClass = $a_cmd_class;
                 self::$MAX_SUBITEMS = ilSearchSettings::getInstance()->getMaxSubitems();
         }

Here is the call graph for this function:

Member Function Documentation

◆ enabledDetails()

static ilSubItemListGUI::enabledDetails ( $a_obj_id )

staticfinal

enabled show details As long as static::enableDetails is not possible this method is final

Parameters

int $a_obj_id object id

Returns: bool

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

References $_SESSION.

         {
                 return isset($_SESSION['lucene_search']['details'][$a_obj_id]) and $_SESSION['lucene_search']['details'][$a_obj_id]; 
         }

◆ getCmdClass()

ilSubItemListGUI::getCmdClass ( )

get cmd class

Returns

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

References $cmdClass.

Referenced by showDetailsLink().

         {
                 return $this->cmdClass;
         }

Here is the caller graph for this function:

◆ getHighlighter()

ilSubItemListGUI::getHighlighter ( )

get highlighter

Parameters

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

References $highlighter.

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

         {
                 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 ( )

get item list gui

Returns

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

References $item_list_gui.

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

         {
                 return $this->item_list_gui;     
         }

Here is the caller graph for this function:

◆ getObjId()

ilSubItemListGUI::getObjId ( )

get obj id

Returns

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

References $obj_id.

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

         {
                 return $this->obj_id;
         }

Here is the caller graph for this function:

◆ getRefId()

ilSubItemListGUI::getRefId ( )

get ref id

Returns

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

References $ref_id.

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

         {
                 return $this->ref_id;
         }

Here is the caller graph for this function:

◆ getSubItemIds()

ilSubItemListGUI::getSubItemIds ( $a_limited = false )

get sub item ids

Parameters

bool $a_limited

Returns

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

References $subitem_ids, and getObjId().

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

         {
                 if($a_limited and !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 ( )

get type

Returns

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

References $type.

         {
                 return $this->type;
         }

◆ init()

ilSubItemListGUI::init	(	$item_list_gui,
		$a_ref_id,
		$a_subitem_ids
	)

init

Parameters

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

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

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

Here is the call graph for this function:

◆ parseRelevance()

ilSubItemListGUI::parseRelevance ( $sub_item )

protected

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

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

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

         {
                 if(!ilSearchSettings::getInstance()->isSubRelevanceVisible() ||
                         !ilSearchSettings::enabledLucene())
                 {
                         return '';
                 }
                 
                 $relevance = $this->getHighlighter()->getRelevance($this->getObjId(),$sub_item);                
                 
                 $this->tpl->addBlockFile('SUB_REL','sub_rel','tpl.lucene_sub_relevance.html','Services/Search');
                 
                 include_once "Services/UIComponent/ProgressBar/classes/class.ilProgressBar.php";
                 $pbar = ilProgressBar::getInstance();
                 $pbar->setCurrent($relevance); 
                 
                 $this->tpl->setCurrentBlock('relevance');
                 $this->tpl->setVariable('REL_PBAR', $pbar->render());           
                 $this->tpl->parseCurrentBlock();                
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetDetails()

static ilSubItemListGUI::resetDetails ( )

staticfinal

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

Returns

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

References $_SESSION.

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

         {
                 $_SESSION['lucene_search']['details'] = array();
         }

Here is the caller graph for this function:

◆ setHighlighter()

ilSubItemListGUI::setHighlighter ( $a_highlighter )

set highlighter

Parameters

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

         {
                 $this->highlighter = $a_highlighter;
         }

◆ setShowDetails()

static ilSubItemListGUI::setShowDetails ( $a_obj_id )

staticfinal

set show details.

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

Returns

Parameters

int $a_obj_id object id

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

References $_SESSION.

Referenced by ilSearchResultPresentation\__construct().

          {
                 $_SESSION['lucene_search']['details'][$a_obj_id] = true;
          }

Here is the caller graph for this function:

◆ showDetailsLink()

ilSubItemListGUI::showDetailsLink ( )

protected

show details link

Returns

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

References $additional, $ilCtrl, $lng, getCmdClass(), getObjId(), and getSubItemIds().

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

         {
                 global $ilCtrl,$lng;
                 
                 if(count($this->getSubItemIds()) <= self::$MAX_SUBITEMS)
                 {
                         return;
                 }
                 if(self::enabledDetails($this->getObjId()))
                 {
                         return;
                 }
 
                 $additional = count($this->getSubItemIds()) - self::$MAX_SUBITEMS;
                 
                 $ilCtrl->setParameterByClass(get_class($this->getCmdClass()), 'details', (int) $this->getObjId());
                 $link = $ilCtrl->getLinkTargetByClass(get_class($this->getCmdClass()),'');
                 $ilCtrl->clearParametersByClass(get_class($this->getCmdClass()));
                 
                 $this->tpl->setCurrentBlock('choose_details');
                 $this->tpl->setVariable('LUC_DETAILS_LINK',$link);
                 $this->tpl->setVariable('LUC_NUM_HITS',sprintf($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

◆ $cmdClass

ilSubItemListGUI::$cmdClass = null

protected

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

Referenced by getCmdClass().

◆ $details

ilSubItemListGUI::$details = array()

staticprivate

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

◆ $highlighter

ilSubItemListGUI::$highlighter = null

private

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

Referenced by getHighlighter().

◆ $item_list_gui

ilSubItemListGUI::$item_list_gui

private

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

Referenced by getItemListGUI(), and init().

◆ $MAX_SUBITEMS

ilSubItemListGUI::$MAX_SUBITEMS = 5

staticprotected

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

◆ $obj_id

ilSubItemListGUI::$obj_id

private

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

Referenced by getObjId().

◆ $ref_id

ilSubItemListGUI::$ref_id

private

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

Referenced by getRefId().

◆ $subitem_ids

ilSubItemListGUI::$subitem_ids = array()

private

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

Referenced by getSubItemIds().

◆ $tpl

ilSubItemListGUI::$tpl

protected

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

◆ $type

ilSubItemListGUI::$type

private

Definition at line 51 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

Private Attributes

Static Private 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

◆ $cmdClass

◆ $details

◆ $highlighter

◆ $item_list_gui

◆ $MAX_SUBITEMS

◆ $obj_id

◆ $ref_id

◆ $subitem_ids

◆ $tpl

◆ $type