ilUserSearchCache Class Reference

Class for storing search result. More...

Collaboration diagram for ilUserSearchCache:

Public Member Functions
	isAnonymous ()
	Check if current user is anonymous user. More...
	switchSearchType ($a_type)
	switch to search type reads entries from database More...
	getResults ()
	Get results. More...
	setResults ($a_results)
	Set results. More...
	addResult ($a_result_item)
	Append result. More...
	appendToFailed ($a_ref_id)
	Append failed id. More...
	isFailed ($a_ref_id)
	check if reference has failed access More...
	appendToChecked ($a_ref_id, $a_obj_id)
	Append checked id. More...
	isChecked ($a_ref_id)
	Check if reference was already checked. More...
	getCheckedItems ()
	Get all checked items. More...
	setResultPageNumber ($a_number)
	Set result page number. More...
	getResultPageNumber ()
	get result page number More...
	setQuery ($a_query)
	set query More...
	getQuery ()
	get query More...
	getUrlEncodedQuery ()
	Urlencode query for further use in e.g glossariers (highlighting off search terms). More...
	setRoot ($a_root)
	set root node of search More...
	getRoot ()
	get root node More...
	setItemFilter ($a_filter)
	getItemFilter ()
	setMimeFilter ($a_filter)
	getMimeFilter ()
	setCreationFilter ($a_filter)
	getCreationFilter ()
	deleteCachedEntries ()
	delete cached entries More...
	deleteCachedEntriesAnonymous ()
	Delete cached entries for anonymous user. More...
	delete ()
	Delete user entries. More...
	save ()
	Save entries. More...
	saveForAnonymous ()

Static Public Member Functions
static	_getInstance ($a_usr_id)
	Get singleton instance. More...

Data Fields
const	DEFAULT_SEARCH = 0
const	ADVANCED_SEARCH = 1
const	ADVANCED_MD_SEARCH = 4
const	LUCENE_DEFAULT = 5
const	LUCENE_ADVANCED = 6
const	LAST_QUERY = 7
const	LUCENE_USER_SEARCH = 8

Private Member Functions
	__construct ($a_usr_id)
	Constructor. More...
	read ()
	Read user entries. More...
	readAnonymous ()
	Read from session for anonymous user. More...

Private Attributes
	$db
	$usr_id
	$search_type = self::DEFAULT_SEARCH
	$search_result = array()
	$checked = array()
	$failed = array()
	$page_number = 1
	$query
	$root = ROOT_FOLDER_ID
	$item_filter = array()
	$isAnonymous = false
	$mime_filter = array()
	$creation_filter = array()

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilUserSearchCache::__construct (   $a_usr_id )

private

Constructor.

private

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

References $DIC, $ilDB, DEFAULT_SEARCH, isAnonymous(), and read().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        if ($a_usr_id == ANONYMOUS_USER_ID) {
            $this->isAnonymous = true;
        }
        
        $this->db = $ilDB;
        $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 (   $a_usr_id )

static

Get singleton instance.

public

Parameters

int

usr_id

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

Referenced by ilLuceneSearchResultFilter\__construct(), ilObjGlossarySubItemListGUI\getHTML(), ilLMPresentationGUI\ilPage(), ilLuceneUserSearchGUI\initUserSearchCache(), ilLuceneAdvancedSearchGUI\initUserSearchCache(), ilLuceneSearchGUI\initUserSearchCache(), ilSearchResult\initUserSearchCache(), ilSearchGUI\initUserSearchCache(), ilAdvancedSearchGUI\initUserSearchCache(), ilGlossaryPresentationGUI\listDefinitions(), and ilWikiPageGUI\preview().

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

Here is the caller graph for this function:

addResult()

ilUserSearchCache::addResult

(

$a_result_item

)

Append result.

public

Parameters

array(int,int,string)

array(ref_id,obj_id,type)

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

    {
        $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	(		$a_ref_id,
			$a_obj_id
	)

Append checked id.

public

Parameters

int	checked reference id
int	checked obj_id

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

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

appendToFailed()

ilUserSearchCache::appendToFailed

(

$a_ref_id

)

Append failed id.

public

Parameters

int	ref_id of failed access

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

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

delete()

ilUserSearchCache::delete

(

)

Delete user entries.

public

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $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 = $ilDB->manipulate($query);
        
        $this->read();
        return true;
    }

Here is the call graph for this function:

deleteCachedEntries()

ilUserSearchCache::deleteCachedEntries

(

)

delete cached entries

Parameters

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

References $DIC, $ilDB, $query, $res, $row, deleteCachedEntriesAnonymous(), ilDBConstants\FETCHMODE_OBJECT, isAnonymous(), and setResultPageNumber().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        if ($this->isAnonymous()) {
            return $this->deleteCachedEntriesAnonymous();
        }

        
        $query = "SELECT COUNT(*) num FROM usr_search " .
            "WHERE usr_id = " . $ilDB->quote($this->usr_id, 'integer') . " " .
            "AND search_type = " . $ilDB->quote($this->search_type, 'integer');
        $res = $ilDB->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
        
        if ($row->num > 0) {
            $ilDB->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',(int) $this->usr_id),
                    'search_type' => array('integer',(int) $this->search_type)
            )
            );
        } else {
            $ilDB->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',(int) $this->usr_id),
                    'search_type' => array('integer',(int) $this->search_type)
            )
            );
        }
        
        $this->setResultPageNumber(1);
        $this->search_result = array();
        $this->checked = array();
        $this->failed = array();
    }

Here is the call graph for this function:

deleteCachedEntriesAnonymous()

ilUserSearchCache::deleteCachedEntriesAnonymous

(

)

Delete cached entries for anonymous user.

Returns

bool

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

References setResultPageNumber().

Referenced by deleteCachedEntries().

    {
        $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 230 of file class.ilUserSearchCache.php.

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

getCreationFilter()

ilUserSearchCache::getCreationFilter

(

)

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

References $creation_filter.

Referenced by save(), and saveForAnonymous().

    {
        return $this->creation_filter;
    }

Here is the caller graph for this function:

getItemFilter()

ilUserSearchCache::getItemFilter

(

)

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

References $item_filter.

Referenced by save(), and saveForAnonymous().

    {
        return (array) $this->item_filter;
    }

Here is the caller graph for this function:

getMimeFilter()

ilUserSearchCache::getMimeFilter

(

)

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

References $mime_filter.

Referenced by save(), and saveForAnonymous().

    {
        return (array) $this->mime_filter;
    }

Here is the caller graph for this function:

getQuery()

ilUserSearchCache::getQuery

(

)

get query

Returns

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

References $query.

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

    {
        return $this->query;
    }

Here is the caller graph for this function:

getResultPageNumber()

ilUserSearchCache::getResultPageNumber

(

)

get result page number

public

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

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

getResults()

ilUserSearchCache::getResults

(

)

Get results.

public

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

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

getRoot()

ilUserSearchCache::getRoot

(

)

get root node

Returns

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

Referenced by save(), and saveForAnonymous().

    {
        return $this->root ? $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).

Returns

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

References $query, and getQuery().

    {
        if (is_array($this->getQuery())) {
            $query = $this->getQuery();
            
            return urlencode(str_replace('"', '.', $query['lom_content']));
        }
        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 116 of file class.ilUserSearchCache.php.

References $isAnonymous.

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

    {
        return $this->isAnonymous;
    }

Here is the caller graph for this function:

isChecked()

ilUserSearchCache::isChecked

(

$a_ref_id

)

Check if reference was already checked.

public

Parameters

int

ref_id

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

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

isFailed()

ilUserSearchCache::isFailed

(

$a_ref_id

)

check if reference has failed access

public

Parameters

int

ref_id

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

    {
        return in_array($a_ref_id, $this->failed) ? true : false;
    }

read()

ilUserSearchCache::read ( )

private

Read user entries.

private

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

References $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, isAnonymous(), readAnonymous(), setCreationFilter(), setItemFilter(), setQuery(), and setRoot().

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

    {
        $this->failed = array();
        $this->checked = array();
        $this->search_result = array();
        $this->page_number = 0;

        if ($this->isAnonymous()) {
            return $this->readAnonymous();
        }

        $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 = unserialize(stripslashes($row->search_result));
            if (strlen($row->checked)) {
                $this->checked = unserialize(stripslashes($row->checked));
            }
            if (strlen($row->failed)) {
                $this->failed = unserialize(stripslashes($row->failed));
            }
            $this->page_number = $row->page;
            $this->setQuery(unserialize($row->query));
            $this->setRoot($row->root);
            $this->setItemFilter(unserialize($row->item_filter));
            $this->setCreationFilter(unserialize($row->creation_filter));
        }
        return true;
    }

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 548 of file class.ilUserSearchCache.php.

References $_SESSION, $search_type, setCreationFilter(), setItemFilter(), setMimeFilter(), setQuery(), and setRoot().

Referenced by read().

    {
        $this->search_result = (array) $_SESSION['usr_search_cache'][$this->search_type]['search_result'];
        $this->checked = (array) $_SESSION['usr_search_cache'][$this->search_type]['checked'];
        $this->failed = (array) $_SESSION['usr_search_cache'][$this->search_type]['failed'];
        $this->page_number = $_SESSION['usr_search_cache'][$this->search_type]['page_number'];

        $this->setQuery($_SESSION['usr_search_cache'][$this->search_type]['query']);
        $this->setRoot((string) $_SESSION['usr_search_cache'][$this->search_type]['root']);
        $this->setItemFilter((array) $_SESSION['usr_search_cache'][$this->search_type]['item_filter']);
        $this->setMimeFilter((array) $_SESSION['usr_search_cache'][$this->search_type]['mime_filter']);
        $this->setCreationFilter((array) $_SESSION['usr_search_cache'][$this->search_type]['creation_filter']);

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilUserSearchCache::save

(

)

Save entries.

public

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

References $DIC, $ilDB, $query, $res, getCreationFilter(), getItemFilter(), getMimeFilter(), getQuery(), getRoot(), isAnonymous(), and saveForAnonymous().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if ($this->isAnonymous()) {
            return $this->saveForAnonymous();
        }
        
        $query = "DELETE FROM usr_search " .
            "WHERE usr_id = " . $ilDB->quote($this->usr_id, 'integer') . " " .
            "AND ( search_type = " . $ilDB->quote($this->search_type, 'integer') . ' ' .
            "OR search_type = " . $ilDB->quote(self::LAST_QUERY, 'integer') . ')';
        $res = $ilDB->manipulate($query);
        
        $ilDB->insert('usr_search', array(
            'usr_id' => array('integer',(int) $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',(int) $this->page_number),
            'search_type' => array('integer',(int) $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
        $ilDB->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 486 of file class.ilUserSearchCache.php.

References $_SESSION, $checked, $failed, $page_number, $search_result, $search_type, getCreationFilter(), getItemFilter(), getMimeFilter(), getQuery(), and getRoot().

Referenced by save().

    {
        unset($_SESSION['usr_search_cache']);

        $_SESSION['usr_search_cache'][$this->search_type]['search_result'] = $this->search_result;
        $_SESSION['usr_search_cache'][$this->search_type]['checked'] = $this->checked;
        $_SESSION['usr_search_cache'][$this->search_type]['failed'] = $this->failed;
        $_SESSION['usr_search_cache'][$this->search_type]['page'] = $this->page_number;
        $_SESSION['usr_search_cache'][$this->search_type]['query'] = $this->getQuery();
        $_SESSION['usr_search_cache'][$this->search_type]['root'] = $this->getRoot();
        $_SESSION['usr_search_cache'][$this->search_type]['item_filter'] = $this->getItemFilter();
        $_SESSION['usr_search_cache'][$this->search_type]['mime_filter'] = $this->getMimeFilter();
        $_SESSION['usr_search_cache'][$this->search_type]['creation_filter'] = $this->getCreationFilter();

        $_SESSION['usr_search_cache'][self::LAST_QUERY]['query'] = $this->getQuery();

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCreationFilter()

ilUserSearchCache::setCreationFilter

(

$a_filter

)

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

Referenced by read(), and readAnonymous().

    {
        $this->creation_filter = $a_filter;
    }

Here is the caller graph for this function:

setItemFilter()

ilUserSearchCache::setItemFilter

(

$a_filter

)

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

Referenced by read(), and readAnonymous().

    {
        $this->item_filter = $a_filter;
    }

Here is the caller graph for this function:

setMimeFilter()

ilUserSearchCache::setMimeFilter

(

$a_filter

)

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

Referenced by readAnonymous().

    {
        $this->mime_filter = $a_filter;
    }

Here is the caller graph for this function:

setQuery()

ilUserSearchCache::setQuery

(

$a_query

)

set query

Parameters

mixed

query string or array (for advanced search)

Returns

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

Referenced by read(), and readAnonymous().

    {
        $this->query = $a_query;
    }

Here is the caller graph for this function:

setResultPageNumber()

ilUserSearchCache::setResultPageNumber

(

$a_number

)

Set result page number.

public

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

Referenced by deleteCachedEntries(), and deleteCachedEntriesAnonymous().

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

Here is the caller graph for this function:

setResults()

ilUserSearchCache::setResults

(

$a_results

)

Set results.

public

Parameters

array(int

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

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

    {
        $this->search_result = $a_results;
    }

setRoot()

ilUserSearchCache::setRoot

(

$a_root

)

set root node of search

Parameters

int

root id

Returns

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

Referenced by read(), and readAnonymous().

    {
        $this->root = $a_root;
    }

Here is the caller graph for this function:

switchSearchType()

ilUserSearchCache::switchSearchType

(

$a_type

)

switch to search type reads entries from database

public

Parameters

int	search type

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

References $a_type, and read().

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

Here is the call graph for this function:

Field Documentation

$checked

ilUserSearchCache::$checked = array()

private

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

Referenced by saveForAnonymous().

$creation_filter

ilUserSearchCache::$creation_filter = array()

private

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

Referenced by getCreationFilter().

$db

ilUserSearchCache::$db

private

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

$failed

ilUserSearchCache::$failed = array()

private

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

Referenced by saveForAnonymous().

$instance

ilUserSearchCache::$instance = null

staticprivate

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

$isAnonymous

ilUserSearchCache::$isAnonymous = false

private

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

Referenced by isAnonymous().

$item_filter

ilUserSearchCache::$item_filter = array()

private

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

Referenced by getItemFilter().

$mime_filter

ilUserSearchCache::$mime_filter = array()

private

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

Referenced by getMimeFilter().

$page_number

ilUserSearchCache::$page_number = 1

private

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

Referenced by saveForAnonymous().

$query

ilUserSearchCache::$query

private

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

Referenced by delete(), deleteCachedEntries(), getQuery(), getUrlEncodedQuery(), read(), and save().

$root

ilUserSearchCache::$root = ROOT_FOLDER_ID

private

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

$search_result

ilUserSearchCache::$search_result = array()

private

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

Referenced by saveForAnonymous().

$search_type

ilUserSearchCache::$search_type = self::DEFAULT_SEARCH

private

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

Referenced by readAnonymous(), and saveForAnonymous().

$usr_id

ilUserSearchCache::$usr_id

private

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

ADVANCED_MD_SEARCH

const ilUserSearchCache::ADVANCED_MD_SEARCH = 4

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

Referenced by ilAdvancedSearchGUI\initSearchType().

ADVANCED_SEARCH

const ilUserSearchCache::ADVANCED_SEARCH = 1

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

Referenced by ilAdvancedSearchGUI\initSearchType(), and ilAdvancedSearchGUI\initUserSearchCache().

DEFAULT_SEARCH

const ilUserSearchCache::DEFAULT_SEARCH = 0

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

Referenced by ilSearchGUI\initUserSearchCache().

LAST_QUERY

const ilUserSearchCache::LAST_QUERY = 7

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

Referenced by ilLMPresentationGUI\ilPage(), ilGlossaryPresentationGUI\listDefinitions(), and ilWikiPageGUI\preview().

LUCENE_ADVANCED

const ilUserSearchCache::LUCENE_ADVANCED = 6

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

Referenced by ilLuceneAdvancedSearchGUI\initUserSearchCache().

LUCENE_DEFAULT

const ilUserSearchCache::LUCENE_DEFAULT = 5

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

Referenced by ilLuceneSearchGUI\initUserSearchCache().

LUCENE_USER_SEARCH

const ilUserSearchCache::LUCENE_USER_SEARCH = 8

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

Referenced by ilLuceneUserSearchGUI\initUserSearchCache().

---

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

• Services/Search/classes/class.ilUserSearchCache.php