ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilLuceneUserSearchGUI Class Reference

@classDescription GUI for Lucene user search More...

+ Inheritance diagram for ilLuceneUserSearchGUI:
+ Collaboration diagram for ilLuceneUserSearchGUI:

Public Member Functions

 __construct ()
 Constructor. More...
 
 executeCommand ()
 Execute Command. More...
 
 prepareOutput ()
 Add admin panel command. More...
 
- Public Member Functions inherited from ilSearchBaseGUI
 __construct ()
 Constructor @access public. More...
 
 prepareOutput ()
 
 initStandardSearchForm ($a_mode)
 Init standard search form. More...
 
 getSearchAreaForm ()
 Init standard search form. More...
 
 handleCommand ($a_cmd)
 Handle command. More...
 
 addToDeskObject ()
 Interface methods. More...
 
 removeFromDeskObject ()
 Remove from dektop. More...
 
 delete ()
 Show deletion screen. More...
 
 cancelDelete ()
 Cancel delete. More...
 
 cancelMoveLinkObject ()
 Cancel move/link. More...
 
 performDelete ()
 Delete objects. More...
 
 cut ()
 Interface ilAdministrationCommandHandler. More...
 
 link ()
 Interface ilAdministrationCommandHandler. More...
 
 paste ()
 Paste. More...
 
 showLinkIntoMultipleObjectsTree ()
 Target selection link. More...
 
 showMoveIntoObjectTree ()
 Target selection cut. More...
 
 performPasteIntoMultipleObjects ()
 Perform paste into multiple objects. More...
 
 clear ()
 clear clipboard More...
 
 enableAdministrationPanel ()
 Enable administration panel. More...
 
 disableAdministrationPanel ()
 Disable administration panel. More...
 
 keepObjectsInClipboardObject ()
 cancel action but keep objects in clipboard
Returns
void
More...
 
 addLocator ()
 Add Locator. More...
 
 autoComplete ()
 Data resource for autoComplete. More...
 
 addToDeskObject ()
 Add desktop item @access public. More...
 
 removeFromDeskObject ()
 Remove from desktop @access public. More...
 
 delete ()
 Show delete confirmation. More...
 
 cancelDelete ()
 Cancel delete. More...
 
 performDelete ()
 Perform Delete. More...
 
 cut ()
 Cut object. More...
 
 showLinkIntoMultipleObjectsTree ()
 Target selection link. More...
 
 showMoveIntoObjectTree ()
 Target selection cut. More...
 
 performPasteIntoMultipleObjects ()
 Perform paste into multiple objects. More...
 
 paste ()
 Paste. More...
 
 clear ()
 clear clipboard More...
 
 enableAdministrationPanel ()
 Enable administration panel. More...
 
 disableAdministrationPanel ()
 Disable administration panel. More...
 
 cancelMoveLinkObject ()
 Cancel move/link. More...
 
 keepObjectsInClipboardObject ()
 cancel action but keep objects in clipboard More...
 

Protected Member Functions

 getType ()
 Get type of search (details | fast) More...
 
 getDetails ()
 Needed for base class search form. More...
 
 remoteSearch ()
 Search from main menu. More...
 
 showSavedResults ()
 Show saved results. More...
 
 search ()
 Search (button pressed) More...
 
 performSearch ()
 Perform search. More...
 
 getTabs ()
 get tabs More...
 
 initUserSearchCache ()
 Init user search cache. More...
 
 showSearchForm ()
 Show search form. More...
 
- Protected Member Functions inherited from ilSearchBaseGUI
 addPager ($result, $a_session_key)
 Add Pager. More...
 
 buildSearchAreaPath ($a_root_node)
 Build path for search area. More...
 
 getCreationDateForm ()
 
 getSearchCache ()
 Get user search cache. More...
 
 loadCreationFilter ()
 Load creation date filter. More...
 

Protected Attributes

 $ilTabs
 
- Protected Attributes inherited from ilSearchBaseGUI
 $settings = null
 
 $ctrl = null
 

Additional Inherited Members

- Data Fields inherited from ilSearchBaseGUI
const SEARCH_FAST = 1
 
const SEARCH_DETAILS = 2
 
const SEARCH_AND = 'and'
 
const SEARCH_OR = 'or'
 
const SEARCH_FORM_LUCENE = 1
 
const SEARCH_FORM_STANDARD = 2
 
const SEARCH_FORM_USER = 3
 
 $ilias = null
 
 $lng = null
 
 $tpl = null
 

Detailed Description

@classDescription GUI for Lucene user search

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

@ilCtrl_Calls ilLuceneUserSearchGUI: ilPublicUserProfileGUI @ilCtrl_IsCalledBy ilLuceneUserSearchGUI: ilSearchController

Definition at line 20 of file class.ilLuceneUserSearchGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilLuceneUserSearchGUI::__construct ( )

Constructor.

Reimplemented from ilSearchBaseGUI.

Definition at line 27 of file class.ilLuceneUserSearchGUI.php.

28 {
29 global $ilTabs;
30
31 $this->tabs_gui = $ilTabs;
32 parent::__construct();
33 $this->initUserSearchCache();
34 }
initUserSearchCache()
Init user search cache.

References $ilTabs, and initUserSearchCache().

+ Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilLuceneUserSearchGUI::executeCommand ( )

Execute Command.

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

40 {
41 global $ilBench, $ilCtrl;
42
43 $next_class = $this->ctrl->getNextClass($this);
44 $cmd = $this->ctrl->getCmd();
45
46 $this->prepareOutput();
47 switch ($next_class) {
48 case "ilpublicuserprofilegui":
49 include_once('./Services/User/classes/class.ilPublicUserProfileGUI.php');
50 $profile = new ilPublicUserProfileGUI((int) $_REQUEST['user']);
51 $profile->setBackUrl($this->ctrl->getLinkTarget($this, 'showSavedResults'));
52 $ret = $ilCtrl->forwardCommand($profile);
53 $GLOBALS['tpl']->setContent($ret);
54 break;
55
56
57 default:
59 if (!$cmd) {
60 $cmd = "showSavedResults";
61 }
62 $this->handleCommand($cmd);
63 break;
64 }
65 return true;
66 }
prepareOutput()
Add admin panel command.
GUI class for public user profile presentation.
initStandardSearchForm($a_mode)
Init standard search form.
handleCommand($a_cmd)
Handle command.
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
global $ilBench
Definition: ilias.php:18
global $ilCtrl
Definition: ilias.php:18
$ret
Definition: parser.php:6

References $GLOBALS, $ilBench, $ilCtrl, $ret, ilSearchBaseGUI\handleCommand(), ilSearchBaseGUI\initStandardSearchForm(), prepareOutput(), and ilSearchBaseGUI\SEARCH_FORM_USER.

+ Here is the call graph for this function:

◆ getDetails()

ilLuceneUserSearchGUI::getDetails ( )
protected

Needed for base class search form.

Todo:
rename
Returns
type

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

100 {
101 return (array) $this->search_cache->getItemFilter();
102 }

◆ getTabs()

ilLuceneUserSearchGUI::getTabs ( )
protected

get tabs

Definition at line 191 of file class.ilLuceneUserSearchGUI.php.

192 {
193 global $ilHelp;
194
195 $ilHelp->setScreenIdComponent("src_luc");
196
197 $this->tabs_gui->addTarget('search', $this->ctrl->getLinkTargetByClass('illucenesearchgui'));
198
199 if (ilSearchSettings::getInstance()->isLuceneUserSearchEnabled()) {
200 $this->tabs_gui->addTarget('search_user', $this->ctrl->getLinkTargetByClass('illuceneusersearchgui'));
201 }
202
204
205 if (
206 !ilSearchSettings::getInstance()->getHideAdvancedSearch() and
207 $fields->getActiveFields()) {
208 $this->tabs_gui->addTarget('search_advanced', $this->ctrl->getLinkTargetByClass('illuceneadvancedsearchgui'));
209 }
210
211 $this->tabs_gui->setTabActive('search_user');
212 }
static getInstance()
Get singleton instance.

References ilSearchSettings\getInstance(), and ilLuceneAdvancedSearchFields\getInstance().

Referenced by prepareOutput().

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

◆ getType()

ilLuceneUserSearchGUI::getType ( )
protected

Get type of search (details | fast)

Todo:
rename Needed for base class search form

Definition at line 86 of file class.ilLuceneUserSearchGUI.php.

87 {
88 if (count($this->search_cache)) {
90 }
92 }

References ilSearchBaseGUI\SEARCH_DETAILS, and ilSearchBaseGUI\SEARCH_FAST.

◆ initUserSearchCache()

ilLuceneUserSearchGUI::initUserSearchCache ( )
protected

Init user search cache.

@access private

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

221 {
222 global $ilUser;
223
224 include_once('Services/Search/classes/class.ilUserSearchCache.php');
225 $this->search_cache = ilUserSearchCache::_getInstance($ilUser->getId());
226 $this->search_cache->switchSearchType(ilUserSearchCache::LUCENE_USER_SEARCH);
227 if ((int) $_GET['page_number']) {
228 $this->search_cache->setResultPageNumber((int) $_GET['page_number']);
229 }
230 if (isset($_POST['term'])) {
231 $this->search_cache->setQuery(ilUtil::stripSlashes($_POST['term']));
232 $this->search_cache->setItemFilter(array());
233 $this->search_cache->setMimeFilter(array());
234 $this->search_cache->save();
235 }
236 }
$_GET["client_id"]
$_POST["username"]
static _getInstance($a_usr_id)
Get singleton instance.
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled
$ilUser
Definition: imgupload.php:18

References $_GET, $_POST, $ilUser, ilUserSearchCache\_getInstance(), ilUserSearchCache\LUCENE_USER_SEARCH, and ilUtil\stripSlashes().

Referenced by __construct().

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

◆ performSearch()

ilLuceneUserSearchGUI::performSearch ( )
protected

Perform search.

Definition at line 161 of file class.ilLuceneUserSearchGUI.php.

162 {
163 include_once './Services/Search/classes/Lucene/class.ilLuceneSearcher.php';
164 include_once './Services/Search/classes/Lucene/class.ilLuceneQueryParser.php';
165 $qp = new ilLuceneQueryParser($this->search_cache->getQuery());
166 $qp->parse();
167 $searcher = ilLuceneSearcher::getInstance($qp);
168 $searcher->setType(ilLuceneSearcher::TYPE_USER);
169 $searcher->search();
170
171 $this->showSearchForm();
172
173 include_once './Services/Search/classes/class.ilRepositoryUserResultTableGUI.php';
174 $user_table = new ilRepositoryUserResultTableGUI(
175 $this,
176 'performSearch',
177 false,
179 );
180 $user_table->setLuceneResult($searcher->getResult());
181 $user_table->parseUserIds($searcher->getResult()->getCandidates());
182
183 $GLOBALS['tpl']->setVariable('SEARCH_RESULTS', $user_table->getHTML());
184
185 return true;
186 }
static getInstance(ilLuceneQueryParser $qp)
Get singleton instance.

References $GLOBALS, ilLuceneSearcher\getInstance(), showSearchForm(), ilRepositoryUserResultTableGUI\TYPE_GLOBAL_SEARCH, and ilLuceneSearcher\TYPE_USER.

Referenced by search(), and showSavedResults().

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

◆ prepareOutput()

ilLuceneUserSearchGUI::prepareOutput ( )

Add admin panel command.

Todo:

Reimplemented from ilSearchBaseGUI.

Definition at line 72 of file class.ilLuceneUserSearchGUI.php.

73 {
74 parent::prepareOutput();
75 $this->getTabs();
76 return true;
77 }

References getTabs().

Referenced by executeCommand().

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

◆ remoteSearch()

ilLuceneUserSearchGUI::remoteSearch ( )
protected

Search from main menu.

Definition at line 108 of file class.ilLuceneUserSearchGUI.php.

109 {
110 $_POST['query'] = $_POST['queryString'];
111 $this->search_cache->setRoot((int) $_POST['root_id']);
112 $this->search_cache->setQuery(ilUtil::stripSlashes($_POST['queryString']));
113 $this->search_cache->save();
114
115 $this->search();
116 }
search()
Search (button pressed)

References $_POST, search(), and ilUtil\stripSlashes().

+ Here is the call graph for this function:

◆ search()

ilLuceneUserSearchGUI::search ( )
protected

Search (button pressed)

Returns

Definition at line 137 of file class.ilLuceneUserSearchGUI.php.

138 {
139 if (!$this->form->checkInput()) {
140 $this->search_cache->deleteCachedEntries();
141 // Reset details
142 include_once './Services/Object/classes/class.ilSubItemListGUI.php';
144 $this->showSearchForm();
145 return false;
146 }
147
148 unset($_SESSION['max_page']);
149 $this->search_cache->deleteCachedEntries();
150
151 // Reset details
152 include_once './Services/Object/classes/class.ilSubItemListGUI.php';
154
155 $this->performSearch();
156 }
$_SESSION["AccountId"]
static resetDetails()
reset details As long as static::resetDetails is not possible this method is final

References $_SESSION, performSearch(), ilSubItemListGUI\resetDetails(), and showSearchForm().

Referenced by remoteSearch().

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

◆ showSavedResults()

ilLuceneUserSearchGUI::showSavedResults ( )
protected

Show saved results.

Returns

Definition at line 122 of file class.ilLuceneUserSearchGUI.php.

123 {
124 global $ilUser,$ilBench;
125
126 if (strlen($this->search_cache->getQuery())) {
127 return $this->performSearch();
128 }
129
130 return $this->showSearchForm();
131 }

References $ilBench, $ilUser, performSearch(), and showSearchForm().

+ Here is the call graph for this function:

◆ showSearchForm()

ilLuceneUserSearchGUI::showSearchForm ( )
protected

Show search form.

Returns
boolean

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

245 {
246 global $ilCtrl, $lng;
247
248 $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.lucene_usr_search.html', 'Services/Search');
249
250 // include js needed
251 include_once("./Services/UIComponent/Overlay/classes/class.ilOverlayGUI.php");
253 $this->tpl->addJavascript("./Services/Search/js/Search.js");
254
255 $this->tpl->setVariable('FORM_ACTION', $GLOBALS['ilCtrl']->getFormAction($this, 'performSearch'));
256 $this->tpl->setVariable("TERM", ilUtil::prepareFormOutput($this->search_cache->getQuery()));
257 include_once("./Services/UIComponent/Button/classes/class.ilSubmitButton.php");
259 $btn->setCommand("performSearch");
260 $btn->setCaption("search");
261 $this->tpl->setVariable("SUBMIT_BTN", $btn->render());
262
263 return true;
264 }
static initJavascript()
Init javascript.
static getInstance()
Factory.
static prepareFormOutput($a_str, $a_strip=false)
prepares string output for html forms @access public

References $GLOBALS, $ilCtrl, ilSearchBaseGUI\$lng, ilSubmitButton\getInstance(), ilOverlayGUI\initJavascript(), and ilUtil\prepareFormOutput().

Referenced by performSearch(), search(), and showSavedResults().

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

Field Documentation

◆ $ilTabs

ilLuceneUserSearchGUI::$ilTabs
protected

Definition at line 22 of file class.ilLuceneUserSearchGUI.php.

Referenced by __construct().


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