Validate Lucene search results Do access checks, create ref_ids from obj_ids... More...

Collaboration diagram for ilLuceneSearchResultFilter:

Public Member Functions
	addFilter (ilLuceneResultFilter $filter)
	add filter More...

	setCandidates ($a_ids)
	Set result ids. More...

	getCandidates ()
	get result ids More...

	getUserId ()
	Get user id. More...

	getRequiredPermission ()
	Get required permission. More...

	isLimitReached ()
	Check if search max hits is reached. More...

	getResultIds ()
	get filtered ids More...

	getResultObjIds ()
	get filtered ids More...

	getResults ()
	get results More...

	getMaxHits ()
	get max hits More...

	loadFromDb ()
	Load results from db. More...

	filter ()
	Filter search results. More...

Static Public Member Functions
static	getInstance ($a_user_id)

Protected Member Functions
	__construct ($a_user_id)
	Singleton constructor. More...

	checkFilter ($a_ref_id)
	check appended filter More...

	append ($a_ref_id, $a_obj_id)
	Append to filtered results. More...

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

Protected Attributes
	$user_id = null

	$result = array()

	$checked = array()

	$settings

	$cache

	$required_permission = 'visible'

	$limit_reached = false

	$offset = 0

	$filters = array()

Static Protected Attributes
static	$instance = null

Detailed Description

Validate Lucene search results Do access checks, create ref_ids from obj_ids...

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilLuceneSearchResultFilter::__construct ( $a_user_id )

protected

Singleton constructor.

Parameters

int $a_usr_id user id

Returns

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

References ilUserSearchCache\_getInstance(), ilSearchSettings\getInstance(), getUserId(), and settings().

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

Here is the call graph for this function:

Member Function Documentation

◆ addFilter()

ilLuceneSearchResultFilter::addFilter ( ilLuceneResultFilter $filter )

add filter

Parameters

Definition at line 85 of file class.ilLuceneSearchResultFilter.php.

     {
         $this->filters[] = $filter;
     }

◆ append()

ilLuceneSearchResultFilter::append	(	$a_ref_id,
		$a_obj_id
	)

protected

Append to filtered results.

Parameters

int	ref_id
int	obj_id

Definition at line 276 of file class.ilLuceneSearchResultFilter.php.

Referenced by filter().

     {
         $this->checked[$a_ref_id] = $a_obj_id;
     }

Here is the caller graph for this function:

◆ checkFilter()

ilLuceneSearchResultFilter::checkFilter ( $a_ref_id )

protected

check appended filter

Parameters

int $a_ref_id reference id

Returns: bool

Definition at line 261 of file class.ilLuceneSearchResultFilter.php.

Referenced by filter().

     {
         foreach ($this->filters as $filter) {
             if (!$filter->filter($a_ref_id)) {
                 return false;
             }
         }
         return true;
     }

Here is the caller graph for this function:

◆ filter()

ilLuceneSearchResultFilter::filter ( )

Filter search results.

Do RBAC checks.

public

Parameters

int	root node id
bool	check and boolean search

Returns: bool success status

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

References $DIC, $tree, ilObject\_getAllReferences(), append(), checkFilter(), getCandidates(), ilLoggerFactory\getLogger(), getRequiredPermission(), getResultIds(), isOffsetReached(), and settings().

     {
         global $DIC;
 
         $ilAccess = $DIC['ilAccess'];
         $tree = $DIC['tree'];
 
         // get ref_ids and check access
         $counter = 0;
         $offset_counter = 0;
         
         foreach ($this->getCandidates() as $obj_id) {
             // Check referenced objects
             foreach (ilObject::_getAllReferences($obj_id) as $ref_id) {
                 // Check filter
                 if (!$this->checkFilter($ref_id)) {
                     $this->cache->appendToFailed($ref_id);
                     continue;
                 }
 
                 // Access failed by prior check
                 if ($this->cache->isFailed($ref_id)) {
                     continue;
                 }
                 // Offset check
                 if ($this->cache->isChecked($ref_id) and !$this->isOffsetReached($offset_counter)) {
                     ilLoggerFactory::getLogger('src')->debug('Result was checked');
                     $offset_counter++;
                     break;
                 }
                 
                 // RBAC check
                 if ($ilAccess->checkAccessOfUser(
                     $this->getUserId(),
                     $this->getRequiredPermission(),
                     '',
                     $ref_id,
                     '',
                     $obj_id
                 )) {
                     ++$counter;
                     $offset_counter++;
                     $this->append($ref_id, $obj_id);
                     $this->cache->appendToChecked($ref_id, $obj_id);
                     break;
                 } else {
                     $this->cache->appendToFailed($ref_id);
                 }
             }
             if ($counter >= $this->settings->getMaxHits()) {
                 $this->limit_reached = true;
                 $this->cache->setResults($this->getResultIds());
                 $this->cache->save();
                 return false;
             }
         }
         $this->cache->setResults($this->getResultIds());
         $this->cache->save();
         return true;
     }

Here is the call graph for this function:

◆ getCandidates()

ilLuceneSearchResultFilter::getCandidates ( )

get result ids

Returns: array result ids

Definition at line 104 of file class.ilLuceneSearchResultFilter.php.

Referenced by filter().

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

Here is the caller graph for this function:

◆ getInstance()

static ilLuceneSearchResultFilter::getInstance ( $a_user_id )

static

Parameters

int $a_user_id user_id

Returns

Definition at line 72 of file class.ilLuceneSearchResultFilter.php.

Referenced by ilLuceneAdvancedSearchGUI\performSearch(), ilLuceneSearchGUI\performSearch(), ilSoapObjectAdministration\searchObjects(), ilLuceneAdvancedSearchGUI\showSavedResults(), and ilLuceneSearchGUI\showSavedResults().

     {
         if (self::$instance == null) {
             return self::$instance = new ilLuceneSearchResultFilter($a_user_id);
         }
         return self::$instance;
     }

Here is the caller graph for this function:

◆ getMaxHits()

ilLuceneSearchResultFilter::getMaxHits ( )

get max hits

Returns: int max hits per page

Definition at line 170 of file class.ilLuceneSearchResultFilter.php.

References settings().

     {
         return $this->settings->getMaxHits();
     }

Here is the call graph for this function:

◆ getRequiredPermission()

ilLuceneSearchResultFilter::getRequiredPermission ( )

Get required permission.

Returns: string required rbac permission

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

References $required_permission.

Referenced by filter().

     {
         return $this->required_permission;
     }

Here is the caller graph for this function:

◆ getResultIds()

ilLuceneSearchResultFilter::getResultIds ( )

get filtered ids

Returns: array array of filtered ref_ids

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

Referenced by filter().

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

Here is the caller graph for this function:

◆ getResultObjIds()

ilLuceneSearchResultFilter::getResultObjIds ( )

get filtered ids

Returns: array array of filtered ref_ids

Definition at line 149 of file class.ilLuceneSearchResultFilter.php.

     {
         foreach ($this->checked as $obj_id) {
             $obj_ids[] = $obj_id;
         }
         return $obj_ids ? $obj_ids : array();
     }

◆ getResults()

ilLuceneSearchResultFilter::getResults ( )

get results

Returns: array array of ref_ids

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

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

◆ getUserId()

ilLuceneSearchResultFilter::getUserId ( )

Get user id.

Returns: int user_id

Definition at line 113 of file class.ilLuceneSearchResultFilter.php.

References $user_id.

Referenced by __construct().

     {
         return $this->user_id;
     }

Here is the caller graph for this function:

◆ isLimitReached()

ilLuceneSearchResultFilter::isLimitReached ( )

Check if search max hits is reached.

Returns: bool max hits reached

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

References $limit_reached.

     {
         return (bool) $this->limit_reached;
     }

◆ isOffsetReached()

ilLuceneSearchResultFilter::isOffsetReached ( $a_current_nr )

protected

Check if offset is reached.

Parameters

int $a_current_nr Current result number

Returns: bool

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

Referenced by filter().

     {
         return $a_current_nr < $this->offset ? false : true;
     }

Here is the caller graph for this function:

◆ loadFromDb()

ilLuceneSearchResultFilter::loadFromDb ( )

Load results from db.

Returns

Definition at line 179 of file class.ilLuceneSearchResultFilter.php.

     {
         $this->checked = $this->cache->getResults();
     }

◆ setCandidates()

ilLuceneSearchResultFilter::setCandidates ( $a_ids )

Set result ids.

Parameters

mixed $a_ids Lucene result ids or instance of Iterator

Returns: void

Definition at line 95 of file class.ilLuceneSearchResultFilter.php.

     {
         $this->result = $a_ids;
     }

Field Documentation

◆ $cache

ilLuceneSearchResultFilter::$cache

protected

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

◆ $checked

ilLuceneSearchResultFilter::$checked = array()

protected

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

◆ $filters

ilLuceneSearchResultFilter::$filters = array()

protected

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

◆ $instance

ilLuceneSearchResultFilter::$instance = null

staticprotected

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

◆ $limit_reached

ilLuceneSearchResultFilter::$limit_reached = false

protected

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

Referenced by isLimitReached().

◆ $offset

ilLuceneSearchResultFilter::$offset = 0

protected

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

◆ $required_permission

ilLuceneSearchResultFilter::$required_permission = 'visible'

protected

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

Referenced by getRequiredPermission().

◆ $result

ilLuceneSearchResultFilter::$result = array()

protected

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

◆ $settings

ilLuceneSearchResultFilter::$settings

protected

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

◆ $user_id

ilLuceneSearchResultFilter::$user_id = null

protected

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

Referenced by getUserId().

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

Services/Search/classes/Lucene/class.ilLuceneSearchResultFilter.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFilter()

◆ append()

◆ checkFilter()

◆ filter()

◆ getCandidates()

◆ getInstance()

◆ getMaxHits()

◆ getRequiredPermission()

◆ getResultIds()

◆ getResultObjIds()

◆ getResults()

◆ getUserId()

◆ isLimitReached()

◆ isOffsetReached()

◆ loadFromDb()

◆ setCandidates()

Field Documentation

◆ $cache

◆ $checked

◆ $filters

◆ $instance

◆ $limit_reached

◆ $offset

◆ $required_permission

◆ $result

◆ $settings

◆ $user_id