ilLuceneSearchResultFilter Class Reference

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

Collaboration diagram for ilLuceneSearchResultFilter:

Public Member Functions
	addFilter (ilLuceneResultFilter $filter)
	setCandidates (ilLuceneSearchResult $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 (int $a_user_id)

Protected Member Functions
	__construct (int $a_user_id)
	Singleton constructor. More...
	checkFilter (int $a_ref_id)
	check appended filter More...
	append (int $a_ref_id, int $a_obj_id)
	Append to filtered results. More...
	isOffsetReached (int $a_current_nr)
	Check if offset is reached. More...

Protected Attributes
int	$user_id
ilLuceneSearchResult	$result = null
array	$checked = []
ilSearchSettings	$settings
ilUserSearchCache	$cache
string	$required_permission = 'visible'
bool	$limit_reached = false
int	$offset = 0
array	$filters = array()
ilAccess	$access

Static Protected Attributes
static ilLuceneSearchResultFilter	$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

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

Constructor & Destructor Documentation

__construct()

ilLuceneSearchResultFilter::__construct ( int  $a_user_id )

protected

Singleton constructor.

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

References $DIC, ilUserSearchCache\_getInstance(), ILIAS\Repository\access(), ilSearchSettings\getInstance(), getUserId(), and ILIAS\Repository\settings().

    {
        global $DIC;

        $this->access = $DIC->access();
        $this->user_id = $a_user_id;
        $this->settings = ilSearchSettings::getInstance();
        $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

)

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

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

append()

ilLuceneSearchResultFilter::append ( int  $a_ref_id, int  $a_obj_id  )

protected

Append to filtered results.

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

Referenced by filter().

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

Here is the caller graph for this function:

checkFilter()

ilLuceneSearchResultFilter::checkFilter ( int  $a_ref_id )

protected

check appended filter

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

Referenced by filter().

                                                 : bool
    {
        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.

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

References $ref_id, ilObject\_getAllReferences(), ILIAS\Repository\access(), append(), checkFilter(), getCandidates(), ilLoggerFactory\getLogger(), getRequiredPermission(), getResultIds(), isOffsetReached(), and ILIAS\Repository\settings().

                            : bool
    {
        // 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 ($this->access->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

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

References $result.

Referenced by filter().

                                   : ?ilLuceneSearchResult
    {
        return $this->result;
    }

Here is the caller graph for this function:

getInstance()

static ilLuceneSearchResultFilter::getInstance ( int  $a_user_id )

static

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

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

                                                      : ilLuceneSearchResultFilter
    {
        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

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

References ILIAS\Repository\settings().

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

Here is the call graph for this function:

getRequiredPermission()

ilLuceneSearchResultFilter::getRequiredPermission

(

)

Get required permission.

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

References $required_permission.

Referenced by filter().

                                           : string
    {
        return $this->required_permission;
    }

Here is the caller graph for this function:

getResultIds()

ilLuceneSearchResultFilter::getResultIds

(

)

get filtered ids

Returns

int[] array of filtered ref_ids

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

References $checked.

Referenced by filter().

                                  : array
    {
        return $this->checked;
    }

Here is the caller graph for this function:

getResultObjIds()

ilLuceneSearchResultFilter::getResultObjIds

(

)

get filtered ids

Returns

int[] array of filtered obj_ids

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

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

getResults()

ilLuceneSearchResultFilter::getResults

(

)

get results

Returns

int[] array of ids

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

References $checked.

    {
        return $this->checked;
    }

getUserId()

ilLuceneSearchResultFilter::getUserId

(

)

Get user id.

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

References $user_id.

Referenced by __construct().

                               : int
    {
        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 116 of file class.ilLuceneSearchResultFilter.php.

References $limit_reached.

                                    : bool
    {
        return $this->limit_reached;
    }

isOffsetReached()

ilLuceneSearchResultFilter::isOffsetReached ( int  $a_current_nr )

protected

Check if offset is reached.

Parameters

int

$a_current_nr

Current result number

Returns

bool

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

References $offset.

Referenced by filter().

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

Here is the caller graph for this function:

loadFromDb()

ilLuceneSearchResultFilter::loadFromDb

(

)

Load results from db.

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

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

setCandidates()

ilLuceneSearchResultFilter::setCandidates

(

ilLuceneSearchResult

$a_ids

)

Set result ids.

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

                                                              : void
    {
        $this->result = $a_ids;
    }

Field Documentation

$access

ilAccess ilLuceneSearchResultFilter::$access

protected

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

$cache

ilUserSearchCache ilLuceneSearchResultFilter::$cache

protected

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

$checked

array ilLuceneSearchResultFilter::$checked = []

protected

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

Referenced by getResultIds(), and getResults().

$filters

array ilLuceneSearchResultFilter::$filters = array()

protected

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

$instance

ilLuceneSearchResultFilter ilLuceneSearchResultFilter::$instance = null

staticprotected

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

$limit_reached

bool ilLuceneSearchResultFilter::$limit_reached = false

protected

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

Referenced by isLimitReached().

$offset

int ilLuceneSearchResultFilter::$offset = 0

protected

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

Referenced by isOffsetReached().

$required_permission

string ilLuceneSearchResultFilter::$required_permission = 'visible'

protected

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

Referenced by getRequiredPermission().

$result

ilLuceneSearchResult ilLuceneSearchResultFilter::$result = null

protected

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

Referenced by getCandidates().

$settings

ilSearchSettings ilLuceneSearchResultFilter::$settings

protected

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

$user_id

int ilLuceneSearchResultFilter::$user_id

protected

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

Referenced by getUserId().

---

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

• components/ILIAS/Search/classes/Lucene/class.ilLuceneSearchResultFilter.php