Class for storing search result. More...

Collaboration diagram for ilUserSearchCache:

Public Member Functions
	isAnonymous ()
	Check if current user is anonymous user. More...

	switchSearchType (int $a_type)
	switch to search type reads entries from database More...

	getResults ()
	Get results. More...

	setResults (array $a_results)
	Set results. More...

	addResult (array $a_result_item)
	Append result. More...

	appendToFailed (int $a_ref_id)
	Append failed id. More...

	isFailed (int $a_ref_id)
	check if reference has failed access More...

	appendToChecked (int $a_ref_id, int $a_obj_id)

	isChecked (int $a_ref_id)

	getCheckedItems ()
	Get all checked items public. More...

	setResultPageNumber (int $a_number)
	Set result page number. More...

	getResultPageNumber ()
	get result page number More...

	setQuery (string $a_query)

	getQuery ()

	getUrlEncodedQuery ()
	Urlencode query for further use in e.g glossariers (highlighting off search terms). More...

	setRoot (int $a_root)
	set root node of search More...

	getRoot ()

	setItemFilter (array $a_filter)

	getItemFilter ()

	setMimeFilter (array $a_filter)

	getMimeFilter ()

	setCreationFilter (array $a_filter)

	getCreationFilter ()

	deleteCachedEntries ()

	deleteCachedEntriesAnonymous ()

	delete ()

	save ()

	saveForAnonymous ()

Static Public Member Functions
static	_getInstance (int $a_usr_id)

Data Fields
const int	DEFAULT_SEARCH = 0

const int	LUCENE_DEFAULT = 5

const int	LAST_QUERY = 7

const int	LUCENE_USER_SEARCH = 8

Protected Attributes
ilDBInterface	$db

Private Member Functions
	__construct (int $a_usr_id)
	Constructor. More...

	read ()

	readAnonymous ()
	Read from session for anonymous user. More...

Private Attributes
int	$usr_id

int	$search_type = self::DEFAULT_SEARCH

array	$search_result = array()

array	$checked = array()

array	$failed = array()

int	$page_number = 1

	$query

int	$root

array	$item_filter = array()

bool	$isAnonymous = false

array	$mime_filter = array()

array	$creation_filter = array()

Static Private Attributes
static ilUserSearchCache	$instance = null

Detailed Description

Class for storing search result.

Allows paging of result sets

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

Definition at line 26 of file class.ilUserSearchCache.php.

Constructor & Destructor Documentation

◆ __construct()

ilUserSearchCache::__construct ( int $a_usr_id )

private

Constructor.

private

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

References $DIC, ANONYMOUS_USER_ID, isAnonymous(), read(), and ROOT_FOLDER_ID.

     {
         global $DIC;
 
         $this->db = $DIC->database();
 
         if ($a_usr_id == ANONYMOUS_USER_ID) {
             $this->isAnonymous = true;
         }
 
         $this->root = ROOT_FOLDER_ID;
         $this->usr_id = $a_usr_id;
         $this->search_type = self::DEFAULT_SEARCH;
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getInstance()

static ilUserSearchCache::_getInstance ( int $a_usr_id )

static

Definition at line 80 of file class.ilUserSearchCache.php.

Referenced by ilLuceneSearchResultFilter\__construct(), ilSearchBaseGUI\__construct(), ilObjGlossarySubItemListGUI\getHTML(), ilLMContentRendererGUI\initSearchHighlighting(), ilLuceneUserSearchGUI\initUserSearchCache(), ilLuceneSearchGUI\initUserSearchCache(), ilSearchResult\initUserSearchCache(), ilGlossaryPresentationGUI\listDefinitions(), and ilWikiPageGUI\preview().

                                                       : ilUserSearchCache
     {
         if (self::$instance instanceof ilUserSearchCache) {
             return self::$instance;
         }
         return self::$instance = new ilUserSearchCache($a_usr_id);
     }

Here is the caller graph for this function:

◆ addResult()

ilUserSearchCache::addResult ( array $a_result_item )

Append result.

public

Parameters

array $a_result_item (int,int,string) array(ref_id,obj_id,type)

Definition at line 138 of file class.ilUserSearchCache.php.

                                                    : bool
     {
         $this->search_result[$a_result_item['ref_id']]['ref_id'] = $a_result_item['ref_id'];
         $this->search_result[$a_result_item['ref_id']]['obj_id'] = $a_result_item['obj_id'];
         $this->search_result[$a_result_item['ref_id']]['type'] = $a_result_item['type'];
         return true;
     }

◆ appendToChecked()

ilUserSearchCache::appendToChecked	(	int	$a_ref_id,
		int	$a_obj_id
	)

Definition at line 162 of file class.ilUserSearchCache.php.

References ILIAS\UI\examples\Symbol\Glyph\Checked\checked().

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

Here is the call graph for this function:

◆ appendToFailed()

ilUserSearchCache::appendToFailed ( int $a_ref_id )

Append failed id.

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

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

◆ delete()

ilUserSearchCache::delete ( )

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

References $query, $res, and read().

                             : bool
     {
         $query = "DELETE FROM usr_search " .
             "WHERE usr_id = " . $this->db->quote($this->usr_id, 'integer') . " " .
             "AND search_type = " . $this->db->quote($this->search_type, 'integer');
         $res = $this->db->manipulate($query);
 
         $this->read();
         return true;
     }

Here is the call graph for this function:

◆ deleteCachedEntries()

ilUserSearchCache::deleteCachedEntries ( )

Definition at line 264 of file class.ilUserSearchCache.php.

References $query, $res, ILIAS\UI\examples\Symbol\Glyph\Checked\checked(), deleteCachedEntriesAnonymous(), ilDBConstants\FETCHMODE_OBJECT, isAnonymous(), and setResultPageNumber().

                                          : void
     {
         if ($this->isAnonymous()) {
             $this->deleteCachedEntriesAnonymous();
             return;
         }
         $query = "SELECT COUNT(*) num FROM usr_search " .
             "WHERE usr_id = " . $this->db->quote($this->usr_id, 'integer') . " " .
             "AND search_type = " . $this->db->quote($this->search_type, 'integer');
         $res = $this->db->query($query);
         $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
 
         if ($row->num > 0) {
             $this->db->update(
                 'usr_search',
                 array(
                     'search_result' => array('clob',serialize(array(0))),
                     'checked' => array('clob',serialize(array(0))),
                     'failed' => array('clob',serialize(array(0))),
                     'page' => array('integer',0)),
                 array(
                     'usr_id' => array('integer', $this->usr_id),
                     'search_type' => array('integer', $this->search_type)
             )
             );
         } else {
             $this->db->insert(
                 'usr_search',
                 array(
                     'search_result' => array('clob',serialize(array(0))),
                     'checked' => array('clob',serialize(array(0))),
                     'failed' => array('clob',serialize(array(0))),
                     'page' => array('integer',0),
                     'usr_id' => array('integer', $this->usr_id),
                     'search_type' => array('integer', $this->search_type),
                     'query' => array('clob',serialize(''))
             )
             );
         }
 
         $this->setResultPageNumber(1);
         $this->search_result = array();
         $this->checked = array();
         $this->failed = array();
     }

Here is the call graph for this function:

◆ deleteCachedEntriesAnonymous()

ilUserSearchCache::deleteCachedEntriesAnonymous ( )

Definition at line 310 of file class.ilUserSearchCache.php.

References ILIAS\UI\examples\Symbol\Glyph\Checked\checked(), and setResultPageNumber().

Referenced by deleteCachedEntries().

                                                   : bool
     {
         $this->setResultPageNumber(1);
         $this->search_result = array();
         $this->checked = array();
         $this->failed = array();
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCheckedItems()

ilUserSearchCache::getCheckedItems ( )

Get all checked items public.

Returns: array array(ref_id => obj_id)

Definition at line 177 of file class.ilUserSearchCache.php.

References ILIAS\UI\examples\Symbol\Glyph\Checked\checked().

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

Here is the call graph for this function:

◆ getCreationFilter()

ilUserSearchCache::getCreationFilter ( )

Definition at line 259 of file class.ilUserSearchCache.php.

References $creation_filter.

Referenced by save(), and saveForAnonymous().

                                        : array
     {
         return $this->creation_filter;
     }

Here is the caller graph for this function:

◆ getItemFilter()

ilUserSearchCache::getItemFilter ( )

Definition at line 239 of file class.ilUserSearchCache.php.

References $item_filter.

Referenced by save(), and saveForAnonymous().

                                    : array
     {
         return $this->item_filter;
     }

Here is the caller graph for this function:

◆ getMimeFilter()

ilUserSearchCache::getMimeFilter ( )

Definition at line 249 of file class.ilUserSearchCache.php.

References $mime_filter.

Referenced by save(), and saveForAnonymous().

                                    : array
     {
         return $this->mime_filter;
     }

Here is the caller graph for this function:

◆ getQuery()

ilUserSearchCache::getQuery ( )

Definition at line 208 of file class.ilUserSearchCache.php.

Referenced by getUrlEncodedQuery(), save(), and saveForAnonymous().

                               : string
     {
         return $this->query ?? '';
     }

Here is the caller graph for this function:

◆ getResultPageNumber()

ilUserSearchCache::getResultPageNumber ( )

get result page number

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

                                          : int
     {
         return $this->page_number ?: 1;
     }

◆ getResults()

ilUserSearchCache::getResults ( )

Get results.

public

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

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

◆ getRoot()

ilUserSearchCache::getRoot ( )

Definition at line 229 of file class.ilUserSearchCache.php.

References ROOT_FOLDER_ID.

Referenced by save(), and saveForAnonymous().

                              : int
     {
         return $this->root ?: ROOT_FOLDER_ID;
     }

Here is the caller graph for this function:

◆ getUrlEncodedQuery()

ilUserSearchCache::getUrlEncodedQuery ( )

Urlencode query for further use in e.g glossariers (highlighting off search terms).

Definition at line 216 of file class.ilUserSearchCache.php.

References getQuery().

                                         : string
     {
         return urlencode(str_replace('"', '.', $this->getQuery()));
     }

Here is the call graph for this function:

◆ isAnonymous()

ilUserSearchCache::isAnonymous ( )

Check if current user is anonymous user.

Returns: bool

Definition at line 92 of file class.ilUserSearchCache.php.

References $isAnonymous.

Referenced by __construct(), deleteCachedEntries(), read(), and save().

                                  : bool
     {
         return $this->isAnonymous;
     }

Here is the caller graph for this function:

◆ isChecked()

ilUserSearchCache::isChecked ( int $a_ref_id )

Definition at line 167 of file class.ilUserSearchCache.php.

References ILIAS\UI\examples\Symbol\Glyph\Checked\checked().

                                             : bool
     {
         return array_key_exists($a_ref_id, $this->checked) and $this->checked[$a_ref_id];
     }

Here is the call graph for this function:

◆ isFailed()

ilUserSearchCache::isFailed ( int $a_ref_id )

check if reference has failed access

Definition at line 157 of file class.ilUserSearchCache.php.

                                            : bool
     {
         return in_array($a_ref_id, $this->failed);
     }

◆ read()

ilUserSearchCache::read ( )

private

Definition at line 387 of file class.ilUserSearchCache.php.

References $query, $res, ILIAS\UI\examples\Symbol\Glyph\Checked\checked(), ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), isAnonymous(), readAnonymous(), setCreationFilter(), setItemFilter(), and setRoot().

Referenced by __construct(), delete(), and switchSearchType().

                            : void
     {
         $this->failed = array();
         $this->checked = array();
         $this->search_result = array();
         $this->page_number = 0;
 
         if ($this->isAnonymous()) {
             $this->readAnonymous();
             return;
         }
 
         $query = "SELECT * FROM usr_search " .
             "WHERE usr_id = " . $this->db->quote($this->usr_id, 'integer') . " " .
             "AND search_type = " . $this->db->quote($this->search_type, 'integer');
 
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->search_result = (array) unserialize((string) $row->search_result);
             if (strlen((string) $row->checked)) {
                 $this->checked = (array) unserialize((string) $row->checked);
             }
             if (strlen((string) $row->failed)) {
                 $this->failed = (array) unserialize((string) $row->failed);
             }
             $this->page_number = (int) $row->page;
             $this->setQuery(unserialize((string) $row->query));
             $this->setRoot((int) $row->root);
             $this->setItemFilter((array) unserialize((string) $row->item_filter));
             $this->setCreationFilter((array) unserialize((string) $row->creation_filter));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readAnonymous()

ilUserSearchCache::readAnonymous ( )

private

Read from session for anonymous user.

Definition at line 423 of file class.ilUserSearchCache.php.

References ILIAS\UI\examples\Symbol\Glyph\Checked\checked(), ilSession\get(), ILIAS\Repository\int(), ROOT_FOLDER_ID, setCreationFilter(), setItemFilter(), setMimeFilter(), setQuery(), and setRoot().

Referenced by read().

                                     : void
     {
         $usr_search_cache = ilSession::get('usr_search_cache') ?? [];
 
         $this->search_result = (array) ($usr_search_cache[$this->search_type]['search_result'] ?? []);
         $this->checked = (array) ($usr_search_cache[$this->search_type]['checked'] ?? []);
         $this->failed = (array) ($usr_search_cache[$this->search_type]['failed'] ?? []);
         $this->page_number = (int) ($usr_search_cache[$this->search_type]['page_number'] ?? 1);
         $this->setQuery((string) ($usr_search_cache[$this->search_type]['query'] ?? ''));
         $this->setRoot((int) ($usr_search_cache[$this->search_type]['root'] ?? ROOT_FOLDER_ID));
         $this->setItemFilter((array) ($usr_search_cache[$this->search_type]['item_filter'] ?? []));
         $this->setMimeFilter((array) ($usr_search_cache[$this->search_type]['mime_filter'] ?? []));
         $this->setCreationFilter((array) ($usr_search_cache[$this->search_type]['creation_filter'] ?? []));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilUserSearchCache::save ( )

Definition at line 331 of file class.ilUserSearchCache.php.

References $query, $res, ILIAS\UI\examples\Symbol\Glyph\Checked\checked(), getCreationFilter(), getItemFilter(), getMimeFilter(), getQuery(), getRoot(), isAnonymous(), and saveForAnonymous().

                           : void
     {
         if ($this->isAnonymous()) {
             $this->saveForAnonymous();
             return;
         }
 
         $query = "DELETE FROM usr_search " .
             "WHERE usr_id = " . $this->db->quote($this->usr_id, 'integer') . " " .
             "AND ( search_type = " . $this->db->quote($this->search_type, 'integer') . ' ' .
             "OR search_type = " . $this->db->quote(self::LAST_QUERY, 'integer') . ')';
         $res = $this->db->manipulate($query);
 
         $this->db->insert('usr_search', array(
             'usr_id' => array('integer', $this->usr_id),
             'search_result' => array('clob',serialize($this->search_result)),
             'checked' => array('clob',serialize($this->checked)),
             'failed' => array('clob',serialize($this->failed)),
             'page' => array('integer', $this->page_number),
             'search_type' => array('integer', $this->search_type),
             'query' => array('clob',serialize($this->getQuery())),
             'root' => array('integer',$this->getRoot()),
             'item_filter' => array('text',serialize($this->getItemFilter())),
             'mime_filter' => array('text',  serialize($this->getMimeFilter())),
             'creation_filter' => array('text', serialize($this->getCreationFilter()))
         ));
 
 
         // Write last query information
         $this->db->insert(
             'usr_search',
             array(
                 'usr_id' => array('integer',$this->usr_id),
                 'search_type' => array('integer',self::LAST_QUERY),
                 'query' => array('text',serialize($this->getQuery()))
             )
         );
     }

Here is the call graph for this function:

◆ saveForAnonymous()

ilUserSearchCache::saveForAnonymous ( )

Definition at line 370 of file class.ilUserSearchCache.php.

References $checked, $failed, $page_number, $search_result, $search_type, ilSession\clear(), getCreationFilter(), getItemFilter(), getMimeFilter(), getQuery(), getRoot(), and ilSession\set().

Referenced by save().

                                       : void
     {
         ilSession::clear('usr_search_cache');
         $session_usr_search = [];
         $session_usr_search[$this->search_type]['search_result'] = $this->search_result;
         $session_usr_search[$this->search_type]['checked'] = $this->checked;
         $session_usr_search[$this->search_type]['failed'] = $this->failed;
         $session_usr_search[$this->search_type]['page'] = $this->page_number;
         $session_usr_search[$this->search_type]['query'] = $this->getQuery();
         $session_usr_search[$this->search_type]['root'] = $this->getRoot();
         $session_usr_search[$this->search_type]['item_filter'] = $this->getItemFilter();
         $session_usr_search[$this->search_type]['mime_filter'] = $this->getMimeFilter();
         $session_usr_search[$this->search_type]['creation_filter'] = $this->getCreationFilter();
         $session_usr_search[self::LAST_QUERY]['query'] = $this->getQuery();
         ilSession::set('usr_search_cache', $session_usr_search);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCreationFilter()

ilUserSearchCache::setCreationFilter ( array $a_filter )

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

Referenced by read(), and readAnonymous().

                                                       : void
     {
         $this->creation_filter = $a_filter;
     }

Here is the caller graph for this function:

◆ setItemFilter()

ilUserSearchCache::setItemFilter ( array $a_filter )

Definition at line 234 of file class.ilUserSearchCache.php.

Referenced by read(), and readAnonymous().

                                                   : void
     {
         $this->item_filter = $a_filter;
     }

Here is the caller graph for this function:

◆ setMimeFilter()

ilUserSearchCache::setMimeFilter ( array $a_filter )

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

Referenced by readAnonymous().

                                                   : void
     {
         $this->mime_filter = $a_filter;
     }

Here is the caller graph for this function:

◆ setQuery()

ilUserSearchCache::setQuery ( string $a_query )

Definition at line 203 of file class.ilUserSearchCache.php.

Referenced by readAnonymous().

                                              : void
     {
         $this->query = $a_query;
     }

Here is the caller graph for this function:

◆ setResultPageNumber()

ilUserSearchCache::setResultPageNumber ( int $a_number )

Set result page number.

public

Definition at line 188 of file class.ilUserSearchCache.php.

Referenced by deleteCachedEntries(), and deleteCachedEntriesAnonymous().

                                                       : void
     {
         if ($a_number) {
             $this->page_number = $a_number;
         }
     }

Here is the caller graph for this function:

◆ setResults()

ilUserSearchCache::setResults ( array $a_results )

Set results.

public

Parameters

array $a_results (int => array(int,int,string)) array(ref_id => array(ref_id,obj_id,type))

Definition at line 126 of file class.ilUserSearchCache.php.

                                                 : void
     {
         $this->search_result = $a_results;
     }

◆ setRoot()

ilUserSearchCache::setRoot ( int $a_root )

set root node of search

Definition at line 224 of file class.ilUserSearchCache.php.

Referenced by read(), and readAnonymous().

                                         : void
     {
         $this->root = $a_root;
     }

Here is the caller graph for this function:

◆ switchSearchType()

ilUserSearchCache::switchSearchType ( int $a_type )

switch to search type reads entries from database

Definition at line 101 of file class.ilUserSearchCache.php.

References read().

                                                  : bool
     {
         $this->search_type = $a_type;
         $this->read();
         return true;
     }