Collaboration diagram for ilSearchResult:

Public Member Functions
	__construct ($a_user_id=0)
	Constructor @access public. More...

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

	getRequiredPermission ()

	setUserId ($a_user_id)

	getUserId ()

	getEntries ()

	isLimitReached ()

	setMaxHits ($a_max_hits)

	getMaxHits ()

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

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

	numEntries ()
	Check number of entries @access public. More...

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

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

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

	addResult ($a_ref_id, $a_obj_id, $a_type)
	add search result Results are stored with 'ref_id'. More...

	getResults ()

	getResultIds ()
	get result ids More...

	getResultsByObjId ()

	getUniqueResults ()
	Get unique results. More...

	getResultsForPresentation ()

	getSubitemIds ()

	filter ($a_root_node, $check_and)
	Filter search result. More...

	filterResults ($a_root_node)
	Filter search area of result set @access public. More...

	save ($a_type=DEFAULT_SEARCH)
	Save search results. More...

	read ($a_type=DEFAULT_SEARCH)
	read search results More...

	__updateEntryChilds ($a_obj_id, $a_childs)
	Update childs for a specific entry. More...

	__updateResultChilds ($a_ref_id, $a_childs)
	Update childs for a specific result. More...

	__initSearchSettingsObject ()

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

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

	callListeners ($a_ref_id, &$a_data)

Data Fields
	$permission = 'visible'

	$user_id

	$entries = array()

	$results = array()

	$observers = array()

	$ilias

	$ilAccess

	$limit_reached = false

	$result

Protected Member Functions
	initUserSearchCache ()
	Init user search cache. More...

Protected Attributes
	$search_cache = null

	$offset = 0

	$preventOverwritingMaxhits = false

Private Attributes
	$logger

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilSearchResult::__construct ( $a_user_id = 0 )

Constructor @access public.

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

    {
        global $DIC;
 
        $ilias = $DIC['ilias'];
        $ilAccess = $DIC['ilAccess'];
        $ilDB = $DIC['ilDB'];
        $ilUser = $DIC['ilUser'];
 
        $this->logger = $DIC->logger()->src();
 
        $this->ilAccess = $ilAccess;
        if ($a_user_id) {
            $this->user_id = $a_user_id;
        } else {
            $this->user_id = $ilUser->getId();
        }
        $this->__initSearchSettingsObject();
        $this->initUserSearchCache();
 
        $this->db = $ilDB;
    }

References $DIC, $ilAccess, $ilDB, $ilias, $ilUser, __initSearchSettingsObject(), and initUserSearchCache().

Here is the call graph for this function:

Member Function Documentation

◆ __initSearchSettingsObject()

ilSearchResult::__initSearchSettingsObject ( )

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

    {
        include_once 'Services/Search/classes/class.ilSearchSettings.php';
 
        $this->search_settings = new ilSearchSettings();
        if (!$this->preventOverwritingMaxhits()) {
            $this->setMaxHits($this->search_settings->getMaxHits());
        }
    }

References preventOverwritingMaxhits(), and setMaxHits().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __updateEntryChilds()

ilSearchResult::__updateEntryChilds	(	$a_obj_id,
		$a_childs
	)

Update childs for a specific entry.

Parameters

integer	object object_id
array	array of child ids. E.g 'pg', 'st' @access private

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

    {
        if ($this->entries[$a_obj_id] and is_array($a_childs)) {
            foreach ($a_childs as $child_id) {
                if ($child_id) {
                    $this->entries[$a_obj_id]['child'][$child_id] = $child_id;
                }
            }
            return true;
        }
        return false;
    }

Referenced by diffEntriesFromResult(), intersectEntries(), and mergeEntries().

Here is the caller graph for this function:

◆ __updateResultChilds()

ilSearchResult::__updateResultChilds	(	$a_ref_id,
		$a_childs
	)

Update childs for a specific result.

Parameters

integer	object ref_id
array	array of child ids. E.g 'pg', 'st' @access private

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

    {
        if ($this->results[$a_ref_id] and is_array($a_childs)) {
            foreach ($a_childs as $child_id) {
                $this->results[$a_ref_id]['child'][$child_id] = $child_id;
            }
            return true;
        }
        return false;
    }

Referenced by filter(), and filterResults().

Here is the caller graph for this function:

◆ addEntry()

ilSearchResult::addEntry	(	$a_obj_id,
		$a_type,
		$found,
		$a_child_id = `0`
	)

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

This method is typically called to store db query results.

Parameters

integer	object object_id
string	obj_type 'lm' or 'crs' ...
array	value position of query parser words in query string
integer	child id e.g id of page or chapter @access public

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

    {
        // Create new entry if it not exists
        if (!$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_id] = $a_child_id;
            }
        } else {
            // replace or add child ('pg','st') id
            if ($a_child_id and $a_child_id != $a_obj_id) {
                $this->entries[$a_obj_id]['child'][$a_child_id] = $a_child_id;
            }
 
            // UPDATE FOUND
            $counter = 0;
            foreach ($found as $position) {
                if ($position) {
                    $this->entries[$a_obj_id]['found'][$counter] = $position;
                }
                $counter++;
            }
        }
        return true;
    }

Referenced by diffEntriesFromResult(), intersectEntries(), and mergeEntries().

Here is the caller graph for this function:

◆ addObserver()

ilSearchResult::addObserver	(	&	$a_class,
			$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	class of callback function
string	name of callback method @access public

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

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

◆ addResult()

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

add search result Results are stored with 'ref_id'.

This method is typically called after checking access of entries.

Parameters

integer	ref_id
integer	obj_id
string	obj_type 'lm' or 'crs' ... @access public

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

    {
        $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;
    }

Referenced by filter(), and filterResults().

Here is the caller graph for this function:

◆ callListeners()

ilSearchResult::callListeners	(		$a_ref_id,
		&	$a_data
	)

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

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

Referenced by filter().

Here is the caller graph for this function:

◆ diffEntriesFromResult()

ilSearchResult::diffEntriesFromResult ( & $result_obj )

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

Parameters

object result_obj @access public

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

    {
        $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 __updateEntryChilds(), addEntry(), and getEntries().

Here is the call graph for this function:

◆ filter()

ilSearchResult::filter	(	$a_root_node,
		$check_and
	)

Filter search result.

Do RBAC checks.

Allows paging of results for referenced objects

@access public

Parameters

int	root node id
bool	check and boolean search

Returns: bool success status

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

    {
        global $DIC;
 
        $tree = $DIC['tree'];
        
        // 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;
            }
            // Check referenced objects
            foreach (ilObject::_getAllReferences($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 $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, $entry['child']);
 
                            $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;
    }

References $DIC, $type, __updateResultChilds(), ilObject\_getAllReferences(), ilObject\_lookupType(), addResult(), callListeners(), ilAccess\checkAccessOfUser(), getEntries(), getMaxHits(), and ROOT_FOLDER_ID.

Here is the call graph for this function:

◆ filterResults()

ilSearchResult::filterResults ( $a_root_node )

Filter search area of result set @access public.

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

    {
        global $DIC;
 
        $tree = $DIC['tree'];
 
        $tmp_results = $this->getResults();
        $this->results = array();
        foreach ($tmp_results as $result) {
            if ($tree->isGrandChild($a_root_node, $result['ref_id']) and $tree->isInTree($result['ref_id'])) {
                $this->addResult($result['ref_id'], $result['obj_id'], $result['type']);
                $this->__updateResultChilds($result['ref_id'], $result['child']);
            }
        }
 
        return true;
    }

References $DIC, $result, __updateResultChilds(), addResult(), and getResults().

Here is the call graph for this function:

◆ getEntries()

ilSearchResult::getEntries ( )

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

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

Referenced by diffEntriesFromResult(), filter(), intersectEntries(), and numEntries().

Here is the caller graph for this function:

◆ getMaxHits()

ilSearchResult::getMaxHits ( )

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

    {
        return $this->max_hits;
    }

Referenced by filter(), and initUserSearchCache().

Here is the caller graph for this function:

◆ getRequiredPermission()

ilSearchResult::getRequiredPermission ( )

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

    {
        return $this->permission;
    }

References $permission.

◆ getResultIds()

ilSearchResult::getResultIds ( )

get result ids

@access public

Returns: array result ids

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

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

References getResults().

Here is the call graph for this function:

◆ getResults()

ilSearchResult::getResults ( )

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

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

Referenced by filterResults(), getResultIds(), getResultsByObjId(), getResultsForPresentation(), and getSubitemIds().

Here is the caller graph for this function:

◆ getResultsByObjId()

ilSearchResult::getResultsByObjId ( )

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

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

References getResults().

Here is the call graph for this function:

◆ getResultsForPresentation()

ilSearchResult::getResultsForPresentation ( )

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

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

References $res, $result, and getResults().

Here is the call graph for this function:

◆ getSubitemIds()

ilSearchResult::getSubitemIds ( )

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

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

References $res, and getResults().

Here is the call graph for this function:

◆ 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. @access public

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

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

References $result.

◆ getUserId()

ilSearchResult::getUserId ( )

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

    {
        return $this->user_id;
    }

References $user_id.

Referenced by initUserSearchCache().

Here is the caller graph for this function:

◆ initUserSearchCache()

ilSearchResult::initUserSearchCache ( )

protected

Init user search cache.

@access private

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

    {
        include_once('Services/Search/classes/class.ilUserSearchCache.php');
        $this->search_cache = ilUserSearchCache::_getInstance($this->getUserId());
        $this->offset = $this->getMaxHits() * ($this->search_cache->getResultPageNumber() - 1) ;
    }

References ilUserSearchCache\_getInstance(), getMaxHits(), and getUserId().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ intersectEntries()

ilSearchResult::intersectEntries ( & $result_obj )

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

Parameters

object result_obj @access public

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

    {
        $new_entries = $this->getEntries();
        $this->entries = array();
 
        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 __updateEntryChilds(), addEntry(), and getEntries().

Here is the call graph for this function:

◆ isLimitReached()

ilSearchResult::isLimitReached ( )

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

    {
        return $this->limit_reached ? true : false;
    }

References true.

◆ isOffsetReached()

ilSearchResult::isOffsetReached ( $a_counter )

Check if offset is reached.

@access public

Parameters

int	current counter of result

Returns: bool reached or not

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

    {
        return ($a_counter < $this->offset) ? false : true;
    }

◆ mergeEntries()

ilSearchResult::mergeEntries ( & $result_obj )

merge entries of this instance and another result object

Parameters

object result_obj @access public

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

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

References __updateEntryChilds(), and addEntry().

Here is the call graph for this function:

◆ numEntries()

ilSearchResult::numEntries ( )

Check number of entries @access public.

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

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

References getEntries().

Here is the call graph for this function:

◆ preventOverwritingMaxhits()

ilSearchResult::preventOverwritingMaxhits ( $a_flag = null )

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

@access public

Parameters

boolean $a_flag true or false to set the flag or leave blank to get the status of the flag @returmn boolean if called without parameter the status of the flag will be returned, otherwise $this

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

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

References $preventOverwritingMaxhits, and preventOverwritingMaxhits().

Referenced by __initSearchSettingsObject(), and preventOverwritingMaxhits().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilSearchResult::read ( $a_type = DEFAULT_SEARCH )

read search results

Parameters

integer DEFAULT_SEARCH or ADVANCED_SEARCH @access public

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

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

◆ save()

ilSearchResult::save ( $a_type = DEFAULT_SEARCH )

Save search results.

Parameters

integer DEFAULT_SEARCH or ADVANCED_SEARCH @access public

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

    {
        $this->search_cache->save();
        return false;
    }

◆ setMaxHits()

ilSearchResult::setMaxHits ( $a_max_hits )

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

    {
        $this->max_hits = $a_max_hits;
    }

Referenced by __initSearchSettingsObject().

Here is the caller graph for this function:

◆ setRequiredPermission()

ilSearchResult::setRequiredPermission ( $a_permission )

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

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

    {
        $this->permission = $a_permission;
    }

◆ setUserId()

ilSearchResult::setUserId ( $a_user_id )

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

    {
        $this->user_id = $a_user_id;
    }

Field Documentation

◆ $entries

ilSearchResult::$entries = array()

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

◆ $ilAccess

ilSearchResult::$ilAccess

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

Referenced by __construct().

◆ $ilias

ilSearchResult::$ilias

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

Referenced by __construct().

◆ $limit_reached

ilSearchResult::$limit_reached = false

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

◆ $logger

ilSearchResult::$logger

private

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

◆ $observers

ilSearchResult::$observers = array()

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

◆ $offset

ilSearchResult::$offset = 0

protected

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

◆ $permission

ilSearchResult::$permission = 'visible'

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

Referenced by getRequiredPermission().

◆ $preventOverwritingMaxhits

ilSearchResult::$preventOverwritingMaxhits = false

protected

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

Referenced by preventOverwritingMaxhits().

◆ $result

ilSearchResult::$result

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

Referenced by filterResults(), getResultsForPresentation(), and getUniqueResults().

◆ $results

ilSearchResult::$results = array()

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

◆ $search_cache

ilSearchResult::$search_cache = null

protected

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

◆ $user_id

ilSearchResult::$user_id

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

Referenced by getUserId().

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

Services/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()

◆ getEntries()

◆ getMaxHits()

◆ getRequiredPermission()

◆ getResultIds()

◆ getResults()

◆ getResultsByObjId()

◆ getResultsForPresentation()

◆ getSubitemIds()

◆ getUniqueResults()

◆ getUserId()

◆ initUserSearchCache()

◆ intersectEntries()

◆ isLimitReached()

◆ isOffsetReached()

◆ mergeEntries()

◆ numEntries()

◆ preventOverwritingMaxhits()

◆ read()

◆ save()

◆ setMaxHits()

◆ setRequiredPermission()

◆ setUserId()

Field Documentation

◆ $entries

◆ $ilAccess

◆ $ilias

◆ $limit_reached

◆ $logger

◆ $observers

◆ $offset

◆ $permission

◆ $preventOverwritingMaxhits

◆ $result

◆ $results

◆ $search_cache

◆ $user_id