ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
ilRepositoryObjectSearchBlockGUI Class Reference
+ Inheritance diagram for ilRepositoryObjectSearchBlockGUI:
+ Collaboration diagram for ilRepositoryObjectSearchBlockGUI:

Public Member Functions

 __construct (string $a_title)
 
 getBlockType ()
 
 executeCommand ()
 
 getHTML ()
 
 fillDataSection ()
 
- 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 ()
 
 correctOffset ()
 
 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="")
 
 getBlockCommands ()
 
 getHTML ()
 
 fillHeaderCommands ()
 
 fillHeaderTitleBlock ()
 
 setDataSection (string $a_content)
 Call this from overwritten fillDataSection(), if standard row based data is not used. More...
 
 fillDataSection ()
 Standard implementation for row based data. More...
 
 fillRow (array $a_set)
 
 fillFooter ()
 
 fillPreviousNext ()
 
 setPreviousNextLinks ()
 
 getAsynch ()
 Use this for final get before sending asynchronous output (ajax) per echo to output. More...
 
 getPaginationViewControl ()
 Fill previous/next row. More...
 
 getHTMLNew ()
 
 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 ()
 
 fillRowColor (string $a_placeholder="CSS_ROW")
 
 preloadData (array $data)
 Can be overwritten in subclasses. More...
 
 getLegacyContent ()
 Get legacy content. More...
 
 getViewControls ()
 Get view controls. 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...
 
 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
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
 
bool $new_rendering = false
 

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().

40  {
41  global $DIC;
42 
44 
45  $this->http = $DIC->http();
46  $this->refinery = $DIC->refinery();
47 
48  $this->setEnableNumInfo(false);
49 
50  $this->setTitle($a_title);
51  $this->allow_moving = false;
52  $this->new_rendering = true;
53  }
setEnableNumInfo(bool $a_enablenuminfo)
global $DIC
Definition: feed.php:28
static http()
Fetches the global http state from ILIAS.
__construct(Container $dic, ilPlugin $plugin)
setTitle(string $a_title)
+ Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilRepositoryObjectSearchBlockGUI::executeCommand ( )

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

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

79  : void
80  {
81  $ilCtrl = $this->ctrl;
82 
83  $next_class = $ilCtrl->getNextClass();
84  $cmd = $ilCtrl->getCmd("getHTML");
85 
86  switch ($next_class) {
87  default:
88  $this->$cmd();
89  }
90  }
getNextClass($a_gui_class=null)
+ Here is the call graph for this function:

◆ fillDataSection()

ilRepositoryObjectSearchBlockGUI::fillDataSection ( )

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

References getLegacyContent(), and ilBlockGUI\setDataSection().

97  : void
98  {
99  $this->setDataSection($this->getLegacyContent());
100  }
setDataSection(string $a_content)
Call this from overwritten fillDataSection(), if standard row based data is not used.
+ Here is the call graph for this function:

◆ getBlockType()

ilRepositoryObjectSearchBlockGUI::getBlockType ( )

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

58  : string
59  {
60  return self::$block_type;
61  }

◆ getHTML()

ilRepositoryObjectSearchBlockGUI::getHTML ( )

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

92  : string
93  {
94  return parent::getHTML();
95  }

◆ getLegacyContent()

ilRepositoryObjectSearchBlockGUI::getLegacyContent ( )
protected

Definition at line 105 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().

Referenced by fillDataSection().

105  : string
106  {
107  $tpl = new ilTemplate("tpl.search_search_block.html", true, true, 'Services/Search');
108 
109  $this->lng->loadLanguageModule('search');
110  $tpl->setVariable("TXT_SEARCH_INPUT_LABEL", $this->lng->txt('search_field'));
111  $tpl->setVariable("TXT_SEARCH_INPUT_PERFORM_LABEL", $this->lng->txt('search_field_perform'));
112  $tpl->setVariable("TXT_PERFORM", $this->lng->txt('btn_search'));
113  $tpl->setVariable("FORMACTION", $this->ctrl->getFormActionByClass('ilrepositoryobjectsearchgui', 'performSearch'));
114 
115  $post_search_term = '';
116  if ($this->http->wrapper()->post()->has('search_term')) {
117  $post_search_term = $this->http->wrapper()->post()->retrieve(
118  'search_term',
119  $this->refinery->kindlyTo()->string()
120  );
121  }
122  $tpl->setVariable(
123  "SEARCH_TERM",
125  );
126  return $tpl->get();
127  }
get(string $part=ilGlobalTemplateInterface::DEFAULT_BLOCK)
static prepareFormOutput($a_str, bool $a_strip=false)
static http()
Fetches the global http state from ILIAS.
setVariable($variable, $value='')
Sets a variable value.
Definition: IT.php:514
ilTemplate $tpl
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getScreenMode()

static ilRepositoryObjectSearchBlockGUI::getScreenMode ( )
static

Get Screen Mode for current command.

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

References IL_SCREEN_SIDE.

74  : string
75  {
76  return IL_SCREEN_SIDE;
77  }
const IL_SCREEN_SIDE

◆ isRepositoryObject()

ilRepositoryObjectSearchBlockGUI::isRepositoryObject ( )
protected

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

66  : bool
67  {
68  return false;
69  }

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: