|
ILIAS
trunk Revision v12.0_alpha-377-g3641b37b9db
|
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 @access 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 () | |
| setCopyrightFilter (string ... $copyright_identifiers) | |
| getCopyrightFilter () | |
| 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 | $checked = [] |
| array | $failed = [] |
| int | $page_number = 1 |
| $query | |
| int | $root |
| array | $item_filter = [] |
| bool | $isAnonymous = false |
| array | $mime_filter = [] |
| array | $creation_filter = [] |
| array | $copyright_filter = [] |
Static Private Attributes | |
| static ilUserSearchCache | $instance = null |
Class for storing search result.
Allows paging of result sets
Definition at line 26 of file class.ilUserSearchCache.php.
|
private |
Constructor.
@access private
Definition at line 65 of file class.ilUserSearchCache.php.
References $DIC, ANONYMOUS_USER_ID, DEFAULT_SEARCH, isAnonymous(), read(), and ROOT_FOLDER_ID.
Here is the call graph for this function:
|
static |
Definition at line 81 of file class.ilUserSearchCache.php.
References $instance.
Referenced by ilLuceneSearchResultFilter\__construct(), ILIAS\Search\GUI\Direct\SearchStateHandlerImpl\fetchCache(), ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl\fetchCache(), ilLMContentRendererGUI\initSearchHighlighting(), ilSearchResult\initUserSearchCache(), ilLuceneUserSearchGUI\initUserSearchCache(), and ilWikiPageGUI\preview().
Here is the caller graph for this function:| ilUserSearchCache::addResult | ( | array | $a_result_item | ) |
Append result.
@access public
| array | $a_result_item | (int,int,string) array(ref_id,obj_id,type) |
Definition at line 139 of file class.ilUserSearchCache.php.
| ilUserSearchCache::appendToChecked | ( | int | $a_ref_id, |
| int | $a_obj_id | ||
| ) |
Definition at line 163 of file class.ilUserSearchCache.php.
References ILIAS\UI\examples\Symbol\Glyph\Checked\checked().
Here is the call graph for this function:| ilUserSearchCache::appendToFailed | ( | int | $a_ref_id | ) |
Append failed id.
Definition at line 150 of file class.ilUserSearchCache.php.
| ilUserSearchCache::delete | ( | ) |
Definition at line 335 of file class.ilUserSearchCache.php.
References $query, $res, and read().
Here is the call graph for this function:| ilUserSearchCache::deleteCachedEntries | ( | ) |
Definition at line 278 of file class.ilUserSearchCache.php.
References $query, $res, ILIAS\UI\examples\Symbol\Glyph\Checked\checked(), deleteCachedEntriesAnonymous(), ilDBConstants\FETCHMODE_OBJECT, isAnonymous(), and setResultPageNumber().
Here is the call graph for this function:| ilUserSearchCache::deleteCachedEntriesAnonymous | ( | ) |
Definition at line 325 of file class.ilUserSearchCache.php.
References ILIAS\UI\examples\Symbol\Glyph\Checked\checked(), and setResultPageNumber().
Referenced by deleteCachedEntries().
Here is the call graph for this function:
Here is the caller graph for this function:| ilUserSearchCache::getCheckedItems | ( | ) |
Get all checked items @access public.
Definition at line 178 of file class.ilUserSearchCache.php.
References ILIAS\UI\examples\Symbol\Glyph\Checked\checked().
Here is the call graph for this function:| ilUserSearchCache::getCopyrightFilter | ( | ) |
Definition at line 273 of file class.ilUserSearchCache.php.
References $copyright_filter.
Referenced by ILIAS\Search\GUI\Lucene\SearcherImpl\parseCopyrightFilter(), save(), and saveForAnonymous().
Here is the caller graph for this function:| ilUserSearchCache::getCreationFilter | ( | ) |
Definition at line 260 of file class.ilUserSearchCache.php.
References $creation_filter.
Referenced by ILIAS\Search\GUI\Lucene\SearcherImpl\parseCreationFilter(), ILIAS\Search\GUI\Direct\SearcherImpl\parseEndDateFromCreationFilter(), ILIAS\Search\GUI\Direct\SearcherImpl\parseStartDateFromCreationFilter(), save(), and saveForAnonymous().
Here is the caller graph for this function:| ilUserSearchCache::getItemFilter | ( | ) |
Definition at line 240 of file class.ilUserSearchCache.php.
References $item_filter.
Referenced by ILIAS\Search\GUI\Direct\SearcherImpl\parseTypeFilter(), ILIAS\Search\GUI\Lucene\SearcherImpl\performSearchAndRenderResults(), save(), and saveForAnonymous().
Here is the caller graph for this function:| ilUserSearchCache::getMimeFilter | ( | ) |
Definition at line 250 of file class.ilUserSearchCache.php.
References $mime_filter.
Referenced by save(), and saveForAnonymous().
Here is the caller graph for this function:| ilUserSearchCache::getQuery | ( | ) |
Definition at line 209 of file class.ilUserSearchCache.php.
Referenced by getUrlEncodedQuery(), save(), and saveForAnonymous().
Here is the caller graph for this function:| ilUserSearchCache::getResultPageNumber | ( | ) |
get result page number
Definition at line 199 of file class.ilUserSearchCache.php.
| ilUserSearchCache::getResults | ( | ) |
Get results.
@access public
Definition at line 115 of file class.ilUserSearchCache.php.
| ilUserSearchCache::getRoot | ( | ) |
Definition at line 230 of file class.ilUserSearchCache.php.
References ROOT_FOLDER_ID.
Referenced by save(), and saveForAnonymous().
Here is the caller graph for this function:| ilUserSearchCache::getUrlEncodedQuery | ( | ) |
Urlencode query for further use in e.g glossariers (highlighting off search terms).
Definition at line 217 of file class.ilUserSearchCache.php.
References getQuery().
Here is the call graph for this function:| ilUserSearchCache::isAnonymous | ( | ) |
Check if current user is anonymous user.
Definition at line 93 of file class.ilUserSearchCache.php.
References $isAnonymous.
Referenced by __construct(), deleteCachedEntries(), read(), and save().
Here is the caller graph for this function:| ilUserSearchCache::isChecked | ( | int | $a_ref_id | ) |
Definition at line 168 of file class.ilUserSearchCache.php.
References ILIAS\UI\examples\Symbol\Glyph\Checked\checked().
Here is the call graph for this function:| ilUserSearchCache::isFailed | ( | int | $a_ref_id | ) |
check if reference has failed access
Definition at line 158 of file class.ilUserSearchCache.php.
|
private |
Definition at line 404 of file class.ilUserSearchCache.php.
References $query, $res, ILIAS\UI\examples\Symbol\Glyph\Checked\checked(), ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), isAnonymous(), readAnonymous(), setCopyrightFilter(), setCreationFilter(), setItemFilter(), and setRoot().
Referenced by __construct(), delete(), and switchSearchType().
Here is the call graph for this function:
Here is the caller graph for this function:
|
private |
Read from session for anonymous user.
Definition at line 443 of file class.ilUserSearchCache.php.
References ILIAS\UI\examples\Symbol\Glyph\Checked\checked(), ilSession\get(), ILIAS\Repository\int(), ROOT_FOLDER_ID, setCopyrightFilter(), setCreationFilter(), setItemFilter(), setMimeFilter(), setQuery(), and setRoot().
Referenced by read().
Here is the call graph for this function:
Here is the caller graph for this function:| ilUserSearchCache::save | ( | ) |
Definition at line 346 of file class.ilUserSearchCache.php.
References $query, $res, ILIAS\UI\examples\Symbol\Glyph\Checked\checked(), getCopyrightFilter(), getCreationFilter(), getItemFilter(), getMimeFilter(), getQuery(), getRoot(), isAnonymous(), and saveForAnonymous().
Here is the call graph for this function:| ilUserSearchCache::saveForAnonymous | ( | ) |
Definition at line 386 of file class.ilUserSearchCache.php.
References $checked, $failed, $page_number, $search_result, $search_type, ilSession\clear(), getCopyrightFilter(), getCreationFilter(), getItemFilter(), getMimeFilter(), getQuery(), getRoot(), LAST_QUERY, and ilSession\set().
Referenced by save().
Here is the call graph for this function:
Here is the caller graph for this function:| ilUserSearchCache::setCopyrightFilter | ( | string ... | $copyright_identifiers | ) |
Definition at line 265 of file class.ilUserSearchCache.php.
Referenced by ILIAS\Search\GUI\Direct\SearchStateHandlerImpl\loadFilterToCache(), ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl\loadFilterToCache(), read(), and readAnonymous().
Here is the caller graph for this function:| ilUserSearchCache::setCreationFilter | ( | array | $a_filter | ) |
Definition at line 255 of file class.ilUserSearchCache.php.
Referenced by ILIAS\Search\GUI\Direct\SearchStateHandlerImpl\loadFilterToCache(), ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl\loadFilterToCache(), read(), and readAnonymous().
Here is the caller graph for this function:| ilUserSearchCache::setItemFilter | ( | array | $a_filter | ) |
Definition at line 235 of file class.ilUserSearchCache.php.
Referenced by ILIAS\Search\GUI\Direct\SearchStateHandlerImpl\loadFilterToCache(), ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl\loadFilterToCache(), read(), and readAnonymous().
Here is the caller graph for this function:| ilUserSearchCache::setMimeFilter | ( | array | $a_filter | ) |
Definition at line 245 of file class.ilUserSearchCache.php.
Referenced by ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl\loadFilterToCache(), and readAnonymous().
Here is the caller graph for this function:| ilUserSearchCache::setQuery | ( | string | $a_query | ) |
Definition at line 204 of file class.ilUserSearchCache.php.
Referenced by readAnonymous().
Here is the caller graph for this function:| ilUserSearchCache::setResultPageNumber | ( | int | $a_number | ) |
Set result page number.
@access public
Definition at line 189 of file class.ilUserSearchCache.php.
Referenced by deleteCachedEntries(), and deleteCachedEntriesAnonymous().
Here is the caller graph for this function:| ilUserSearchCache::setResults | ( | array | $a_results | ) |
Set results.
@access public
| array | $a_results | (int => array(int,int,string)) array(ref_id => array(ref_id,obj_id,type)) |
Definition at line 127 of file class.ilUserSearchCache.php.
| ilUserSearchCache::setRoot | ( | int | $a_root | ) |
set root node of search
Definition at line 225 of file class.ilUserSearchCache.php.
Referenced by ILIAS\Search\GUI\Direct\SearchStateHandlerImpl\loadFilterToCache(), ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl\loadFilterToCache(), read(), and readAnonymous().
Here is the caller graph for this function:| ilUserSearchCache::switchSearchType | ( | int | $a_type | ) |
switch to search type reads entries from database
Definition at line 102 of file class.ilUserSearchCache.php.
References read().
Here is the call graph for this function:
|
private |
Definition at line 42 of file class.ilUserSearchCache.php.
Referenced by saveForAnonymous().
|
private |
Definition at line 55 of file class.ilUserSearchCache.php.
Referenced by getCopyrightFilter().
|
private |
Definition at line 54 of file class.ilUserSearchCache.php.
Referenced by getCreationFilter().
|
protected |
Definition at line 36 of file class.ilUserSearchCache.php.
|
private |
Definition at line 43 of file class.ilUserSearchCache.php.
Referenced by saveForAnonymous().
|
staticprivate |
Definition at line 35 of file class.ilUserSearchCache.php.
Referenced by _getInstance().
|
private |
Definition at line 52 of file class.ilUserSearchCache.php.
Referenced by isAnonymous().
|
private |
Definition at line 51 of file class.ilUserSearchCache.php.
Referenced by getItemFilter().
|
private |
Definition at line 53 of file class.ilUserSearchCache.php.
Referenced by getMimeFilter().
|
private |
Definition at line 44 of file class.ilUserSearchCache.php.
Referenced by saveForAnonymous().
|
private |
Definition at line 49 of file class.ilUserSearchCache.php.
Referenced by delete(), deleteCachedEntries(), read(), and save().
|
private |
Definition at line 50 of file class.ilUserSearchCache.php.
|
private |
Definition at line 41 of file class.ilUserSearchCache.php.
Referenced by saveForAnonymous().
|
private |
Definition at line 39 of file class.ilUserSearchCache.php.
Referenced by saveForAnonymous().
|
private |
Definition at line 38 of file class.ilUserSearchCache.php.
| const int ilUserSearchCache::DEFAULT_SEARCH = 0 |
Definition at line 28 of file class.ilUserSearchCache.php.
Referenced by __construct().
| const int ilUserSearchCache::LAST_QUERY = 7 |
Definition at line 31 of file class.ilUserSearchCache.php.
Referenced by ilLMContentRendererGUI\initSearchHighlighting(), ilWikiPageGUI\preview(), and saveForAnonymous().
| const int ilUserSearchCache::LUCENE_DEFAULT = 5 |
Definition at line 29 of file class.ilUserSearchCache.php.
Referenced by ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl\fetchCache().
| const int ilUserSearchCache::LUCENE_USER_SEARCH = 8 |
Definition at line 33 of file class.ilUserSearchCache.php.
Referenced by ilLuceneUserSearchGUI\initUserSearchCache().