ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
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 SHOP_CONTENT = 2
 
const SHOP_ADVANCED_SEARCH = 3
 
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$

@ilCtrl_Calls

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

Constructor & Destructor Documentation

◆ __construct()

ilUserSearchCache::__construct (   $a_usr_id)
private

Constructor.

@access private

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

83 {
84 global $ilDB;
85
86 if($a_usr_id == ANONYMOUS_USER_ID)
87 {
88 $this->isAnonymous = true;
89 }
90
91 $this->db = $ilDB;
92 $this->usr_id = $a_usr_id;
93 $this->search_type = self::DEFAULT_SEARCH;
94 $this->read();
95 }
isAnonymous()
Check if current user is anonymous user.
read()
Read user entries.
global $ilDB

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

+ Here is the call graph for this function:

Member Function Documentation

◆ _getInstance()

static ilUserSearchCache::_getInstance (   $a_usr_id)
static

◆ addResult()

ilUserSearchCache::addResult (   $a_result_item)

Append result.

@access public

Parameters
array(int,int,string)array(ref_id,obj_id,type)

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

169 {
170 $this->search_result[$a_result_item['ref_id']]['ref_id'] = $a_result_item['ref_id'];
171 $this->search_result[$a_result_item['ref_id']]['obj_id'] = $a_result_item['obj_id'];
172 $this->search_result[$a_result_item['ref_id']]['type'] = $a_result_item['type'];
173 return true;
174 }

◆ appendToChecked()

ilUserSearchCache::appendToChecked (   $a_ref_id,
  $a_obj_id 
)

Append checked id.

@access public

Parameters
intchecked reference id
intchecked obj_id

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

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

◆ appendToFailed()

ilUserSearchCache::appendToFailed (   $a_ref_id)

Append failed id.

@access public

Parameters
intref_id of failed access

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

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

◆ delete()

ilUserSearchCache::delete ( )

Delete user entries.

@access public

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

426 {
427 global $ilDB;
428
429 $query = "DELETE FROM usr_search ".
430 "WHERE usr_id = ".$this->db->quote($this->usr_id ,'integer')." ".
431 "AND search_type = ".$this->db->quote($this->search_type ,'integer');
432 $res = $ilDB->manipulate($query);
433
434 $this->read();
435 return true;
436 }

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

+ Here is the call graph for this function:

◆ deleteCachedEntries()

ilUserSearchCache::deleteCachedEntries ( )

delete cached entries

Parameters

return

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

356 {
357 global $ilDB;
358
359 if($this->isAnonymous())
360 {
361 return $this->deleteCachedEntriesAnonymous();
362 }
363
364
365 $query = "SELECT COUNT(*) num FROM usr_search ".
366 "WHERE usr_id = ".$ilDB->quote($this->usr_id,'integer')." ".
367 "AND search_type = ".$ilDB->quote($this->search_type,'integer');
368 $res = $ilDB->query($query);
369 $row = $res->fetchRow(DB_FETCHMODE_OBJECT);
370
371 if($row->num > 0)
372 {
373 $ilDB->update('usr_search',
374 array(
375 'search_result' => array('clob',serialize(array(0))),
376 'checked' => array('clob',serialize(array(0))),
377 'failed' => array('clob',serialize(array(0))),
378 'page' => array('integer',0)),
379 array(
380 'usr_id' => array('integer',(int) $this->usr_id),
381 'search_type' => array('integer',(int) $this->search_type)
382 ));
383 }
384 else
385 {
386 $ilDB->insert('usr_search',
387 array(
388 'search_result' => array('clob',serialize(array(0))),
389 'checked' => array('clob',serialize(array(0))),
390 'failed' => array('clob',serialize(array(0))),
391 'page' => array('integer',0),
392 'usr_id' => array('integer',(int) $this->usr_id),
393 'search_type' => array('integer',(int) $this->search_type)
394 ));
395 }
396
397 $this->setResultPageNumber(1);
398 $this->search_result = array();
399 $this->checked = array();
400 $this->failed = array();
401 }
const DB_FETCHMODE_OBJECT
Definition: class.ilDB.php:11
deleteCachedEntriesAnonymous()
Delete cached entries for anonymous user.
setResultPageNumber($a_number)
Set result page number.

References $ilDB, $query, $res, $row, DB_FETCHMODE_OBJECT, deleteCachedEntriesAnonymous(), isAnonymous(), and setResultPageNumber().

+ Here is the call graph for this function:

◆ deleteCachedEntriesAnonymous()

ilUserSearchCache::deleteCachedEntriesAnonymous ( )

Delete cached entries for anonymous user.

Returns
bool

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

408 {
409 $this->setResultPageNumber(1);
410 $this->search_result = array();
411 $this->checked = array();
412 $this->failed = array();
413
414 return true;
415 }

References setResultPageNumber().

Referenced by deleteCachedEntries().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getCheckedItems()

ilUserSearchCache::getCheckedItems ( )

Get all checked items.

@access public

Returns
array array(ref_id => obj_id)

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

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

◆ getCreationFilter()

ilUserSearchCache::getCreationFilter ( )

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

References $creation_filter.

Referenced by save(), and saveForAnonymous().

+ Here is the caller graph for this function:

◆ getItemFilter()

ilUserSearchCache::getItemFilter ( )

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

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

References $item_filter.

Referenced by save(), and saveForAnonymous().

+ Here is the caller graph for this function:

◆ getMimeFilter()

ilUserSearchCache::getMimeFilter ( )

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

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

References $mime_filter.

Referenced by save(), and saveForAnonymous().

+ Here is the caller graph for this function:

◆ getQuery()

ilUserSearchCache::getQuery ( )

get query

Returns

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

278 {
279 return $this->query;
280 }

References $query.

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

+ Here is the caller graph for this function:

◆ getResultPageNumber()

ilUserSearchCache::getResultPageNumber ( )

get result page number

@access public

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

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

◆ getResults()

ilUserSearchCache::getResults ( )

Get results.

@access public

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

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

◆ getRoot()

ilUserSearchCache::getRoot ( )

get root node

Returns

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

313 {
314 return $this->root ? $this->root : ROOT_FOLDER_ID;
315 }

Referenced by save(), and saveForAnonymous().

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

287 {
288 if(is_array($this->getQuery()))
289 {
290 $query = $this->getQuery();
291
292 return urlencode(str_replace('"', '.', $query['lom_content']));
293 }
294 return urlencode(str_replace('"', '.', $this->getQuery()));
295 }

References $query, and getQuery().

+ Here is the call graph for this function:

◆ isAnonymous()

ilUserSearchCache::isAnonymous ( )

Check if current user is anonymous user.

Returns
bool

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

References $isAnonymous.

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

+ Here is the caller graph for this function:

◆ isChecked()

ilUserSearchCache::isChecked (   $a_ref_id)

Check if reference was already checked.

@access public

Parameters
intref_id

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

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

◆ isFailed()

ilUserSearchCache::isFailed (   $a_ref_id)

check if reference has failed access

@access public

Parameters
intref_id

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

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

◆ read()

ilUserSearchCache::read ( )
private

Read user entries.

@access private

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

512 {
513 $this->failed = array();
514 $this->checked = array();
515 $this->search_result = array();
516 $this->page_number = 0;
517
518 if($this->isAnonymous())
519 {
520 return $this->readAnonymous();
521 }
522
523 $query = "SELECT * FROM usr_search ".
524 "WHERE usr_id = ".$this->db->quote($this->usr_id ,'integer')." ".
525 "AND search_type = ".$this->db->quote($this->search_type ,'integer');
526
527 $res = $this->db->query($query);
528 while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
529 {
530 $this->search_result = unserialize(stripslashes($row->search_result));
531 if(strlen($row->checked))
532 {
533 $this->checked = unserialize(stripslashes($row->checked));
534 }
535 if(strlen($row->failed))
536 {
537 $this->failed = unserialize(stripslashes($row->failed));
538 }
539 $this->page_number = $row->page;
540 $this->setQuery(unserialize($row->query));
541 $this->setRoot($row->root);
542 $this->setItemFilter(unserialize($row->item_filter));
543 $this->setCreationFilter(unserialize($row->creation_filter));
544 }
545 return true;
546 }
readAnonymous()
Read from session for anonymous user.
setRoot($a_root)
set root node of search
setQuery($a_query)
set query

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

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

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

552 {
553 $this->search_result = (array) $_SESSION['usr_search_cache'][$this->search_type]['search_result'];
554 $this->checked = (array) $_SESSION['usr_search_cache'][$this->search_type]['checked'];
555 $this->failed = (array) $_SESSION['usr_search_cache'][$this->search_type]['failed'];
556 $this->page_number = $_SESSION['usr_search_cache'][$this->search_type]['page_number'];
557
558 $this->setQuery($_SESSION['usr_search_cache'][$this->search_type]['query']);
559 $this->setRoot((string) $_SESSION['usr_search_cache'][$this->search_type]['root']);
560 $this->setItemFilter((array) $_SESSION['usr_search_cache'][$this->search_type]['item_filter']);
561 $this->setMimeFilter((array) $_SESSION['usr_search_cache'][$this->search_type]['mime_filter']);
562 $this->setCreationFilter((array) $_SESSION['usr_search_cache'][$this->search_type]['creation_filter']);
563
564 return true;
565 }
$_SESSION["AccountId"]

References $_SESSION, $search_type, 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:

◆ save()

ilUserSearchCache::save ( )

Save entries.

@access public

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

445 {
446 global $ilDB;
447
448 if($this->isAnonymous())
449 {
450 return $this->saveForAnonymous();
451 }
452
453 $query = "DELETE FROM usr_search ".
454 "WHERE usr_id = ".$ilDB->quote($this->usr_id ,'integer')." ".
455 "AND ( search_type = ".$ilDB->quote($this->search_type ,'integer').' '.
456 "OR search_type = ".$ilDB->quote(self::LAST_QUERY,'integer'). ')';
457 $res = $ilDB->manipulate($query);
458
459 $ilDB->insert('usr_search',array(
460 'usr_id' => array('integer',(int) $this->usr_id),
461 'search_result' => array('clob',serialize($this->search_result)),
462 'checked' => array('clob',serialize($this->checked)),
463 'failed' => array('clob',serialize($this->failed)),
464 'page' => array('integer',(int) $this->page_number),
465 'search_type' => array('integer',(int) $this->search_type),
466 'query' => array('clob',serialize($this->getQuery())),
467 'root' => array('integer',$this->getRoot()),
468 'item_filter' => array('text',serialize($this->getItemFilter())),
469 'mime_filter' => array('text', serialize($this->getMimeFilter())),
470 'creation_filter' => array('text', serialize($this->getCreationFilter()))
471 ));
472
473
474 // Write last query information
475 $ilDB->insert('usr_search',
476 array(
477 'usr_id' => array('integer',$this->usr_id),
478 'search_type' => array('integer',self::LAST_QUERY),
479 'query' => array('text',serialize($this->getQuery()))
480 )
481 );
482 }

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

+ Here is the call graph for this function:

◆ saveForAnonymous()

ilUserSearchCache::saveForAnonymous ( )

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

485 {
486 unset($_SESSION['usr_search_cache']);
487
488 $_SESSION['usr_search_cache'][$this->search_type]['search_result'] = $this->search_result;
489 $_SESSION['usr_search_cache'][$this->search_type]['checked'] = $this->checked;
490 $_SESSION['usr_search_cache'][$this->search_type]['failed'] = $this->failed;
491 $_SESSION['usr_search_cache'][$this->search_type]['page'] = $this->page_number;
492 $_SESSION['usr_search_cache'][$this->search_type]['query'] = $this->getQuery();
493 $_SESSION['usr_search_cache'][$this->search_type]['root'] = $this->getRoot();
494 $_SESSION['usr_search_cache'][$this->search_type]['item_filter'] = $this->getItemFilter();
495 $_SESSION['usr_search_cache'][$this->search_type]['mime_filter'] = $this->getMimeFilter();
496 $_SESSION['usr_search_cache'][$this->search_type]['creation_filter'] = $this->getCreationFilter();
497
498 $_SESSION['usr_search_cache'][self::LAST_QUERY]['query'] = $this->getQuery();
499
500 return true;
501
502 }

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

Referenced by save().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setCreationFilter()

ilUserSearchCache::setCreationFilter (   $a_filter)

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

339 {
340 $this->creation_filter = $a_filter;
341 }

Referenced by read(), and readAnonymous().

+ Here is the caller graph for this function:

◆ setItemFilter()

ilUserSearchCache::setItemFilter (   $a_filter)

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

318 {
319 $this->item_filter = $a_filter;
320 }

Referenced by read(), and readAnonymous().

+ Here is the caller graph for this function:

◆ setMimeFilter()

ilUserSearchCache::setMimeFilter (   $a_filter)

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

328 {
329 $this->mime_filter = $a_filter;
330 }

Referenced by readAnonymous().

+ Here is the caller graph for this function:

◆ setQuery()

ilUserSearchCache::setQuery (   $a_query)

set query

Parameters
mixedquery string or array (for advanced search)
Returns

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

268 {
269 $this->query = $a_query;
270 }

Referenced by read(), and readAnonymous().

+ Here is the caller graph for this function:

◆ setResultPageNumber()

ilUserSearchCache::setResultPageNumber (   $a_number)

Set result page number.

@access public

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

244 {
245 if($a_number)
246 {
247 $this->page_number = $a_number;
248 }
249 }

Referenced by deleteCachedEntries(), and deleteCachedEntriesAnonymous().

+ Here is the caller graph for this function:

◆ setResults()

ilUserSearchCache::setResults (   $a_results)

Set results.

@access public

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

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

157 {
158 $this->search_result = $a_results;
159 }

◆ setRoot()

ilUserSearchCache::setRoot (   $a_root)

set root node of search

Parameters
introot id
Returns

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

303 {
304 $this->root = $a_root;
305 }

Referenced by read(), and readAnonymous().

+ Here is the caller graph for this function:

◆ switchSearchType()

ilUserSearchCache::switchSearchType (   $a_type)

switch to search type reads entries from database

@access public

Parameters
intsearch type

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

132 {
133 $this->search_type = $a_type;
134 $this->read();
135 return true;
136 }

References read().

+ Here is the call graph for this function:

Field Documentation

◆ $checked

ilUserSearchCache::$checked = array()
private

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

Referenced by saveForAnonymous().

◆ $creation_filter

ilUserSearchCache::$creation_filter = array()
private

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

Referenced by getCreationFilter().

◆ $db

ilUserSearchCache::$db
private

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

◆ $failed

ilUserSearchCache::$failed = array()
private

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

Referenced by saveForAnonymous().

◆ $instance

ilUserSearchCache::$instance = null
staticprivate

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

Referenced by _getInstance().

◆ $isAnonymous

ilUserSearchCache::$isAnonymous = false
private

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

Referenced by isAnonymous().

◆ $item_filter

ilUserSearchCache::$item_filter = array()
private

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

Referenced by getItemFilter().

◆ $mime_filter

ilUserSearchCache::$mime_filter = array()
private

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

Referenced by getMimeFilter().

◆ $page_number

ilUserSearchCache::$page_number = 1
private

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

Referenced by saveForAnonymous().

◆ $query

ilUserSearchCache::$query
private

◆ $root

ilUserSearchCache::$root = ROOT_FOLDER_ID
private

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

◆ $search_result

ilUserSearchCache::$search_result = array()
private

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

Referenced by saveForAnonymous().

◆ $search_type

ilUserSearchCache::$search_type = self::DEFAULT_SEARCH
private

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

Referenced by readAnonymous(), and saveForAnonymous().

◆ $usr_id

ilUserSearchCache::$usr_id
private

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

◆ ADVANCED_MD_SEARCH

const ilUserSearchCache::ADVANCED_MD_SEARCH = 4

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

Referenced by ilAdvancedSearchGUI\initSearchType().

◆ ADVANCED_SEARCH

const ilUserSearchCache::ADVANCED_SEARCH = 1

◆ DEFAULT_SEARCH

const ilUserSearchCache::DEFAULT_SEARCH = 0

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

Referenced by __construct(), and ilSearchGUI\initUserSearchCache().

◆ LAST_QUERY

const ilUserSearchCache::LAST_QUERY = 7

◆ LUCENE_ADVANCED

const ilUserSearchCache::LUCENE_ADVANCED = 6

◆ LUCENE_DEFAULT

const ilUserSearchCache::LUCENE_DEFAULT = 5

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

Referenced by ilLuceneSearchGUI\initUserSearchCache().

◆ LUCENE_USER_SEARCH

const ilUserSearchCache::LUCENE_USER_SEARCH = 8

◆ SHOP_ADVANCED_SEARCH

const ilUserSearchCache::SHOP_ADVANCED_SEARCH = 3

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

◆ SHOP_CONTENT

const ilUserSearchCache::SHOP_CONTENT = 2

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


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