Collaboration diagram for ilObjSearchLuceneSettingsFormGUI:

Public Member Functions
	__construct (GlobalHttpState $http, ilCtrlInterface $ctrl, ilLanguage $lng, UIServices $ui, RefFactory $refinery, ilObjUser $user, ilObjSearchRpcClientCoordinator $coordinator)

	executeCommand ()

Protected Member Functions
	showForm (bool $read_only, bool $get_from_post=false)

	update ()

	showPermissionDenied ()

	initForm (bool $read_only)

	getSettings ()

Protected Attributes
GlobalHttpState	$http

ilCtrlInterface	$ctrl

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

Factory	$factory

Renderer	$renderer

RefFactory	$refinery

ilObjUser	$user

ilObjSearchRpcClientCoordinator	$coordinator

Detailed Description

Author: Tim Schmitz schmi.nosp@m.tz@l.nosp@m.eifos.nosp@m..com

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

Constructor & Destructor Documentation

◆ __construct()

ilObjSearchLuceneSettingsFormGUI::__construct	(	GlobalHttpState	$http,
		ilCtrlInterface	$ctrl,
		ilLanguage	$lng,
		UIServices	$ui,
		RefFactory	$refinery,
		ilObjUser	$user,
		ilObjSearchRpcClientCoordinator	$coordinator
	)

Definition at line 44 of file class.ilObjSearchLuceneSettingsFormGUI.php.

References $coordinator, $ctrl, $http, $lng, $refinery, $user, ILIAS\Repository\ctrl(), ILIAS\DI\UIServices\factory(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\DI\UIServices\mainTemplate(), ILIAS\Repository\refinery(), ILIAS\DI\UIServices\renderer(), and ILIAS\Repository\user().

       {
         $this->http = $http;
         $this->ctrl = $ctrl;
         $this->lng = $lng;
         $this->tpl = $ui->mainTemplate();
         $this->factory = $ui->factory();
         $this->renderer = $ui->renderer();
         $this->refinery = $refinery;
         $this->user = $user;
         $this->coordinator = $coordinator;
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilObjSearchLuceneSettingsFormGUI::executeCommand ( )

Definition at line 64 of file class.ilObjSearchLuceneSettingsFormGUI.php.

References ILIAS\Repository\ctrl(), showForm(), showPermissionDenied(), and update().

                                     : void
     {
         $cmd = $this->ctrl->getCmd();
 
         switch ($cmd) {
             case 'readOnly':
                 $this->showForm(true);
                 break;
 
             case 'edit':
                 $this->showForm(false);
                 break;
 
             case 'permDenied':
                 $this->showPermissionDenied();
                 break;
 
             case 'update':
                 $this->update();
                 break;
 
             default:
                 throw new ilObjSearchSettingsGUIException(
                     'Invalid command for ilObjSearchLuceneSettingsFormGUI: ' . $cmd
                 );
         }
     }

Here is the call graph for this function:

◆ getSettings()

ilObjSearchLuceneSettingsFormGUI::getSettings ( )

protected

Definition at line 276 of file class.ilObjSearchLuceneSettingsFormGUI.php.

References ilSearchSettings\getInstance().

Referenced by initForm(), and update().

                                     : ilSearchSettings
     {
         return ilSearchSettings::getInstance();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initForm()

ilObjSearchLuceneSettingsFormGUI::initForm ( bool $read_only )

protected

TODO: Split up the form into two or three sections.

Definition at line 153 of file class.ilObjSearchLuceneSettingsFormGUI.php.

References ILIAS\LTI\ToolProvider\$settings, ILIAS\Repository\ctrl(), ilSearchSettings\getLuceneMimeFilterDefinitions(), getSettings(), IL_CAL_UNIX, ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\user(), ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by showForm(), and update().

                                                 : StandardForm
     {
         $settings = $this->getSettings();
         $field_factory = $this->factory->input()->field();
 
         // Item filter
         $filter = $settings->getLuceneMimeFilter();
         $checks = [];
         foreach (ilSearchSettings::getLuceneMimeFilterDefinitions() as $mime => $def) {
             $checks[$mime] = $field_factory->checkbox(
                 $this->lng->txt($def['trans'])
             )->withValue(isset($filter[$mime]) && $filter[$mime]);
         }
 
         $item_filter = $field_factory->optionalGroup(
             $checks,
             $this->lng->txt('search_mime_filter_form'),
             $this->lng->txt('search_mime_filter_form_info')
         );
         if (!$settings->isLuceneMimeFilterEnabled()) {
             $item_filter = $item_filter->withValue(null);
         }
 
         // Prefix
         $prefix = $field_factory->checkbox(
             $this->lng->txt('lucene_prefix_wildcard'),
             $this->lng->txt('lucene_prefix_wildcard_info')
         )->withValue($settings->isPrefixWildcardQueryEnabled());
 
         // Number of fragments
         $frag_count = $field_factory->numeric(
             $this->lng->txt('lucene_num_fragments'),
             $this->lng->txt('lucene_num_frag_info')
         )->withValue($settings->getFragmentCount())
          ->withRequired(true)
          ->withAdditionalTransformation(
              $this->refinery->int()->isLessThanOrEqual(10)
          )->withAdditionalTransformation(
              $this->refinery->int()->isGreaterThanOrEqual(1)
          );
 
         // Size of fragments
         $frag_size = $field_factory->numeric(
             $this->lng->txt('lucene_size_fragments'),
             $this->lng->txt('lucene_size_frag_info')
         )->withValue($settings->getFragmentSize())
          ->withRequired(true)
          ->withAdditionalTransformation(
              $this->refinery->int()->isLessThanOrEqual(1000)
          )->withAdditionalTransformation(
              $this->refinery->int()->isGreaterThanOrEqual(10)
          );
 
         // Number of sub-items
         $max_sub = $field_factory->numeric(
             $this->lng->txt('lucene_max_sub'),
             $this->lng->txt('lucene_max_sub_info')
         )->withValue($settings->getMaxSubitems())
          ->withRequired(true)
          ->withAdditionalTransformation(
              $this->refinery->int()->isLessThanOrEqual(10)
          )->withAdditionalTransformation(
              $this->refinery->int()->isGreaterThanOrEqual(1)
          );
 
         // Relevance
         $subrel = $field_factory->checkbox(
             $this->lng->txt('lucene_show_sub_relevance')
         )->withValue($settings->isSubRelevanceVisible());
 
         $relevance = $field_factory->optionalGroup(
             ['subrelevance' => $subrel],
             $this->lng->txt('lucene_relevance'),
             $this->lng->txt('lucene_show_relevance_info')
         );
         if (!$settings->isRelevanceVisible()) {
             $relevance = $relevance->withValue(null);
         }
 
         // Last Index
         $timezone = $this->user->getTimeZone();
         $datetime = new DateTime(
             '@' . $settings->getLastIndexTime()->get(IL_CAL_UNIX)
         );
         $datetime->setTimezone(new DateTimeZone($timezone));
         $last_index = $field_factory->dateTime(
             $this->lng->txt('lucene_last_index_time'),
             $this->lng->txt('lucene_last_index_time_info')
         )->withRequired(true)
          ->withUseTime(true)
          ->withTimezone($timezone);
         $last_index = $last_index->withValue(
             $datetime->format($last_index->getFormat()->toString() . ' H:i')
         );
 
         $section = $this->factory->input()->field()->section(
             [
                 'mime' => $item_filter,
                 'prefix' => $prefix,
                 'fragmentCount' => $frag_count,
                 'fragmentSize' => $frag_size,
                 'maxSubitems' => $max_sub,
                 'relevance' => $relevance,
                 'last_index' => $last_index
             ],
             $this->lng->txt('lucene_settings_title')
         )->withDisabled($read_only);
 
         if ($read_only) {
             $action = $this->ctrl->getFormAction($this, 'permDenied');
         } else {
             $action = $this->ctrl->getFormAction($this, 'update');
         }
 
         return $this->factory->input()->container()->form()->standard(
             $action,
             ['section' => $section]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showForm()

ilObjSearchLuceneSettingsFormGUI::showForm	(	bool	$read_only,
		bool	$get_from_post = `false`
	)

protected

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

References ILIAS\FileDelivery\http(), and initForm().

Referenced by executeCommand(), and update().

      : void {
         $form = $this->initForm($read_only);
         if ($get_from_post) {
             $form = $form->withRequest($this->http->request());
         }
         $this->tpl->setContent($this->renderer->render($form));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showPermissionDenied()

ilObjSearchLuceneSettingsFormGUI::showPermissionDenied ( )

protected

Definition at line 147 of file class.ilObjSearchLuceneSettingsFormGUI.php.

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

Referenced by executeCommand().

                                              : void
     {
         $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
         $this->ctrl->redirect($this, 'readOnly');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilObjSearchLuceneSettingsFormGUI::update ( )

protected

Definition at line 103 of file class.ilObjSearchLuceneSettingsFormGUI.php.

References $data, ILIAS\LTI\ToolProvider\$settings, ilSession\clear(), ILIAS\Repository\ctrl(), getSettings(), ILIAS\FileDelivery\http(), IL_CAL_UNIX, initForm(), ILIAS\Repository\lng(), and showForm().

Referenced by executeCommand().

                                : void
     {
         $form = $this->initForm(false)
                      ->withRequest($this->http->request());
 
         if (!$form->getData()) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('err_check_input'));
             $this->showForm(false, true);
             return;
         }
 
         $settings = $this->getSettings();
         $data = $form->getData()['section'];
 
         $settings->setFragmentCount((int) $data['fragmentCount']);
         $settings->setFragmentSize((int) $data['fragmentSize']);
         $settings->setMaxSubitems((int) $data['maxSubitems']);
         $settings->showRelevance((bool) $data['relevance']);
         $settings->enableLuceneMimeFilter(!is_null($data['mime']));
         if (!is_null($data['mime'])) {
             $settings->setLuceneMimeFilter((array) $data['mime']);
         }
         $settings->showSubRelevance((bool) ($data['relevance']['subrelevance'] ?? false));
         $settings->enablePrefixWildcardQuery((bool) $data['prefix']);
         $settings->setLastIndexTime(new ilDateTime(
             $data['last_index']->getTimestamp(),
             IL_CAL_UNIX
         ));
         $settings->update();
 
         // refresh lucene server
         try {
             if ($settings->enabledLucene()) {
                 $this->coordinator->refreshLuceneSettings();
             }
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
             ilSession::clear('search_last_class');
             $this->ctrl->redirect($this, 'edit');
         } catch (Exception $exception) {
             $this->tpl->setOnScreenMessage('failure', $exception->getMessage());
             $this->showForm(false);
         }
     }