ilSearchBaseGUI Class Reference

Inheritance diagram for ilSearchBaseGUI:

Collaboration diagram for ilSearchBaseGUI:

Public Member Functions
	ilSearchBaseGUI ()
	Constructor public.
	prepareOutput ()
	handleCommand ($a_cmd)
	addToDeskObject ()
	Interface methods.
	removeFromDeskObject ()
	Remove from dektop.
	delete ()
	Show deletion screen.
	cancelDelete ()
	Cancel delete.
	performDelete ()
	Delete objects.
	cut ()
	Interface ilAdministrationCommandHandler.
	link ()
	Interface ilAdministrationCommandHandler.
	paste ()
	Paste.
	showLinkIntoMultipleObjectsTree ()
	Target selection link.
	showMoveIntoObjectTree ()
	Target selection cut.
	performPasteIntoMultipleObjects ()
	Perform paste into multiple objects.
	clear ()
	clear clipboard
	enableAdministrationPanel ()
	Enable administration panel.
	disableAdministrationPanel ()
	Disable administration panel.
	addLocator ()
	Add Locator.
	autoComplete ()
	Data resource for autoComplete.

Data Fields
	$settings = null
	$ilias = null
	$lng = null
	$tpl = null

Protected Member Functions
	addPager ($result, $a_session_key)
	Add Pager.
	buildSearchAreaPath ($a_root_node)
	Build path for search area.

Protected Attributes
	$ctrl = null

Detailed Description

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

Member Function Documentation

ilSearchBaseGUI::addLocator

(

)

Add Locator.

Definition at line 201 of file class.ilSearchBaseGUI.php.

        {
                $ilLocator->addItem($this->lng->txt('search'),$this->ctrl->getLinkTarget($this));
                $this->tpl->setLocator();
        }

ilSearchBaseGUI::addPager (   $result,   $a_session_key  )

protected

Add Pager.

public

Parameters

Definition at line 214 of file class.ilSearchBaseGUI.php.

References $_SESSION, $result, and $tpl.

Referenced by ilAdvancedSearchGUI\performAdvMDSearch(), ilAdvancedSearchGUI\performSearch(), ilLuceneAdvancedSearchGUI\performSearch(), ilLuceneSearchGUI\performSearch(), ilSearchGUI\performSearch(), ilAdvancedSearchGUI\showSavedAdvMDResults(), ilLuceneAdvancedSearchGUI\showSavedResults(), ilLuceneSearchGUI\showSavedResults(), ilSearchGUI\showSavedResults(), and ilAdvancedSearchGUI\showSavedResults().

        {
                global $tpl;
                
                $_SESSION["$a_session_key"] = max($_SESSION["$a_session_key"],$this->search_cache->getResultPageNumber());
                
                if($_SESSION["$a_session_key"] == 1 and 
                        (count($result->getResults()) < $result->getMaxHits()))
                {
                        return true;
                }
                
                if($this->search_cache->getResultPageNumber() > 1)
                {
                        $this->ctrl->setParameter($this,'page_number',$this->search_cache->getResultPageNumber() - 1);
/*                      $this->tpl->setCurrentBlock('prev');
                        $this->tpl->setVariable('PREV_LINK',$this->ctrl->getLinkTarget($this,'performSearch'));
                        $this->tpl->setVariable('TXT_PREV',$this->lng->txt('search_page_prev'));
                        $this->tpl->parseCurrentBlock();
*/
                        $this->prev_link = $this->ctrl->getLinkTarget($this,'performSearch');
                }
                for($i = 1;$i <= $_SESSION["$a_session_key"];$i++)
                {
                        if($i == $this->search_cache->getResultPageNumber())
                        {
/*                              $this->tpl->setCurrentBlock('pages_link');
                                $this->tpl->setVariable('NUMBER',$i);
                                $this->tpl->parseCurrentBlock();
*/
                                continue;
                        }
                        
                        $this->ctrl->setParameter($this,'page_number',$i);
                        $link = '<a href="'.$this->ctrl->getLinkTarget($this,'performSearch').'" /a>'.$i.'</a> ';
/*                      $this->tpl->setCurrentBlock('pages_link');
                        $this->tpl->setVariable('NUMBER',$link);
                        $this->tpl->parseCurrentBlock();
*/
                }
                

                if(count($result->getResults()) >= $result->getMaxHits())
                {
                        $this->ctrl->setParameter($this,'page_number',$this->search_cache->getResultPageNumber() + 1);
/*                      $this->tpl->setCurrentBlock('next');
                        $this->tpl->setVariable('NEXT_LINK',$this->ctrl->getLinkTarget($this,'performSearch'));
                        $this->tpl->setVariable('TXT_NEXT',$this->lng->txt('search_page_next'));
                        $this->tpl->parseCurrentBlock();
*/
$this->next_link = $this->ctrl->getLinkTarget($this,'performSearch');
                }

/*              $this->tpl->setCurrentBlock('prev_next');
                $this->tpl->setVariable('SEARCH_PAGE',$this->lng->txt('search_page'));
                $this->tpl->parseCurrentBlock();
*/
                
                $this->ctrl->clearParameters($this);
        }

Here is the caller graph for this function:

ilSearchBaseGUI::addToDeskObject

(

)

Interface methods.

Implements ilDesktopItemHandling.

Definition at line 84 of file class.ilSearchBaseGUI.php.

References ilDesktopItemGUI\addToDesktop().

        {
                include_once './Services/PersonalDesktop/classes/class.ilDesktopItemGUI.php';
                ilDesktopItemGUI::addToDesktop();
                $this->showSavedResults();
        }

Here is the call graph for this function:

ilSearchBaseGUI::autoComplete

(

)

Data resource for autoComplete.

Reimplemented in ilSearchGUI.

Definition at line 304 of file class.ilSearchBaseGUI.php.

References $_REQUEST, exit, and ilSearchAutoComplete\getList().

        {
                $q = $_REQUEST["query"];
                include_once("./Services/Search/classes/class.ilSearchAutoComplete.php");
                $list = ilSearchAutoComplete::getList($q);
                echo $list;
                exit;
        }

Here is the call graph for this function:

ilSearchBaseGUI::buildSearchAreaPath (   $a_root_node )

protected

Build path for search area.

Returns

Definition at line 279 of file class.ilSearchBaseGUI.php.

References $data, and $path.

        {
                global $tree;

                $path_arr = $tree->getPathFull($a_root_node,ROOT_FOLDER_ID);
                $counter = 0;
                foreach($path_arr as $data)
                {
                        if($counter++)
                        {
                                $path .= " > ";
                                $path .= $data['title'];
                        }
                        else
                        {
                                $path .= $this->lng->txt('repository');
                        }
                        
                }
                return $path;
        }

ilSearchBaseGUI::cancelDelete

(

)

Cancel delete.

Implements ilAdministrationCommandHandling.

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

        {
                $this->showSavedResults();
        }

ilSearchBaseGUI::clear

(

)

clear clipboard

Implements ilAdministrationCommandHandling.

Definition at line 179 of file class.ilSearchBaseGUI.php.

References $_SESSION.

        {
                unset($_SESSION['clipboard']);
                $this->ctrl->redirect($this);
        }

ilSearchBaseGUI::cut

(

)

Interface ilAdministrationCommandHandler.

Implements ilAdministrationCommandHandling.

Definition at line 132 of file class.ilSearchBaseGUI.php.

        {
        

                include_once './Services/Administration/classes/class.ilAdministrationCommandGUI.php';
                $admin = new ilAdministrationCommandGUI($this);
                $admin->cut();
        }

ilSearchBaseGUI::delete

(

)

Show deletion screen.

Implements ilAdministrationCommandHandling.

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

        {
                include_once './Services/Administration/classes/class.ilAdministrationCommandGUI.php';
                $admin = new ilAdministrationCommandGUI($this);
                $admin->delete();
        }

ilSearchBaseGUI::disableAdministrationPanel

(

)

Disable administration panel.

Implements ilAdministrationCommandHandling.

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

References $_SESSION.

        {
                $_SESSION["il_cont_admin_panel"] = false;
                $this->ctrl->redirect($this);
        }

ilSearchBaseGUI::enableAdministrationPanel

(

)

Enable administration panel.

Implements ilAdministrationCommandHandling.

Definition at line 185 of file class.ilSearchBaseGUI.php.

References $_SESSION.

        {
                $_SESSION["il_cont_admin_panel"] = true;
                $this->ctrl->redirect($this);
        }

ilSearchBaseGUI::handleCommand

(

$a_cmd

)

Definition at line 68 of file class.ilSearchBaseGUI.php.

Referenced by ilLuceneSearchGUI\executeCommand(), ilLuceneAdvancedSearchGUI\executeCommand(), ilAdvancedSearchGUI\executeCommand(), and ilSearchGUI\executeCommand().

        {
                if(method_exists($this, $a_cmd))
                {
                        $this->$a_cmd();
                }
                else
                {
                        $a_cmd .= 'Object';
                        $this->$a_cmd();        
                }
        }

Here is the caller graph for this function:

ilSearchBaseGUI::ilSearchBaseGUI

(

)

Constructor public.

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

References $ilCtrl, $ilias, $lng, and $tpl.

Referenced by ilAdvancedSearchGUI\ilAdvancedSearchGUI(), and ilSearchGUI\ilSearchGUI().

        {
                global $ilCtrl,$ilias,$lng,$tpl,$ilMainMenu;

                $this->ilias =& $ilias;
                $this->ctrl =& $ilCtrl;
                $this->tpl =& $tpl;
                $this->lng =& $lng;
                $this->lng->loadLanguageModule('search');

                $ilMainMenu->setActive('search');
                $this->settings =& new ilSearchSettings();
        }

Here is the caller graph for this function:

ilSearchBaseGUI::link

(

)

Interface ilAdministrationCommandHandler.

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

        {
                include_once './Services/Administration/classes/class.ilAdministrationCommandGUI.php';
                $admin = new ilAdministrationCommandGUI($this);
                $admin->link();
        }

ilSearchBaseGUI::paste

(

)

Paste.

Implements ilAdministrationCommandHandling.

Definition at line 151 of file class.ilSearchBaseGUI.php.

        {
                include_once './Services/Administration/classes/class.ilAdministrationCommandGUI.php';
                $admin = new ilAdministrationCommandGUI($this);
                $admin->paste();
        }

ilSearchBaseGUI::performDelete

(

)

Delete objects.

Implements ilAdministrationCommandHandling.

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

        {
                include_once './Services/Administration/classes/class.ilAdministrationCommandGUI.php';
                $admin = new ilAdministrationCommandGUI($this);
                $admin->performDelete();
        }

ilSearchBaseGUI::performPasteIntoMultipleObjects

(

)

Perform paste into multiple objects.

Returns

Implements ilAdministrationCommandHandling.

Definition at line 172 of file class.ilSearchBaseGUI.php.

        {
                include_once './Services/Administration/classes/class.ilAdministrationCommandGUI.php';
                $admin = new ilAdministrationCommandGUI($this);
                $admin->performPasteIntoMultipleObjects();
        }

ilSearchBaseGUI::prepareOutput

(

)

Reimplemented in ilAdvancedSearchGUI, ilSearchGUI, ilLuceneAdvancedSearchGUI, and ilLuceneSearchGUI.

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

References $lng, ilUtil\getImagePath(), and ilUtil\infoPanel().

        {
                global $ilLocator, $lng;
                
                $this->tpl->getStandardTemplate();
                
//              $ilLocator->addItem($this->lng->txt('search'),$this->ctrl->getLinkTarget($this));
//              $this->tpl->setLocator();
                
                //$this->tpl->setTitleIcon(ilUtil::getImagePath("icon_src_b.gif"),
                //      $lng->txt("search"));
                $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_src_b.gif"),
                        "");
                $this->tpl->setTitle($lng->txt("search"));

                ilUtil::infoPanel();

        }

Here is the call graph for this function:

ilSearchBaseGUI::removeFromDeskObject

(

)

Remove from dektop.

Implements ilDesktopItemHandling.

Definition at line 94 of file class.ilSearchBaseGUI.php.

References ilDesktopItemGUI\removeFromDesktop().

        {
                include_once './Services/PersonalDesktop/classes/class.ilDesktopItemGUI.php';
                ilDesktopItemGUI::removeFromDesktop();
                $this->showSavedResults();
        }

Here is the call graph for this function:

ilSearchBaseGUI::showLinkIntoMultipleObjectsTree

(

)

Target selection link.

Returns

Implements ilAdministrationCommandHandling.

Definition at line 158 of file class.ilSearchBaseGUI.php.

        {
                include_once './Services/Administration/classes/class.ilAdministrationCommandGUI.php';
                $admin = new ilAdministrationCommandGUI($this);
                $admin->showLinkIntoMultipleObjectsTree();
        }

ilSearchBaseGUI::showMoveIntoObjectTree

(

)

Target selection cut.

Returns

Implements ilAdministrationCommandHandling.

Definition at line 165 of file class.ilSearchBaseGUI.php.

        {
                include_once './Services/Administration/classes/class.ilAdministrationCommandGUI.php';
                $admin = new ilAdministrationCommandGUI($this);
                $admin->showMoveIntoObjectTree();
        }

Field Documentation

ilSearchBaseGUI::$ctrl = null

protected

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

ilSearchBaseGUI::$ilias = null

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

Referenced by ilSearchBaseGUI().

ilSearchBaseGUI::$lng = null

Definition at line 28 of file class.ilSearchBaseGUI.php.

Referenced by ilLuceneAdvancedSearchGUI\fillAdminPanel(), ilLuceneSearchGUI\fillAdminPanel(), ilSearchBaseGUI(), ilSearchGUI\ilSearchGUI(), ilLuceneSearchGUI\initFormSearch(), ilSearchGUI\initStandardSearchForm(), and prepareOutput().

ilSearchBaseGUI::$settings = null

Definition at line 24 of file class.ilSearchBaseGUI.php.

ilSearchBaseGUI::$tpl = null

Definition at line 29 of file class.ilSearchBaseGUI.php.

Referenced by addPager(), ilSearchBaseGUI(), and ilLuceneSearchGUI\initFormSearch().

---

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

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