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

Collaboration diagram for ilSearchResult:

Public Member Functions
	__construct (int $a_user_id=0)

	setRequiredPermission (string $a_permission)
	Set the required permission for the rbac checks in function 'filter()'. More...

	getRequiredPermission ()

	setUserId (int $a_user_id)

	getUserId ()

	getEntries ()

	isLimitReached ()

	setMaxHits (int $a_max_hits)

	getMaxHits ()

	isOffsetReached (int $a_counter)
	Check if offset is reached. More...

	addEntry (int $a_obj_id, string $a_type, array $found, int $a_child_id=0, string $a_child_type='')
	add search result entry Entries are stored with 'obj_id'. More...

	numEntries ()

	mergeEntries (ilSearchResult $result_obj)
	merge entries of this instance and another result object More...

	diffEntriesFromResult ()
	diff entries of this instance and another result object Used for search in results More...

	intersectEntries (ilSearchResult $result_obj)
	Build intersection of entries (all entries that are present in both result sets) More...

	addResult (int $a_ref_id, int $a_obj_id, string $a_type)

	getResults ()

	getResultIds ()

	getResultsByObjId ()

	getUniqueResults ()
	Get unique results. More...

	getResultsForPresentation ()

	getSubitemIds ()

	filter (int $a_root_node, bool $check_and, ?ilDate $creation_filter_date_start=null, ?ilDate $creation_filter_date_end=null, array $copyright_identifiers=[])
	Filter search result. More...

	filterResults (int $a_root_node)
	Filter search area of result set. More...

	save (int $a_type=ilUserSearchCache::DEFAULT_SEARCH)

	read (int $a_type=ilUserSearchCache::DEFAULT_SEARCH)

	__updateEntryChilds (int $a_obj_id, array $a_childs)

	__updateResultChilds (int $a_ref_id, array $a_childs)
	Update children for a specific result. More...

	__initSearchSettingsObject ()

	preventOverwritingMaxhits (?bool $a_flag=null)
	If you call this function and pass "true" the maxhits setting will not be overwritten in __initSearchSettingsObject() @access public. More...

	addObserver (object $a_class, string $a_method)
	The observer is used to call functions for filtering result. More...

	callListeners (int $a_ref_id, array $a_data)

Data Fields
bool	$limit_reached = false

Protected Member Functions
	findEntriesWithCopyright (string ... $copyright_identifiers)

	initUserSearchCache ()

Protected Attributes
ilUserSearchCache	$search_cache

int	$offset = 0

ilAccess	$ilAccess

ilDBInterface	$db

ilTree	$tree

ilObjUser	$user

ilSearchSettings	$search_settings

LOMServices	$lom_services

bool	$preventOverwritingMaxhits = false

ilLogger	$logger

Private Attributes
string	$permission = 'visible'

int	$user_id

array	$entries = array()

array	$results = array()

array	$observers = array()

int	$max_hits = 0

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 searchResult stores all result of a search query. Offers methods like mergeResults. To merge result sets of different queries.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilSearchResult::__construct ( int $a_user_id = 0 )

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

    {
        global $DIC;
 
        $this->logger = $DIC->logger()->src();
        $this->ilAccess = $DIC->access();
        $this->db = $DIC->database();
        $this->tree = $DIC->repositoryTree();
        $this->user = $DIC->user();
        $this->lom_services = $DIC->learningObjectMetadata();
 
        if ($a_user_id) {
            $this->user_id = $a_user_id;
        } else {
            $this->user_id = $this->user->getId();
        }
        $this->__initSearchSettingsObject();
        $this->initUserSearchCache();
    }

References $DIC, __initSearchSettingsObject(), initUserSearchCache(), ILIAS\Repository\logger(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ __initSearchSettingsObject()

ilSearchResult::__initSearchSettingsObject ( )

Definition at line 555 of file class.ilSearchResult.php.

                                                : void
    {
        $this->search_settings = new ilSearchSettings();
        if (!$this->preventOverwritingMaxhits()) {
            $this->setMaxHits($this->search_settings->getMaxHits());
        }
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ __updateEntryChilds()

ilSearchResult::__updateEntryChilds	(	int	$a_obj_id,
		array	$a_childs
	)

Parameters

int	$a_obj_id
array	$a_childs	array of children as ['id' => $id, 'type' => $type]. E.g 'pg', 'st'

Returns: bool

Definition at line 528 of file class.ilSearchResult.php.

                                                                       : bool
    {
        if ($this->entries[$a_obj_id] and is_array($a_childs)) {
            foreach ($a_childs as $child_info) {
                if ($child_info) {
                    $this->entries[$a_obj_id]['child'][$child_info['type'] . '__' . $child_info['id']] = $child_info;
                }
            }
            return true;
        }
        return false;
    }

◆ __updateResultChilds()

ilSearchResult::__updateResultChilds	(	int	$a_ref_id,
		array	$a_childs
	)

Update children for a specific result.

Definition at line 544 of file class.ilSearchResult.php.

                                                                        : bool
    {
        if ($this->results[$a_ref_id] and is_array($a_childs)) {
            foreach ($a_childs as $child_info) {
                $this->results[$a_ref_id]['child'][$child_info['type'] . '__' . $child_info['id']] = $child_info;
            }
            return true;
        }
        return false;
    }

◆ addEntry()

ilSearchResult::addEntry	(	int	$a_obj_id,
		string	$a_type,
		array	$found,
		int	$a_child_id = `0`,
		string	$a_child_type = `''`
	)

add search result entry Entries are stored with 'obj_id'.

This method is typically called to store db query results.

Parameters

int	$a_obj_id	object object_id
string	$a_type	obj_type 'lm' or 'crs' ...
array	$found	value position of query parser words in query string
int	$a_child_id	child id e.g id of page or chapter
string	$a_child_type	child type e.g 'pg' or 'st'

Returns: void

Definition at line 136 of file class.ilSearchResult.php.

     : void {
        // Create new entry if it not exists
        if (!isset($this->entries[$a_obj_id])) {
            $this->entries[$a_obj_id]['obj_id'] = $a_obj_id;
            $this->entries[$a_obj_id]['type'] = $a_type;
            $this->entries[$a_obj_id]['found'] = $found;
            $this->entries[$a_obj_id]['child'] = [];
 
            if ($a_child_id and $a_child_id != $a_obj_id) {
                $this->entries[$a_obj_id]['child'][$a_child_type . '__' . $a_child_id] = [
                    'id' => $a_child_id, 'type' => $a_child_type
                ];
            }
        } else {
            // replace or add child ('pg','st') id and type
            if ($a_child_id and $a_child_id != $a_obj_id) {
                $this->entries[$a_obj_id]['child'][$a_child_type . '__' . $a_child_id] = [
                    'id' => $a_child_id, 'type' => $a_child_type
                ];
            }
            $counter = 0;
            foreach ($found as $position) {
                if ($position) {
                    $this->entries[$a_obj_id]['found'][$counter] = $position;
                }
                $counter++;
            }
        }
    }

◆ addObserver()

ilSearchResult::addObserver	(	object	$a_class,
		string	$a_method
	)

The observer is used to call functions for filtering result.

Every callback function should support the following parameters: array of ids. E.g: ref_id = 5,array(obj_id = 1,type = 'crs'), The function should return true or false.

Parameters

object	$a_class	class of callback function
string	$a_method	name of callback method

Definition at line 595 of file class.ilSearchResult.php.

                                                                  : bool
    {
        $this->observers[] = array('class' => $a_class,
                                   'method' => $a_method);
        return true;
    }

◆ addResult()

ilSearchResult::addResult	(	int	$a_ref_id,
		int	$a_obj_id,
		string	$a_type
	)

Definition at line 238 of file class.ilSearchResult.php.

                                                                           : void
    {
        $this->results[$a_ref_id]['ref_id'] = $a_ref_id;
        $this->results[$a_ref_id]['obj_id'] = $a_obj_id;
        $this->results[$a_ref_id]['type'] = $a_type;
    }

◆ callListeners()

ilSearchResult::callListeners	(	int	$a_ref_id,
		array	$a_data
	)

Definition at line 603 of file class.ilSearchResult.php.

                                                               : bool
    {
        foreach ($this->observers as $observer) {
            $class = &$observer['class'];
            $method = $observer['method'];
 
            if (!$class->$method($a_ref_id, $a_data)) {
                return false;
            }
        }
        return true;
    }

◆ diffEntriesFromResult()

ilSearchResult::diffEntriesFromResult ( )

diff entries of this instance and another result object Used for search in results

Definition at line 193 of file class.ilSearchResult.php.

                                           : void
    {
        $new_entries = $this->getEntries();
        $this->entries = array();
 
        // Get all checked objects
        foreach ($this->search_cache->getCheckedItems() as $ref_id => $obj_id) {
            if (isset($new_entries[$obj_id])) {
                $this->addEntry(
                    $new_entries[$obj_id]['obj_id'],
                    $new_entries[$obj_id]['type'],
                    $new_entries[$obj_id]['found']
                );
                $this->__updateEntryChilds(
                    $new_entries[$obj_id]['obj_id'],
                    $new_entries[$obj_id]['child']
                );
            }
        }
    }

References $ref_id.

◆ filter()

ilSearchResult::filter	(	int	$a_root_node,
		bool	$check_and,
		?ilDate	$creation_filter_date_start = `null`,
		?ilDate	$creation_filter_date_end = `null`,
		array	$copyright_identifiers = `[]`
	)

Filter search result.

Do RBAC checks. Allows paging of results for referenced objects

Parameters

string[] $copyright_identifiers

Definition at line 320 of file class.ilSearchResult.php.

     : bool {
        // check for copyright of all entries at once
        if ($copyright_identifiers !== []) {
            $entries_with_copyright = $this->findEntriesWithCopyright(...$copyright_identifiers);
        }
 
        // get ref_ids and check access
        $counter = 0;
        $offset_counter = 0;
        foreach ($this->getEntries() as $entry) {
            // boolean and failed continue
            if ($check_and and in_array(0, $entry['found'])) {
                continue;
            }
            // Types like role, rolt, user do not need rbac checks
            $type = ilObject::_lookupType($entry['obj_id']);
            if ($type == 'rolt' or $type == 'usr' or $type == 'role') {
                if ($this->callListeners($entry['obj_id'], $entry)) {
                    $this->addResult($entry['obj_id'], $entry['obj_id'], $type);
                    if (is_array($entry['child'])) {
                        $counter += count($entry['child']);
                    }
                    // Stop if maximum of hits is reached
                    if (++$counter > $this->getMaxHits()) {
                        $this->limit_reached = true;
                        return true;
                    }
                }
                continue;
            }
 
            /*
             * (Re-)check creation date, needed for searches on other tables than obj_data (35275)
             * Before- and after-operators also allow matching datetimes, see ilObjectSearch::performSearch.
             */
            if (!is_null($creation_filter_date_start) || !is_null($creation_filter_date_end)) {
                if (
                    !ilObject::_exists($entry['obj_id']) ||
                    ($creation_date_string = ilObject::_lookupCreationDate($entry['obj_id'])) === ''
                ) {
                    continue;
                }
                $creation_date = new ilDate(
                    date('Y-m-d', strtotime($creation_date_string)),
                    IL_CAL_DATE
                );
 
                if ($creation_filter_date_start && is_null($creation_filter_date_end)) {
                    if (!ilDate::_after($creation_date, $creation_filter_date_start)) {
                        continue;
                    }
                } elseif ($creation_filter_date_end && is_null($creation_filter_date_start)) {
                    if (!ilDate::_before($creation_date, $creation_filter_date_end)) {
                        continue;
                    }
                } elseif (!ilDate::_within($creation_date, $creation_filter_date_start, $creation_filter_date_end)) {
                    continue;
                }
            }
 
            // filter by copyright
            $filtered_children = $entry['child'];
            if ($copyright_identifiers !== []) {
                foreach ($filtered_children as $key => $child) {
                    if (in_array(
                        $entry['obj_id'] . '__' . $child['id'] . '__' . $child['type'],
                        $entries_with_copyright
                    )) {
                        continue;
                    }
                    unset($filtered_children[$key]);
                }
                if (
                    empty($filtered_children) &&
                    !in_array(
                        $entry['obj_id'] . '__' . $entry['obj_id'] . '__' . $entry['type'],
                        $entries_with_copyright
                    )
                ) {
                    continue;
                }
 
            }
 
            // Check referenced objects
            foreach (ilObject::_getAllReferences((int) $entry['obj_id']) as $ref_id) {
                // Failed check: if ref id check is failed by previous search
                if ($this->search_cache->isFailed($ref_id)) {
                    continue;
                }
                // Offset check
                if ($this->search_cache->isChecked($ref_id) and !$this->isOffsetReached($offset_counter)) {
                    ++$offset_counter;
                    continue;
                }
 
                if (!$this->callListeners($ref_id, $entry)) {
                    continue;
                }
 
 
 
                // RBAC check
                $type = ilObject::_lookupType($ref_id, true);
                if ($this->ilAccess->checkAccessOfUser(
                    $this->getUserId(),
                    $this->getRequiredPermission(),
                    '',
                    $ref_id,
                    $type,
                    $entry['obj_id']
                )) {
                    if ($a_root_node == ROOT_FOLDER_ID or $this->tree->isGrandChild($a_root_node, $ref_id)) {
                        // Call listeners
                        #if($this->callListeners($ref_id,$entry))
                        if (1) {
                            $this->addResult($ref_id, $entry['obj_id'], $type);
                            $this->search_cache->appendToChecked($ref_id, $entry['obj_id']);
                            $this->__updateResultChilds($ref_id, $filtered_children);
                            ilObject::_lookupType($entry['obj_id']);
                            $counter++;
                            $offset_counter++;
                            // Stop if maximum of hits is reached
 
                            if ($counter >= $this->getMaxHits()) {
                                $this->limit_reached = true;
                                $this->search_cache->setResults($this->results);
                                return true;
                            }
                        }
                    }
                    continue;
                }
                $this->search_cache->appendToFailed($ref_id);
            }
        }
        $this->search_cache->setResults($this->results);
        return false;
    }

◆ filterResults()

ilSearchResult::filterResults ( int $a_root_node )

Filter search area of result set.

Definition at line 501 of file class.ilSearchResult.php.

                                                   : void
    {
        $tmp_results = $this->getResults();
        $this->results = array();
        foreach ($tmp_results as $result) {
            if (isset($result['ref_id']) && $this->tree->isGrandChild($a_root_node, $result['ref_id']) && $this->tree->isInTree($result['ref_id'])) {
                $this->addResult($result['ref_id'], $result['obj_id'], $result['type']);
                $this->__updateResultChilds($result['ref_id'], $result['child'] ?? []);
            }
        }
    }

◆ findEntriesWithCopyright()

ilSearchResult::findEntriesWithCopyright ( string ... $copyright_identifiers )

protected

Parameters

string ...$copyright_identifiers

Returns: string[] in the format {OBJ_ID}__{SUB_ID}__{TYPE}

Definition at line 470 of file class.ilSearchResult.php.

                                                                                 : array
    {
        $filters = [];
        foreach ($this->entries as $entry) {
            $filters[] = $this->lom_services->search()->getFilter(
                $entry['obj_id'],
                0,
                $entry['type']
            );
            foreach ($entry['child'] as $child) {
                $filters[] = $this->lom_services->search()->getFilter(
                    $entry['obj_id'],
                    $child['id'],
                    $child['type']
                );
            }
        }
 
        $clause = $this->lom_services->copyrightHelper()->getCopyrightSearchClause(...$copyright_identifiers);
        $results = $this->lom_services->search()->execute($clause, null, null, ...$filters);
 
        $ids = [];
        foreach ($results as $result) {
            $ids[] = $result->objID() . '__' . $result->subID() . '__' . $result->type();
        }
        return $ids;
    }

References $results.

◆ getEntries()

ilSearchResult::getEntries ( )

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

                                : array
    {
        return $this->entries;
    }

References $entries.

Referenced by intersectEntries(), and mergeEntries().

Here is the caller graph for this function:

◆ getMaxHits()

ilSearchResult::getMaxHits ( )

Definition at line 112 of file class.ilSearchResult.php.

                                : int
    {
        return $this->max_hits;
    }

References $max_hits.

◆ getRequiredPermission()

ilSearchResult::getRequiredPermission ( )

Definition at line 84 of file class.ilSearchResult.php.

                                           : string
    {
        return $this->permission;
    }

References $permission.

◆ getResultIds()

ilSearchResult::getResultIds ( )

Returns: int[]

Definition at line 253 of file class.ilSearchResult.php.

                                  : array
    {
        $ids = [];
        foreach ($this->getResults() as $id => $tmp) {
            $ids[] = $id;
        }
        return $ids;
    }

References $id.

◆ getResults()

ilSearchResult::getResults ( )

Definition at line 245 of file class.ilSearchResult.php.

                                : array
    {
        return $this->results;
    }

References $results.

◆ getResultsByObjId()

ilSearchResult::getResultsByObjId ( )

Definition at line 262 of file class.ilSearchResult.php.

                                       : array
    {
        $tmp_res = [];
        foreach ($this->getResults() as $ref_id => $res_data) {
            $tmp_res[$res_data['obj_id']][] = $ref_id;
        }
        return $tmp_res;
    }

References $ref_id.

◆ getResultsForPresentation()

ilSearchResult::getResultsForPresentation ( )

Definition at line 289 of file class.ilSearchResult.php.

                                               : array
    {
        $res = [];
        foreach ($this->getResults() as $result) {
            if (!is_array($result)) {
                continue;
            }
 
            $res[(int) $result['ref_id']] = (int) $result['obj_id'];
        }
        return $res;
    }

References $res, and ILIAS\Repository\int().

Here is the call graph for this function:

◆ getSubitemIds()

ilSearchResult::getSubitemIds ( )

Returns: list<array{id: int, type: string}>

Definition at line 305 of file class.ilSearchResult.php.

                                   : array
    {
        $res = array();
        foreach ($this->getResults() as $row) {
            $res[$row['obj_id']] = $row['child'] ?? [];
        }
        return $res;
    }

References $res.

◆ getUniqueResults()

ilSearchResult::getUniqueResults ( )

Get unique results.

Return an array of obj_id (No multiple results for references) Results are stored with 'ref_id'. This method is typically called after checking access of entries.

Definition at line 275 of file class.ilSearchResult.php.

                                      : array
    {
        $obj_ids = [];
        $objects = [];
        foreach ($this->results as $result) {
            if (in_array($result['obj_id'], $obj_ids)) {
                continue;
            }
            $obj_ids[] = $result['obj_id'];
            $objects[] = $result;
        }
        return $objects;
    }

◆ getUserId()

ilSearchResult::getUserId ( )

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

                               : int
    {
        return $this->user_id;
    }

References $user_id.

◆ initUserSearchCache()

ilSearchResult::initUserSearchCache ( )

protected

Definition at line 563 of file class.ilSearchResult.php.

                                            : void
    {
        $this->search_cache = ilUserSearchCache::_getInstance($this->getUserId());
        $this->offset = $this->getMaxHits() * ($this->search_cache->getResultPageNumber() - 1) ;
    }

References ilUserSearchCache\_getInstance().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ intersectEntries()

ilSearchResult::intersectEntries ( ilSearchResult $result_obj )

Build intersection of entries (all entries that are present in both result sets)

Definition at line 217 of file class.ilSearchResult.php.

                                                                : void
    {
        $new_entries = $this->getEntries();
        $this->entries = [];
        foreach ($result_obj->getEntries() as $entry) {
            $obj_id = $entry['obj_id'];
            if (isset($new_entries[$obj_id])) {
                $this->addEntry(
                    $new_entries[$obj_id]['obj_id'],
                    $new_entries[$obj_id]['type'],
                    $new_entries[$obj_id]['found']
                );
 
                $this->__updateEntryChilds(
                    $new_entries[$obj_id]['obj_id'],
                    $new_entries[$obj_id]['child']
                );
            }
        }
    }

References getEntries().

Here is the call graph for this function:

◆ isLimitReached()

ilSearchResult::isLimitReached ( )

Definition at line 103 of file class.ilSearchResult.php.

                                    : bool
    {
        return $this->limit_reached;
    }

References $limit_reached.

◆ isOffsetReached()

ilSearchResult::isOffsetReached ( int $a_counter )

Check if offset is reached.

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

                                                   : bool
    {
        return !($a_counter < $this->offset);
    }

References $offset.

◆ mergeEntries()

ilSearchResult::mergeEntries ( ilSearchResult $result_obj )

merge entries of this instance and another result object

Definition at line 181 of file class.ilSearchResult.php.

                                                            : void
    {
        foreach ($result_obj->getEntries() as $obj_id => $entry) {
            $this->addEntry($entry['obj_id'], $entry['type'], $entry['found']);
            $this->__updateEntryChilds($entry['obj_id'], $entry['child']);
        }
    }

References getEntries().

Referenced by ILIAS\Search\GUI\Direct\SearcherImpl\searchDetails().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ numEntries()

ilSearchResult::numEntries ( )

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

                                : int
    {
        return count($this->getEntries());
    }

◆ preventOverwritingMaxhits()

ilSearchResult::preventOverwritingMaxhits ( ?bool $a_flag = null )

If you call this function and pass "true" the maxhits setting will not be overwritten in __initSearchSettingsObject() @access public.

Parameters

bool | null $a_flag true or false to set the flag or leave blank to get the status of the flag

Returns: bool|ilSearchResult if called without parameter the status of the flag will be returned, otherwise $this

Definition at line 576 of file class.ilSearchResult.php.

    {
        if (null === $a_flag) {
            return $this->preventOverwritingMaxhits;
        }
 
        $this->preventOverwritingMaxhits = $a_flag;
 
        return $this;
    }

◆ read()

ilSearchResult::read ( int $a_type = ilUserSearchCache::DEFAULT_SEARCH )

Definition at line 518 of file class.ilSearchResult.php.

                                                                       : void
    {
        $this->results = $this->search_cache->getResults();
    }

◆ save()

ilSearchResult::save ( int $a_type = ilUserSearchCache::DEFAULT_SEARCH )

Definition at line 513 of file class.ilSearchResult.php.

                                                                       : void
    {
        $this->search_cache->save();
    }

◆ setMaxHits()

ilSearchResult::setMaxHits ( int $a_max_hits )

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

                                               : void
    {
        $this->max_hits = $a_max_hits;
    }

◆ setRequiredPermission()

ilSearchResult::setRequiredPermission ( string $a_permission )

Set the required permission for the rbac checks in function 'filter()'.

Definition at line 79 of file class.ilSearchResult.php.

                                                               : void
    {
        $this->permission = $a_permission;
    }

◆ setUserId()

ilSearchResult::setUserId ( int $a_user_id )

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

                                             : void
    {
        $this->user_id = $a_user_id;
    }

Field Documentation

◆ $db

ilDBInterface ilSearchResult::$db

protected

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

◆ $entries

array ilSearchResult::$entries = array()

private

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

Referenced by getEntries().

◆ $ilAccess

ilAccess ilSearchResult::$ilAccess

protected

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

◆ $limit_reached

bool ilSearchResult::$limit_reached = false

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

Referenced by isLimitReached().

◆ $logger

ilLogger ilSearchResult::$logger

protected

Definition at line 54 of file class.ilSearchResult.php.

◆ $lom_services

LOMServices ilSearchResult::$lom_services

protected

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

◆ $max_hits

int ilSearchResult::$max_hits = 0

private

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

Referenced by getMaxHits().

◆ $observers

array ilSearchResult::$observers = array()

private

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

◆ $offset

int ilSearchResult::$offset = 0

protected

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

Referenced by isOffsetReached().

◆ $permission

string ilSearchResult::$permission = 'visible'

private

Definition at line 30 of file class.ilSearchResult.php.

Referenced by getRequiredPermission().

◆ $preventOverwritingMaxhits

bool ilSearchResult::$preventOverwritingMaxhits = false

protected

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

◆ $results

array ilSearchResult::$results = array()

private

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

◆ $search_cache

ilUserSearchCache ilSearchResult::$search_cache

protected

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

◆ $search_settings

ilSearchSettings ilSearchResult::$search_settings

protected

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

◆ $tree

ilTree ilSearchResult::$tree

protected

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

◆ $user

ilObjUser ilSearchResult::$user

protected

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

◆ $user_id

int ilSearchResult::$user_id

private

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

Referenced by getUserId().

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

components/ILIAS/Search/classes/class.ilSearchResult.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __initSearchSettingsObject()

◆ __updateEntryChilds()

◆ __updateResultChilds()

◆ addEntry()

◆ addObserver()

◆ addResult()

◆ callListeners()

◆ diffEntriesFromResult()

◆ filter()

◆ filterResults()

◆ findEntriesWithCopyright()

◆ getEntries()

◆ getMaxHits()

◆ getRequiredPermission()

◆ getResultIds()

◆ getResults()

◆ getResultsByObjId()

◆ getResultsForPresentation()

◆ getSubitemIds()

◆ getUniqueResults()

◆ getUserId()

◆ initUserSearchCache()

◆ intersectEntries()

◆ isLimitReached()

◆ isOffsetReached()

◆ mergeEntries()

◆ numEntries()

◆ preventOverwritingMaxhits()

◆ read()

◆ save()

◆ setMaxHits()

◆ setRequiredPermission()

◆ setUserId()

Field Documentation

◆ $db

◆ $entries

◆ $ilAccess

◆ $limit_reached

◆ $logger

◆ $lom_services

◆ $max_hits

◆ $observers

◆ $offset

◆ $permission

◆ $preventOverwritingMaxhits

◆ $results

◆ $search_cache

◆ $search_settings

◆ $tree

◆ $user

◆ $user_id