Inheritance diagram for ilObjSearchSettingsGUI:

Collaboration diagram for ilObjSearchSettingsGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference, $a_prepare_output=true)

	executeCommand ()

	getAdminTabs ()

Public Member Functions inherited from ilObjectGUI
	getRefId ()

	setAdminMode (string $mode)

	getAdminMode ()

	getObject ()

	executeCommand ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelObject ()
	cancel action and go back to previous page More...

	createObject ()
	create new object form More...

	editAvailabilityPeriodObject ()

	saveAvailabilityPeriodObject ()

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()

	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()

	addExternalEditFormCustom (ilPropertyFormGUI $form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...

	isVisible (int $ref_id, string $type)

	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...

	setColumnSettings (ilColumnGUI $column_gui)

	addToDeskObject ()

	removeFromDeskObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Protected Member Functions
	redirectToSettings ()

	redirectToLuceneSettings ()

	getTabs ()

	advancedLuceneSettingsObject ()

	saveAdvancedLuceneSettingsObject ()

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	createActionDispatcherGUI ()

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...

	addHeaderAction ()
	Add header action menu. More...

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	setTabs ()
	set admin tabs More...

	setAdminTabs ()
	set admin tabs More...

	setLocator ()

	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...

	omitLocator (bool $omit=true)

	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	getCreationFormsHTML (StandardForm\|ilPropertyFormGUI\|array $form)

	getTitleForCreationFormPage ()

	getCreationFormTitle ()

	initCreateForm (string $new_type)

	didacticTemplatesToForm ()

	initDidacticTemplate (ilPropertyFormGUI $form)

	retrieveAdditionalDidacticTemplateOptions ()

	addAdoptContentLinkToToolbar ()

	addImportButtonToToolbar ()

	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)

	parseDidacticTemplateVar (string $var, string $type)

	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...

	initEditForm ()

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	routeImportCmdObject ()

	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)

	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)

	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...

	setFormAction (string $cmd, string $form_action)

	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	getTabs ()
	overwrite in derived GUI class of your object type More...

	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

	getCreatableObjectTypes ()

	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)

	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Protected Attributes
Factory	$refinery

UIServices	$ui

ilLogger	$src_logger

ilObjUser	$user

bool	$read_only = true

Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service

ServerRequestInterface	$request

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilSetting	$settings

ilToolbarGUI	$toolbar

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

ilObjectService	$object_service

ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilCtrl	$ctrl

ilErrorHandling	$error

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ILIAS	$ilias

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Refinery	$refinery

ilFavouritesManager	$favourites

ilObjectCustomIconFactory	$custom_icon_factory

UIFactory	$ui_factory

UIRenderer	$ui_renderer

Filesystem	$temp_file_system

ilObject	$object = null

bool	$creation_mode = false

	$data

int	$id

bool	$call_by_reference = false

bool	$prepare_output

int	$ref_id

int	$obj_id

int	$maxcount

array	$form_action = []

array	$return_location = []

array	$target_frame = []

string	$tmp_import_dir

string	$sub_objects = ""

bool	$omit_locator = false

string	$type = ""

string	$admin_mode = self::ADMIN_MODE_NONE

int	$requested_ref_id = 0

int	$requested_crtptrefid = 0

int	$requested_crtcb = 0

string	$requested_new_type = ""

string	$link_params

string	$html = ""

Private Attributes
GlobalHttpState	$http

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode (int $ref_id, string $cmd="")

static	_gotoSharedWorkspaceNode (int $wsp_id)

Data Fields inherited from ilObjectGUI
const	ADMIN_MODE_NONE = ""

const	ADMIN_MODE_SETTINGS = "settings"

const	ADMIN_MODE_REPOSITORY = "repository"

const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

const	SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]

Detailed Description

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

ilObjSearchSettingsGUI: ilPermissionGUI, ilObjSearchSettingsFormGUI, ilObjSearchLuceneSettingsFormGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjSearchSettingsGUI::__construct	(	$a_data,
		$a_id,
		$a_call_by_reference,
		$a_prepare_output = `true`
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
         $this->ui = $DIC->ui();
         $this->src_logger = $DIC->logger()->src();
         $this->user = $DIC->user();
 
         $this->type = "seas";
         parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
         $this->lng->loadLanguageModule('search');
     }

Here is the call graph for this function:

Member Function Documentation

◆ advancedLuceneSettingsObject()

ilObjSearchSettingsGUI::advancedLuceneSettingsObject ( )

protected

Definition at line 206 of file class.ilObjSearchSettingsGUI.php.

References ilLuceneAdvancedSearchSettings\getInstance(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                                                      : void
     {
         $this->tabs_gui->setTabActive('lucene_advanced_settings');
 
         $table = new ilLuceneAdvancedSearchActivationTableGUI($this, 'advancedLuceneSettings');
         $table->setTitle($this->lng->txt('lucene_advanced_settings_table'));
         $table->parse(ilLuceneAdvancedSearchSettings::getInstance());
 
         $this->tpl->setContent($table->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjSearchSettingsGUI::executeCommand ( )

Definition at line 54 of file class.ilObjSearchSettingsGUI.php.

References advancedLuceneSettingsObject(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilObjectGUI\prepareOutput(), redirectToLuceneSettings(), redirectToSettings(), ILIAS\Repository\refinery(), ILIAS\Repository\settings(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

                                     : void
     {
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd();
         $this->prepareOutput();
 
         switch ($next_class) {
             case 'ilpermissiongui':
                 $this->tabs_gui->activateTab('perm_settings');
                 $perm_gui = new ilPermissionGUI($this);
                 $ret = $this->ctrl->forwardCommand($perm_gui);
                 return;
 
             case 'ilobjsearchsettingsformgui':
                 $this->tabs_gui->activateTab('settings');
                 $settings_gui = new ilObjSearchSettingsFormGUI(
                     $this->http,
                     $this->ctrl,
                     $this->lng,
                     $this->ui,
                     new ilObjSearchRpcClientCoordinator(
                         $this->settings,
                         $this->src_logger
                     )
                 );
                 $ret = $this->ctrl->forwardCommand($settings_gui);
                 return;
 
             case 'ilobjsearchlucenesettingsformgui':
                 $this->tabs_gui->activateTab('lucene_settings_tab');
                 $luc_settings_gui = new ilObjSearchLuceneSettingsFormGUI(
                     $this->http,
                     $this->ctrl,
                     $this->lng,
                     $this->ui,
                     $this->refinery,
                     $this->user,
                     new ilObjSearchRpcClientCoordinator(
                         $this->settings,
                         $this->src_logger
                     )
                 );
                 $ret = $this->ctrl->forwardCommand($luc_settings_gui);
                 return;
         }
 
         switch ($cmd) {
             case '':
             case 'view':
             case 'settings':
                 $this->redirectToSettings();
                 break;
 
             case 'luceneSettings':
                 $this->redirectToLuceneSettings();
                 break;
 
             case 'advancedLuceneSettings':
                 $this->advancedLuceneSettingsObject();
                 break;
 
             default:
                 $cmd .= "Object";
                 $this->$cmd();
         }
     }

Here is the call graph for this function:

◆ getAdminTabs()

ilObjSearchSettingsGUI::getAdminTabs ( )

Definition at line 163 of file class.ilObjSearchSettingsGUI.php.

References getTabs().

                                   : void
     {
         $this->getTabs();
     }

Here is the call graph for this function:

◆ getTabs()

ilObjSearchSettingsGUI::getTabs ( )

protected

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

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by getAdminTabs().

                                 : void
     {
         if ($this->rbac_system->checkAccess("visible,read", $this->object->getRefId())) {
             $this->tabs_gui->addTab(
                 'settings',
                 $this->lng->txt('settings'),
                 $this->ctrl->getLinkTarget($this, 'settings')
             );
         }
 
         if ($this->rbac_system->checkAccess('read', $this->object->getRefId())) {
             $this->tabs_gui->addTab(
                 'lucene_advanced_settings',
                 $this->lng->txt('lucene_advanced_settings'),
                 $this->ctrl->getLinkTarget($this, 'advancedLuceneSettings')
             );
         }
 
         if ($this->rbac_system->checkAccess('read', $this->object->getRefId())) {
             $this->tabs_gui->addTab(
                 'lucene_settings_tab',
                 $this->lng->txt('lucene_settings_tab'),
                 $this->ctrl->getLinkTarget($this, 'luceneSettings')
             );
         }
 
         if ($this->rbac_system->checkAccess('edit_permission', $this->object->getRefId())) {
             $this->tabs_gui->addTab(
                 'perm_settings',
                 $this->lng->txt('perm_settings'),
                 $this->ctrl->getLinkTargetByClass(
                     [get_class($this),'ilpermissiongui'],
                     'perm'
                 ),
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redirectToLuceneSettings()

ilObjSearchSettingsGUI::redirectToLuceneSettings ( )

protected

Definition at line 142 of file class.ilObjSearchSettingsGUI.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                                                  : void
     {
         if (!$this->rbac_system->checkAccess('visible,read', $this->object->getRefId())) {
             $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
         }
 
         $this->tabs_gui->setTabActive('lucene_settings_tab');
 
         if (!$this->rbac_system->checkAccess('write', $this->object->getRefId())) {
             $this->ctrl->redirectByClass(
                 [get_class($this),'ilobjsearchlucenesettingsformgui'],
                 'readOnly'
             );
         }
 
         $this->ctrl->redirectByClass(
             [get_class($this),'ilobjsearchlucenesettingsformgui'],
             'edit'
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redirectToSettings()

ilObjSearchSettingsGUI::redirectToSettings ( )

protected

Definition at line 121 of file class.ilObjSearchSettingsGUI.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                                            : void
     {
         if (!$this->rbac_system->checkAccess('visible,read', $this->object->getRefId())) {
             $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
         }
 
         $this->tabs_gui->setTabActive('settings');
 
         if (!$this->rbac_system->checkAccess('write', $this->object->getRefId())) {
             $this->ctrl->redirectByClass(
                 [get_class($this),'ilobjsearchsettingsformgui'],
                 'readOnly'
             );
         }
 
         $this->ctrl->redirectByClass(
             [get_class($this),'ilobjsearchsettingsformgui'],
             'edit'
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveAdvancedLuceneSettingsObject()

ilObjSearchSettingsGUI::saveAdvancedLuceneSettingsObject ( )

protected

Definition at line 217 of file class.ilObjSearchSettingsGUI.php.

References ilObjectGUI\$settings, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilLuceneAdvancedSearchFields\getFields(), ilLuceneAdvancedSearchSettings\getInstance(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                                          : void
     {
         if (!$this->access->checkAccess('write', '', $this->object->getRefId())) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
             $this->ctrl->redirect($this, 'settings');
         }
 
         $enabled_md_ids = new SplFixedArray(0);
         if ($this->http->wrapper()->post()->has('fid')) {
             $enabled_md_ids = $this->http->wrapper()->post()->retrieve(
                 'fid',
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string())
             );
         }
 
         $settings = ilLuceneAdvancedSearchSettings::getInstance();
         foreach (ilLuceneAdvancedSearchFields::getFields() as $field => $translation) {
             $settings->setActive($field, in_array($field, (array) $enabled_md_ids));
         }
         $settings->save();
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
         $this->ctrl->redirect($this, 'advancedLuceneSettings');
     }

Here is the call graph for this function:

Field Documentation

◆ $http

GlobalHttpState ilObjSearchSettingsGUI::$http

private

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

◆ $read_only

bool ilObjSearchSettingsGUI::$read_only = true

protected

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

◆ $refinery

Factory ilObjSearchSettingsGUI::$refinery

protected

Definition at line 32 of file class.ilObjSearchSettingsGUI.php.

◆ $src_logger

ilLogger ilObjSearchSettingsGUI::$src_logger

protected

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

◆ $ui

UIServices ilObjSearchSettingsGUI::$ui

protected

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

◆ $user

ilObjUser ilObjSearchSettingsGUI::$user

protected

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

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

components/ILIAS/Search/classes/ObjGUI/class.ilObjSearchSettingsGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ advancedLuceneSettingsObject()

◆ executeCommand()

◆ getAdminTabs()

◆ getTabs()

◆ redirectToLuceneSettings()

◆ redirectToSettings()

◆ saveAdvancedLuceneSettingsObject()

Field Documentation

◆ $http

◆ $read_only

◆ $refinery

◆ $src_logger

◆ $ui

◆ $user