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

Collaboration diagram for ilSearchResultPresentation:

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

	getContainer ()
	Get container gui. More...

	getMode ()

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

	getResults ()
	get results More...

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

	getSubitemIds ()
	Get subitem ids. More...

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

	getHTML ()
	Get HTML. More...

	setSearcher (ilLuceneSearcher $a_searcher)
	set searcher More...

	render ()
	Parse results. More...

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

	getRelevance (int $a_obj_id)

	lookupTitle (int $a_obj_id, int $a_sub_id)

	lookupDescription (int $a_obj_id, int $a_sub_id)

	lookupContent (int $a_obj_id, int $a_sub_id)

	appendAdditionalInformation (ilObjectListGUI $item_list_gui, int $ref_id, int $obj_id, string $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...

	getMoreReferencesCounter (int $a_ref_id)

	getAllReferences (int $a_ref_id)

	renderItemList ()
	Render item list. More...

	appendPath (int $a_ref_id)

	appendMorePathes (int $a_ref_id)

	appendSubItems (ilObjectListGUI $item_list_gui, int $ref_id, int $obj_id, string $a_type)

	initReferences ()

Protected Attributes
int	$mode

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilCtrl	$ctrl

ilAccess	$access

ilTree	$tree

GlobalHttpState	$http

Factory	$refinery

string	$prev

string	$next

string	$html

string	$thtml

Private Attributes
array	$results = []

array	$subitem_ids = []

array	$has_more_ref_ids = []

array	$all_references = []

ilLuceneSearcher	$searcher = null

object	$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

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

object $container container gui object

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

    {
        global $DIC;
 
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->access = $DIC->access();
        $this->tree = $DIC->repositoryTree();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->mode = $a_mode;
        $this->container = $container;
 
        $this->initReferences();
 
        if ($this->http->wrapper()->query()->has('details')) {
            ilSubItemListGUI::setShowDetails(
                $this->http->wrapper()->query()->retrieve(
                    'details',
                    $this->refinery->kindlyTo()->int()
                )
            );
        }
    }

References $container, $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), initReferences(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilSubItemListGUI\setShowDetails().

Here is the call graph for this function:

Member Function Documentation

◆ appendAdditionalInformation()

ilSearchResultPresentation::appendAdditionalInformation	(	ilObjectListGUI	$item_list_gui,
		int	$ref_id,
		int	$obj_id,
		string	$type
	)

Append path, relevance information.

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

     : void {
        $sub = $this->appendSubItems($item_list_gui, $ref_id, $obj_id, $type);
        $path = $this->appendPath($ref_id);
        $more = $this->appendMorePathes($ref_id);
 
        if (!strlen($sub) and
            !strlen($path) and
            !strlen($more)) {
            return;
        }
        $tpl = new ilTemplate('tpl.lucene_additional_information.html', true, true, 'components/ILIAS/Search');
        $tpl->setVariable('SUBITEM', $sub);
        if (strlen($path)) {
            $tpl->setVariable('PATH', $path);
        }
        if (strlen($more)) {
            $tpl->setVariable('MORE_PATH', $more);
        }
 
        $item_list_gui->setAdditionalInformation($tpl->get());
    }

◆ appendMorePathes()

ilSearchResultPresentation::appendMorePathes ( int $a_ref_id )

protected

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

                                                      : string
    {
        if ($this->getMode() != self::MODE_LUCENE) {
            return '';
        }
 
 
        if (!$num_refs = $this->getMoreReferencesCounter($a_ref_id)) {
            return '';
        }
        $tpl = new ilTemplate('tpl.lucene_more_references.html', true, true, 'components/ILIAS/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 ILIAS\Repository\ctrl(), ILIAS\UICore\GlobalTemplate\get(), ILIAS\Repository\lng(), and ILIAS\UICore\GlobalTemplate\setVariable().

Here is the call graph for this function:

◆ appendPath()

ilSearchResultPresentation::appendPath ( int $a_ref_id )

protected

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

                                                : string
    {
        $path_gui = new ilPathGUI();
        $path_gui->enableTextOnly(false);
        $path_gui->setUseImages(false);
 
        $tpl = new ilTemplate('tpl.lucene_path.html', true, true, 'components/ILIAS/Search');
        $tpl->setVariable('PATH_ITEM', $path_gui->getPath(ROOT_FOLDER_ID, $a_ref_id));
        return $tpl->get();
    }

References ILIAS\UICore\GlobalTemplate\get(), ROOT_FOLDER_ID, and ILIAS\UICore\GlobalTemplate\setVariable().

Here is the call graph for this function:

◆ appendSubItems()

ilSearchResultPresentation::appendSubItems	(	ilObjectListGUI	$item_list_gui,
		int	$ref_id,
		int	$obj_id,
		string	$a_type
	)

protected

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

     : string {
        $subitem_ids = array();
        $highlighter = null;
        if ($this->getMode() == self::MODE_STANDARD) {
            $subitem_ids = $this->getSubitemIdsByObject($obj_id);
        } 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
        $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();
    }

◆ getAllReferences()

ilSearchResultPresentation::getAllReferences ( int $a_ref_id )

protected

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

                                                      : array
    {
        $references = ilSession::get('vis_references') ?? [];
        if (array_key_exists($a_ref_id, $references)) {
            return $this->all_references[$a_ref_id] ?: array();
        } else {
            return array($a_ref_id);
        }
    }

References ilSession\get().

Referenced by renderItemList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContainer()

ilSearchResultPresentation::getContainer ( )

Get container gui.

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

                                  : object
    {
        return $this->container;
    }

References $container.

◆ getHTML()

ilSearchResultPresentation::getHTML ( )

Get HTML.

Returns: string HTML

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

                             : string
    {
        return $this->thtml;
    }

References $thtml.

◆ getMode()

ilSearchResultPresentation::getMode ( )

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

                             : int
    {
        return $this->mode;
    }

References $mode.

Referenced by getRelevance(), lookupContent(), lookupDescription(), and lookupTitle().

Here is the caller graph for this function:

◆ getMoreReferencesCounter()

ilSearchResultPresentation::getMoreReferencesCounter ( int $a_ref_id )

protected

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

                                                              : int
    {
        $references = ilSession::get('vis_references') ?? [];
        if (!isset($this->has_more_ref_ids[$a_ref_id]) or
            !$this->has_more_ref_ids[$a_ref_id] or
            array_key_exists($a_ref_id, $references)) {
            return 0;
        }
        return (int) $this->has_more_ref_ids[$a_ref_id];
    }

References ilSession\get().

Here is the call graph for this function:

◆ getRelevance()

ilSearchResultPresentation::getRelevance ( int $a_obj_id )

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

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

References getMode().

Referenced by renderItemList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getResults()

ilSearchResultPresentation::getResults ( )

get results

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

                                : array
    {
        return $this->results;
    }

References $results.

Referenced by parseResultReferences(), and renderItemList().

Here is the caller graph for this function:

◆ getSubitemIds()

ilSearchResultPresentation::getSubitemIds ( )

Get subitem ids.

Returns: array

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

                                   : array
    {
        return $this->subitem_ids;
    }

References $subitem_ids.

◆ getSubitemIdsByObject()

ilSearchResultPresentation::getSubitemIdsByObject ( int $a_obj_id )

Get subitem ids for an object.

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

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

◆ initReferences()

ilSearchResultPresentation::initReferences ( )

protected

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

                                       : void
    {
        $session_references = ilSession::get('vis_references') ?? [];
        if ($this->http->wrapper()->post()->has('refs')) {
            $refs = $this->http->wrapper()->post()->retrieve(
                'refs',
                $this->refinery->kindlyTo()->int()
            );
            $session_references[$refs] = $refs;
            ilSession::set('vis_references', $session_references);
        }
    }

References ilSession\get(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), and ilSession\set().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupContent()

ilSearchResultPresentation::lookupContent	(	int	$a_obj_id,
		int	$a_sub_id
	)

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

                                                               : string
    {
        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	(	int	$a_obj_id,
		int	$a_sub_id
	)

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

                                                                   : string
    {
        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 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	(	int	$a_obj_id,
		int	$a_sub_id
	)

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

                                                             : string
    {
        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 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 154 of file class.ilSearchResultPresentation.php.

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

References $counter, $ref_id, ilObject\_getAllReferences(), ILIAS\Repository\access(), 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.

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

                            : bool
    {
        return $this->renderItemList();
    }

References renderItemList().

Here is the call graph for this function:

◆ renderItemList()

ilSearchResultPresentation::renderItemList ( )

protected

Render item list.

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

                                       : bool
    {
        $this->html = '';
 
        $this->parseResultReferences();
 
        $this->lng->loadLanguageModule("cntr"); // #16834
 
        $preloader = new ilObjectListGUIPreloader(ilObjectListGUI::CONTEXT_SEARCH);
 
        $set = array();
        foreach ($this->getResults() as $c_ref_id => $obj_id) {
            $c_ref_id = (int) $c_ref_id;
            $obj_id = (int) $obj_id;
            foreach ($this->getAllReferences($c_ref_id) as $ref_id) {
                if (!$this->tree->isInTree($ref_id)) {
                    continue;
                }
 
                $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((int) $obj_id),
                    "description" => $this->lookupDescription((int) $obj_id, 0),
                    "type" => $obj_type,
                    "relevance" => $this->getRelevance($obj_id),
                    "s_relevance" => sprintf("%03d", $this->getRelevance($obj_id)),
                    'create_date' => ilObject::_lookupCreationDate($obj_id)
                );
 
                $preloader->addItem($obj_id, $obj_type, $ref_id);
            }
        }
 
        if (!count($set)) {
            return false;
        }
 
        $preloader->preload();
        unset($preloader);
 
        $result_table = new ilSearchResultTableGUI($this->container, "showSavedResults", $this);
        $result_table->setCustomPreviousNext($this->prev, $this->next);
 
        $result_table->setDataAndApplySortation($set);
        $this->thtml = $result_table->getHTML();
        return true;
    }

References $ref_id, ilObject\_lookupCreationDate(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilObjectListGUI\CONTEXT_SEARCH, getAllReferences(), getRelevance(), getResults(), ILIAS\Repository\html(), ILIAS\Repository\int(), ILIAS\Repository\lng(), lookupDescription(), lookupTitle(), ILIAS\User\Profile\ChangeMail\next, and parseResultReferences().

Referenced by render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPreviousNext()

ilSearchResultPresentation::setPreviousNext	(	string	$a_p,
		string	$a_n
	)

Set previous next.

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

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

References ILIAS\User\Profile\ChangeMail\next.

◆ setResults()

ilSearchResultPresentation::setResults ( array $a_result_data )

Set result array.

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

                                                    : void
    {
        $this->results = $a_result_data;
    }

◆ setSearcher()

ilSearchResultPresentation::setSearcher ( ilLuceneSearcher $a_searcher )

set searcher

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

                                                             : void
    {
        $this->searcher = $a_searcher;
    }

◆ setSubitemIds()

ilSearchResultPresentation::setSubitemIds ( array $a_subids )

Set subitem ids Used for like and fulltext search.

Parameters

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

Returns: void

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

                                                  : void
    {
        $this->subitem_ids = $a_subids;
    }

Field Documentation

◆ $access

ilAccess ilSearchResultPresentation::$access

protected

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

◆ $all_references

array ilSearchResultPresentation::$all_references = []

private

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

◆ $container

object ilSearchResultPresentation::$container = null

private

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

Referenced by __construct(), and getContainer().

◆ $ctrl

ilCtrl ilSearchResultPresentation::$ctrl

protected

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

◆ $has_more_ref_ids

array ilSearchResultPresentation::$has_more_ref_ids = []

private

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

◆ $html

string ilSearchResultPresentation::$html

protected

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

◆ $http

GlobalHttpState ilSearchResultPresentation::$http

protected

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

◆ $lng

ilLanguage ilSearchResultPresentation::$lng

protected

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

◆ $mode

int ilSearchResultPresentation::$mode

protected

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

Referenced by getMode().

◆ $next

string ilSearchResultPresentation::$next

protected

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

◆ $prev

string ilSearchResultPresentation::$prev

protected

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

◆ $refinery

Factory ilSearchResultPresentation::$refinery

protected

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

◆ $results

array ilSearchResultPresentation::$results = []

private

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

Referenced by getResults().

◆ $searcher

ilLuceneSearcher ilSearchResultPresentation::$searcher = null

private

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

◆ $subitem_ids

array ilSearchResultPresentation::$subitem_ids = []

private

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

Referenced by getSubitemIds().

◆ $thtml

string ilSearchResultPresentation::$thtml

protected

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

Referenced by getHTML().

◆ $tpl

ilGlobalTemplateInterface ilSearchResultPresentation::$tpl

protected

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

◆ $tree

ilTree ilSearchResultPresentation::$tree

protected

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

◆ MODE_LUCENE

const ilSearchResultPresentation::MODE_LUCENE = 1

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

◆ MODE_STANDARD

const ilSearchResultPresentation::MODE_STANDARD = 2

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

Referenced by ilSearchGUI\performSearch(), and ilSearchGUI\showSavedResults().

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

components/ILIAS/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()

◆ appendSubItems()

◆ getAllReferences()

◆ getContainer()

◆ getHTML()

◆ getMode()

◆ getMoreReferencesCounter()

◆ getRelevance()

◆ getResults()

◆ getSubitemIds()

◆ getSubitemIdsByObject()

◆ initReferences()

◆ lookupContent()

◆ lookupDescription()

◆ lookupTitle()

◆ parseResultReferences()

◆ render()

◆ renderItemList()

◆ setPreviousNext()

◆ setResults()

◆ setSearcher()

◆ setSubitemIds()

Field Documentation

◆ $access

◆ $all_references

◆ $container

◆ $ctrl

◆ $has_more_ref_ids

◆ $html

◆ $http

◆ $lng

◆ $mode

◆ $next

◆ $prev

◆ $refinery

◆ $results

◆ $searcher

◆ $subitem_ids

◆ $thtml

◆ $tpl

◆ $tree

◆ MODE_LUCENE

◆ MODE_STANDARD