ilRepositoryObjectSearchBlockGUI Class Reference

Inheritance diagram for ilRepositoryObjectSearchBlockGUI:

Collaboration diagram for ilRepositoryObjectSearchBlockGUI:

Public Member Functions
	__construct (string $a_title)
	getBlockType ()
	executeCommand ()
Public Member Functions inherited from ilBlockGUI
	__construct ()
	getBlockType ()
	setData (array $a_data)
	getData ()
	setPresentation (int $type)
	getPresentation ()
	setBlockId (string $a_block_id="0")
	getBlockId ()
	setGuiObject (object $a_gui_object)
	Set GuiObject. More...
	getGuiObject ()
	setTitle (string $a_title)
	getTitle ()
	setOffset (int $a_offset)
	getOffset ()
	checkOffset (int $offset)
	setLimit (int $a_limit)
	getLimit ()
	setEnableEdit (bool $a_enableedit)
	getEnableEdit ()
	setRepositoryMode (bool $a_repositorymode)
	getRepositoryMode ()
	setSubtitle (string $a_subtitle)
	getSubtitle ()
	setRefId (int $a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...
	getRefId ()
	setAdminCommands (bool $a_admincommands)
	getAdminCommands ()
	setEnableNumInfo (bool $a_enablenuminfo)
	getEnableNumInfo ()
	setProperties (array $a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...
	getProperty (string $a_property)
	setProperty (string $a_property, string $a_value)
	setRowTemplate (string $a_rowtemplatename, string $a_rowtemplatedir="")
	Set Row Template Name. More...
	getNavParameter ()
	getConfigParameter ()
	getMoveParameter ()
	getRowTemplateName ()
	getRowTemplateDir ()
	addBlockCommand (string $a_href, string $a_text, string $a_onclick="", RoundTrip $modal=null)
	getBlockCommands ()
	getHTML ()
	getAsynch ()
	Use this for final get before sending asynchronous output (ajax) per echo to output. More...
	getPaginationViewControl ()
	Fill previous/next row. More...
	getViewControlsForPanel ()
	sortObject ()
	addSortOption (string $option, string $label, bool $active)
	setSortTarget (string $target)
	addPresentation (string $label, string $target, bool $active)
	getNoItemFoundContent ()

Static Public Member Functions
static	getScreenMode ()
	Get Screen Mode for current command. More...
Static Public Member Functions inherited from ilBlockGUI
static	getScreenMode ()

Static Public Attributes
static string	$block_type = "objectsearch"

Protected Member Functions
	isRepositoryObject ()
	getLegacyContent ()
Protected Member Functions inherited from ilBlockGUI
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...
	specialCharsAsEntities (string $string)
	initCommands ()
	preloadData (array $data)
	Can be overwritten in subclasses. More...
	getLegacyContent ()
	Get legacy content. More...
	getListItemForData (array $data)
	Get list item for data array. More...
	handleNavigation ()
	Handle navigation. More...
	loadData ()
	Load data for current page. More...
	getListItemGroups ()
	Get items. More...
	addRepoCommands ()
	Add repo commands. More...
	getActionsForPanel ()
	send (string $output)
	Send. More...

Private Attributes
ILIAS HTTP GlobalHttpState	$http
ILIAS Refinery Factory	$refinery

Additional Inherited Members
Data Fields inherited from ilBlockGUI
const	PRES_MAIN_LEG = 0
const	PRES_SEC_LEG = 1
const	PRES_SEC_LIST = 2
const	PRES_MAIN_LIST = 3
const	PRES_MAIN_TILE = 4
Protected Attributes inherited from ilBlockGUI
ILIAS UI Renderer	$renderer
Factory	$factory
object	$gui_object
ILIAS Block StandardGUIRequest	$request
ILIAS Block BlockManager	$block_manager
bool	$repositorymode = false
ILIAS DI UIServices	$ui
array	$data = array()
bool	$enablenuminfo = true
array	$footer_links = array()
string	$block_id = "0"
bool	$allow_moving = true
array	$move = array("left" => false, "right" => false, "up" => false, "down" => false)
array	$block_commands = array()
int	$max_count = 0
bool	$close_command = false
bool	$image = false
array	$property = []
string	$nav_value = ""
string	$css_row = ""
string	$title = ""
bool	$admincommands = false
array	$dropdown
ilTemplate	$tpl
ilGlobalTemplateInterface	$main_tpl
ilObjUser	$user
ilCtrl	$ctrl
ilAccessHandler	$access
ilLanguage	$lng
ilObjectDefinition	$obj_def
int	$presentation
int	$requested_ref_id

Detailed Description

Definition at line 31 of file class.ilRepositoryObjectSearchBlockGUI.php.

Constructor & Destructor Documentation

__construct()

ilRepositoryObjectSearchBlockGUI::__construct

(

string

$a_title

)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), ilBlockGUI\setEnableNumInfo(), and ilBlockGUI\setTitle().

    {
        global $DIC;

        parent::__construct();

        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();

        $this->setEnableNumInfo(false);

        $this->setTitle($a_title);
        $this->allow_moving = false;
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilRepositoryObjectSearchBlockGUI::executeCommand

(

)

Definition at line 78 of file class.ilRepositoryObjectSearchBlockGUI.php.

References ilBlockGUI\$ctrl, and ilCtrl\getNextClass().

                                    : void
    {
        $ilCtrl = $this->ctrl;

        $next_class = $ilCtrl->getNextClass();
        $cmd = $ilCtrl->getCmd("getHTML");

        switch ($next_class) {
            default:
                $this->$cmd();
        }
    }

Here is the call graph for this function:

getBlockType()

ilRepositoryObjectSearchBlockGUI::getBlockType

(

)

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

                                  : string
    {
        return self::$block_type;
    }

getLegacyContent()

ilRepositoryObjectSearchBlockGUI::getLegacyContent ( )

protected

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

References ilBlockGUI\$tpl, ILIAS\Repository\ctrl(), ilTemplate\get(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\prepareFormOutput(), ILIAS\Repository\refinery(), and HTML_Template_IT\setVariable().

                                         : string
    {
        $tpl = new ilTemplate("tpl.search_search_block.html", true, true, 'components/ILIAS/Search');

        $this->lng->loadLanguageModule('search');
        $tpl->setVariable("TXT_SEARCH_INPUT_LABEL", $this->lng->txt('search_field'));
        $tpl->setVariable("TXT_SEARCH_INPUT_PERFORM_LABEL", $this->lng->txt('search_field_perform'));
        $tpl->setVariable("TXT_PERFORM", $this->lng->txt('btn_search'));
        $tpl->setVariable("FORMACTION", $this->ctrl->getFormActionByClass('ilrepositoryobjectsearchgui', 'performSearch'));

        $post_search_term = '';
        if ($this->http->wrapper()->post()->has('search_term')) {
            $post_search_term = $this->http->wrapper()->post()->retrieve(
                'search_term',
                $this->refinery->kindlyTo()->string()
            );
        }
        $tpl->setVariable(
            "SEARCH_TERM",
            ilLegacyFormElementsUtil::prepareFormOutput($post_search_term)
        );
        return $tpl->get();
    }

Here is the call graph for this function:

getScreenMode()

static ilRepositoryObjectSearchBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Definition at line 73 of file class.ilRepositoryObjectSearchBlockGUI.php.

References IL_SCREEN_SIDE.

                                          : string
    {
        return IL_SCREEN_SIDE;
    }

isRepositoryObject()

ilRepositoryObjectSearchBlockGUI::isRepositoryObject ( )

protected

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

                                           : bool
    {
        return false;
    }

Field Documentation

$block_type

string ilRepositoryObjectSearchBlockGUI::$block_type = "objectsearch"

static

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

$http

ILIAS HTTP GlobalHttpState ilRepositoryObjectSearchBlockGUI::$http

private

Definition at line 33 of file class.ilRepositoryObjectSearchBlockGUI.php.

$refinery

ILIAS Refinery Factory ilRepositoryObjectSearchBlockGUI::$refinery

private

Definition at line 34 of file class.ilRepositoryObjectSearchBlockGUI.php.

---

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

• components/ILIAS/Search/classes/class.ilRepositoryObjectSearchBlockGUI.php