Presentation of search results using object list gui. More...

Collaboration diagram for ilSearchResultPresentation:

Public Member Functions
	__construct ($container=null, $a_mode=self::MODE_LUCENE)
	Constructor. More...

	getContainer ()
	Get container gui. More...

	getMode ()

	setResults ($a_result_data)
	Set result array. More...

	getResults ()
	get results More...

	setSubitemIds ($a_subids)
	Set subitem ids Used for like and fulltext search. More...

	getSubitemIds ()
	Get subitem ids. More...

	getSubitemIdsByObject ($a_obj_id)
	Get subitem ids for an object. More...

	getHTML ($a_new=false)
	Get HTML. More...

	setSearcher ($a_searcher)
	set searcher More...

	render ()
	Parse results. More...

	setPreviousNext ($a_p, $a_n)
	Set previous next. More...

	getRelevance ($a_obj_id)
	get relevance More...

	lookupTitle ($a_obj_id, $a_sub_id)

	lookupDescription ($a_obj_id, $a_sub_id)

	lookupContent ($a_obj_id, $a_sub_id)
	get content More...

	appendAdditionalInformation ($item_list_gui, $ref_id, $obj_id, $type)
	Append path, relevance information. More...

Data Fields
const	MODE_LUCENE = 1

const	MODE_STANDARD = 2

Protected Member Functions
	parseResultReferences ()
	Check if more than one reference is visible. More...

	hasMoreReferences ($a_ref_id)

	getAllReferences ($a_ref_id)

	renderItemList ()
	Render item list. More...

	appendPath ($a_ref_id)
	Append path. More...

	appendMorePathes ($a_ref_id)
	Append more occurences link. More...

	appendRelevance ($a_obj_id)
	Append relevance. More...

	appendSubItems ($item_list_gui, $ref_id, $obj_id, $a_type)
	Append subitems. More...

	initReferences ()

Protected Attributes
	$mode

	$tpl

	$lng

Private Attributes
	$results = array()

	$subitem_ids = array()

	$has_more_ref_ids = array()

	$all_references = null

	$searcher = null

	$container = null

Detailed Description

Presentation of search results using object list gui.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilSearchResultPresentation::__construct	(	$container = `null`,
		$a_mode = `self::MODE_LUCENE`
	)

Constructor.

Parameters

object $container container gui object

Definition at line 55 of file class.ilSearchResultPresentation.php.

    {
        global $tpl,$lng,$ilCtrl;
        
        $this->mode = $a_mode;
        $this->lng = $lng;
        $this->container = $container;
        $this->ctrl = $ilCtrl;
        
        $this->initReferences();
        
        if (isset($_GET['details'])) {
            include_once './Services/Object/classes/class.ilSubItemListGUI.php';
            ilSubItemListGUI::setShowDetails((int) $_GET['details']);
        }
    }

References $_GET, $container, $ilCtrl, $lng, $tpl, initReferences(), and ilSubItemListGUI\setShowDetails().

Here is the call graph for this function:

Member Function Documentation

◆ appendAdditionalInformation()

ilSearchResultPresentation::appendAdditionalInformation	(	$item_list_gui,
		$ref_id,
		$obj_id,
		$type
	)

Append path, relevance information.

Definition at line 349 of file class.ilSearchResultPresentation.php.

    {
        $sub = $this->appendSubItems($item_list_gui, $ref_id, $obj_id, $type);
        $path = $this->appendPath($ref_id);
        $more = $this->appendMorePathes($ref_id);
        #$rel = $this->appendRelevance($obj_id);
        
        if (!strlen($sub) and
            !strlen($path) and
            !strlen($more) and
            !strlen($rel)) {
            return '';
        }
        $tpl = new ilTemplate('tpl.lucene_additional_information.html', true, true, 'Services/Search');
        $tpl->setVariable('SUBITEM', $sub);
        if (strlen($path)) {
            $tpl->setVariable('PATH', $path);
        }
        if (strlen($more)) {
            $tpl->setVariable('MORE_PATH', $more);
        }
        if (strlen($rel)) {
            $tpl->setVariable('RELEVANCE', $rel);
        }
        
        $item_list_gui->setAdditionalInformation($tpl->get());
        //$item_list_gui->setAdditionalInformation("Hello");
    }

References $path, $tpl, $type, appendMorePathes(), appendPath(), and appendSubItems().

Here is the call graph for this function:

◆ appendMorePathes()

ilSearchResultPresentation::appendMorePathes ( $a_ref_id )

protected

Append more occurences link.

Returns

Definition at line 399 of file class.ilSearchResultPresentation.php.

    {
        if ($this->getMode() != self::MODE_LUCENE) {
            return '';
        }
        
        
        if (!$num_refs = $this->hasMoreReferences($a_ref_id)) {
            return '';
        }
        $tpl = new ilTemplate('tpl.lucene_more_references.html', true, true, 'Services/Search');
        $this->ctrl->setParameter($this->getContainer(), 'refs', $a_ref_id);
        $tpl->setVariable('MORE_REFS_LINK', $this->ctrl->getLinkTarget($this->getContainer(), ''));
        $this->ctrl->clearParameters($this->getContainer());
        
        $tpl->setVariable('TXT_MORE_REFS', sprintf($this->lng->txt('lucene_all_occurrences'), $num_refs));
        return $tpl->get();
    }

References $tpl, getContainer(), getMode(), hasMoreReferences(), and sprintf.

Referenced by appendAdditionalInformation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendPath()

ilSearchResultPresentation::appendPath ( $a_ref_id )

protected

Append path.

Returns

Definition at line 383 of file class.ilSearchResultPresentation.php.

    {
        include_once './Services/Tree/classes/class.ilPathGUI.php';
        $path_gui = new ilPathGUI();
        $path_gui->enableTextOnly(false);
        $path_gui->setUseImages(false);
        
        $tpl = new ilTemplate('tpl.lucene_path.html', true, true, 'Services/Search');
        $tpl->setVariable('PATH_ITEM', $path_gui->getPath(ROOT_FOLDER_ID, $a_ref_id));
        return $tpl->get();
    }

References $tpl.

Referenced by appendAdditionalInformation().

Here is the caller graph for this function:

◆ appendRelevance()

ilSearchResultPresentation::appendRelevance ( $a_obj_id )

protected

Append relevance.

Returns

Definition at line 422 of file class.ilSearchResultPresentation.php.

    {
        if ($this->getMode() != self::MODE_LUCENE) {
            return '';
        }
 
        if (!((int) $this->getRelevance($a_obj_id))) {
            return '';
        }
        
        include_once './Services/Search/classes/class.ilSearchSettings.php';
        if (!ilSearchSettings::getInstance()->isRelevanceVisible()) {
            return '';
        }
 
        $tpl = new ilTemplate('tpl.lucene_relevance.html', true, true, 'Services/Search');
        
        include_once "Services/UIComponent/ProgressBar/classes/class.ilProgressBar.php";
        $pbar = ilProgressBar::getInstance();
        $pbar->setCurrent($this->getRelevance());
        
        $this->tpl->setCurrentBlock('relevance');
        $this->tpl->setVariable('REL_PBAR', $pbar->render());
        $this->tpl->parseCurrentBlock();
        
        $html = $tpl->get();
        return $html;
    }

References $html, $tpl, ilSearchSettings\getInstance(), ilProgressBar\getInstance(), getMode(), and getRelevance().

Here is the call graph for this function:

◆ appendSubItems()

ilSearchResultPresentation::appendSubItems	(	$item_list_gui,
		$ref_id,
		$obj_id,
		$a_type
	)

protected

Append subitems.

Returns

Definition at line 455 of file class.ilSearchResultPresentation.php.

    {
        $subitem_ids = array();
        if ($this->getMode() == self::MODE_STANDARD) {
            $subitem_ids = $this->getSubitemIdsByObject($obj_id);
            $highlighter = null;
        } elseif (is_object($this->searcher->getHighlighter())) {
            $subitem_ids = $this->searcher->getHighlighter()->getSubitemIds($obj_id);
            $highlighter = $this->searcher->getHighlighter();
        }
        
        if (!count($subitem_ids)) {
            return;
        }
        
        // Build subitem list
        include_once './Services/Search/classes/Lucene/class.ilLuceneSubItemListGUIFactory.php';
        $sub_list = ilLuceneSubItemListGUIFactory::getInstanceByType($a_type, $this->getContainer());
        $sub_list->setHighlighter($highlighter);
        $sub_list->init($item_list_gui, $ref_id, $subitem_ids);
        return $sub_list->getHTML();
    }

References $a_type, $subitem_ids, getContainer(), ilLuceneSubItemListGUIFactory\getInstanceByType(), getMode(), and getSubitemIdsByObject().

Referenced by appendAdditionalInformation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllReferences()

ilSearchResultPresentation::getAllReferences ( $a_ref_id )

protected

Definition at line 172 of file class.ilSearchResultPresentation.php.

    {
        if (isset($_SESSION['vis_references'][$a_ref_id])) {
            return $this->all_references[$a_ref_id] ? $this->all_references[$a_ref_id] : array();
        } else {
            return array($a_ref_id);
        }
    }

References $_SESSION.

Referenced by renderItemList().

Here is the caller graph for this function:

◆ getContainer()

ilSearchResultPresentation::getContainer ( )

Get container gui.

Definition at line 75 of file class.ilSearchResultPresentation.php.

    {
        return $this->container;
    }

References $container.

Referenced by appendMorePathes(), and appendSubItems().

Here is the caller graph for this function:

◆ getHTML()

ilSearchResultPresentation::getHTML ( $a_new = false )

Get HTML.

Returns: string HTML

Definition at line 185 of file class.ilSearchResultPresentation.php.

    {
        return $this->thtml;
    }

◆ getMode()

ilSearchResultPresentation::getMode ( )

Definition at line 80 of file class.ilSearchResultPresentation.php.

    {
        return $this->mode;
    }

References $mode.

Referenced by appendMorePathes(), appendRelevance(), appendSubItems(), getRelevance(), lookupContent(), lookupDescription(), and lookupTitle().

Here is the caller graph for this function:

◆ getRelevance()

ilSearchResultPresentation::getRelevance ( $a_obj_id )

get relevance

Parameters

return

Definition at line 293 of file class.ilSearchResultPresentation.php.

    {
        if ($this->getMode() == self::MODE_LUCENE) {
            return $this->searcher->getResult()->getRelevance($a_obj_id);
        }
        return 0;
    }

References getMode().

Referenced by appendRelevance(), and renderItemList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getResults()

ilSearchResultPresentation::getResults ( )

get results

Returns: array result array

Definition at line 98 of file class.ilSearchResultPresentation.php.

    {
        return $this->results ? $this->results : array();
    }

Referenced by parseResultReferences(), and renderItemList().

Here is the caller graph for this function:

◆ getSubitemIds()

ilSearchResultPresentation::getSubitemIds ( )

Get subitem ids.

Returns

Definition at line 118 of file class.ilSearchResultPresentation.php.

    {
        return $this->subitem_ids ? $this->subitem_ids : array();
    }

◆ getSubitemIdsByObject()

ilSearchResultPresentation::getSubitemIdsByObject ( $a_obj_id )

Get subitem ids for an object.

Parameters

int $a_obj_id

Returns

Definition at line 128 of file class.ilSearchResultPresentation.php.

    {
        return (isset($this->subitem_ids[$a_obj_id]) and $this->subitem_ids[$a_obj_id]) ?
            $this->subitem_ids[$a_obj_id] :
            array();
    }

Referenced by appendSubItems().

Here is the caller graph for this function:

◆ hasMoreReferences()

ilSearchResultPresentation::hasMoreReferences ( $a_ref_id )

protected

Definition at line 161 of file class.ilSearchResultPresentation.php.

    {
        if (!isset($this->has_more_ref_ids[$a_ref_id]) or
            !$this->has_more_ref_ids[$a_ref_id] or
            isset($_SESSION['vis_references'][$a_ref_id])) {
            return false;
        }
        
        return $this->has_more_ref_ids[$a_ref_id];
    }

References $_SESSION.

Referenced by appendMorePathes().

Here is the caller graph for this function:

◆ initReferences()

ilSearchResultPresentation::initReferences ( )

protected

Definition at line 478 of file class.ilSearchResultPresentation.php.

    {
        if (isset($_REQUEST['refs'])) {
            $_SESSION['vis_references'][(int) $_REQUEST['refs']] = (int) $_REQUEST['refs'];
        }
    }

References $_SESSION.

Referenced by __construct().

Here is the caller graph for this function:

◆ lookupContent()

ilSearchResultPresentation::lookupContent	(	$a_obj_id,
		$a_sub_id
	)

get content

Parameters

return

Definition at line 338 of file class.ilSearchResultPresentation.php.

    {
        if ($this->getMode() != self::MODE_LUCENE or !is_object($this->searcher->getHighlighter())) {
            return '';
        }
        return $this->searcher->getHighlighter()->getContent($a_obj_id, $a_sub_id);
    }

References getMode().

Here is the call graph for this function:

◆ lookupDescription()

ilSearchResultPresentation::lookupDescription	(	$a_obj_id,
		$a_sub_id
	)

Parameters

return

Definition at line 322 of file class.ilSearchResultPresentation.php.

    {
        if ($this->getMode() != self::MODE_LUCENE or !is_object($this->searcher->getHighlighter())) {
            return ilObject::_lookupDescription($a_obj_id);
        }
        if (strlen($title = $this->searcher->getHighlighter()->getDescription($a_obj_id, $a_sub_id))) {
            return $title;
        }
        return ilObject::_lookupDescription($a_obj_id);
    }

References $title, ilObject\_lookupDescription(), and getMode().

Referenced by renderItemList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupTitle()

ilSearchResultPresentation::lookupTitle	(	$a_obj_id,
		$a_sub_id
	)

Parameters

return

Definition at line 306 of file class.ilSearchResultPresentation.php.

    {
        if ($this->getMode() != self::MODE_LUCENE or !is_object($this->searcher->getHighlighter())) {
            return ilObject::_lookupTitle($a_obj_id);
        }
        if (strlen($title = $this->searcher->getHighlighter()->getTitle($a_obj_id, $a_sub_id))) {
            return $title;
        }
        return ilObject::_lookupTitle($a_obj_id);
    }

References $title, ilObject\_lookupTitle(), and getMode().

Referenced by renderItemList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseResultReferences()

ilSearchResultPresentation::parseResultReferences ( )

protected

Check if more than one reference is visible.

Definition at line 140 of file class.ilSearchResultPresentation.php.

    {
        global $ilAccess;
        
        foreach ($this->getResults() as $ref_id => $obj_id) {
            $this->all_references[$ref_id][] = $ref_id;
            $counter = 0;
            foreach (ilObject::_getAllReferences($obj_id) as $new_ref) {
                if ($new_ref == $ref_id) {
                    continue;
                }
                if (!$ilAccess->checkAccess('read', '', $new_ref)) {
                    continue;
                }
                $this->all_references[$ref_id][] = $new_ref;
                ++$counter;
            }
            $this->has_more_ref_ids[$ref_id] = $counter;
        }
    }

References $counter, ilObject\_getAllReferences(), and getResults().

Referenced by renderItemList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ render()

ilSearchResultPresentation::render ( )

Parse results.

Parameters

void

Returns: string html

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

    {
        return $this->renderItemList();
    }

References renderItemList().

Here is the call graph for this function:

◆ renderItemList()

ilSearchResultPresentation::renderItemList ( )

protected

Render item list.

Returns: void

Definition at line 224 of file class.ilSearchResultPresentation.php.

    {
        global $tree,$ilBench, $lng;
 
        $this->html = '';
        
        $ilBench->start('Lucene', '2000_pr');
        $this->parseResultReferences();
        $ilBench->stop('Lucene', '2000_pr');
        
        $lng->loadLanguageModule("cntr"); // #16834
        
        include_once("./Services/Object/classes/class.ilObjectListGUIPreloader.php");
        $preloader = new ilObjectListGUIPreloader(ilObjectListGUI::CONTEXT_SEARCH);
            
        $set = array();
        foreach ($this->getResults() as $c_ref_id => $obj_id) {
            $ilBench->start('Lucene', '2100_res');
            foreach ($this->getAllReferences($c_ref_id) as $ref_id) {
                $ilBench->start('Lucene', '2120_tree');
                if (!$tree->isInTree($ref_id)) {
                    continue;
                }
                $ilBench->stop('Lucene', '2120_tree');
                
                $obj_type = ilObject::_lookupType($obj_id);
                
                $set[] = array(
                    "ref_id"            => $ref_id,
                    "obj_id"            => $obj_id,
                    "title"                     => $this->lookupTitle($obj_id, 0),
                    "title_sort"        => ilObject::_lookupTitle($obj_id),
                    "description"       => $this->lookupDescription($obj_id, 0),
                    "type"                      => $obj_type,
                    "relevance"         => $this->getRelevance($obj_id),
                    "s_relevance"       => sprintf("%03d", $this->getRelevance($obj_id))
                );
                                
                $preloader->addItem($obj_id, $obj_type, $ref_id);
            }
            $ilBench->stop('Lucene', '2100_res');
        }
 
        if (!count($set)) {
            return false;
        }
        
        $preloader->preload();
        unset($preloader);
        
        $ilBench->start('Lucene', '2900_tb');
        include_once("./Services/Search/classes/class.ilSearchResultTableGUI.php");
        $result_table = new ilSearchResultTableGUI($this->container, "showSavedResults", $this);
        $result_table->setCustomPreviousNext($this->prev, $this->next);
        
        $result_table->setData($set);
        $this->thtml = $result_table->getHTML();
        $ilBench->stop('Lucene', '2900_tb');
        
        return true;
    }

References $ilBench, $lng, ilObject\_lookupTitle(), ilObject\_lookupType(), ilObjectListGUI\CONTEXT_SEARCH, getAllReferences(), getRelevance(), getResults(), html(), lookupDescription(), lookupTitle(), parseResultReferences(), and sprintf.

Referenced by render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPreviousNext()

ilSearchResultPresentation::setPreviousNext	(	$a_p,
		$a_n
	)

Set previous next.

Definition at line 213 of file class.ilSearchResultPresentation.php.

    {
        $this->prev = $a_p;
        $this->next = $a_n;
    }

◆ setResults()

ilSearchResultPresentation::setResults ( $a_result_data )

Set result array.

Parameters

array $a_result_data result array

Definition at line 89 of file class.ilSearchResultPresentation.php.

    {
        $this->results = $a_result_data;
    }

◆ setSearcher()

ilSearchResultPresentation::setSearcher ( $a_searcher )

set searcher

Parameters

return

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

    {
        $this->searcher = $a_searcher;
    }

◆ setSubitemIds()

ilSearchResultPresentation::setSubitemIds ( $a_subids )

Set subitem ids Used for like and fulltext search.

Parameters

array $a_subids array ($obj_id => array(page1_id,page2_id);

Returns

Definition at line 109 of file class.ilSearchResultPresentation.php.

    {
        $this->subitem_ids = $a_subids;
    }

Field Documentation

◆ $all_references

ilSearchResultPresentation::$all_references = null

private

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

◆ $container

ilSearchResultPresentation::$container = null

private

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

Referenced by __construct(), and getContainer().

◆ $has_more_ref_ids

ilSearchResultPresentation::$has_more_ref_ids = array()

private

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

◆ $lng

ilSearchResultPresentation::$lng

protected

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

Referenced by __construct(), and renderItemList().

◆ $mode

ilSearchResultPresentation::$mode

protected

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

Referenced by getMode().

◆ $results

ilSearchResultPresentation::$results = array()

private

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

◆ $searcher

ilSearchResultPresentation::$searcher = null

private

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

◆ $subitem_ids

ilSearchResultPresentation::$subitem_ids = array()

private

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

Referenced by appendSubItems().

◆ $tpl

ilSearchResultPresentation::$tpl

protected

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

Referenced by __construct(), appendAdditionalInformation(), appendMorePathes(), appendPath(), and appendRelevance().

◆ MODE_LUCENE

const ilSearchResultPresentation::MODE_LUCENE = 1

Definition at line 35 of file class.ilSearchResultPresentation.php.

◆ MODE_STANDARD

const ilSearchResultPresentation::MODE_STANDARD = 2

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

Referenced by ilAdvancedSearchGUI\performAdvMDSearch(), ilAdvancedSearchGUI\performSearch(), ilSearchGUI\performSearch(), ilAdvancedSearchGUI\showSavedAdvMDResults(), ilAdvancedSearchGUI\showSavedResults(), and ilSearchGUI\showSavedResults().

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

Services/Search/classes/class.ilSearchResultPresentation.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ appendAdditionalInformation()

◆ appendMorePathes()

◆ appendPath()

◆ appendRelevance()

◆ appendSubItems()

◆ getAllReferences()

◆ getContainer()

◆ getHTML()

◆ getMode()

◆ getRelevance()

◆ getResults()

◆ getSubitemIds()

◆ getSubitemIdsByObject()

◆ hasMoreReferences()

◆ initReferences()

◆ lookupContent()

◆ lookupDescription()

◆ lookupTitle()

◆ parseResultReferences()

◆ render()

◆ renderItemList()

◆ setPreviousNext()

◆ setResults()

◆ setSearcher()

◆ setSubitemIds()

Field Documentation

◆ $all_references

◆ $container

◆ $has_more_ref_ids

◆ $lng

◆ $mode

◆ $results

◆ $searcher

◆ $subitem_ids

◆ $tpl

◆ MODE_LUCENE

◆ MODE_STANDARD