Collaboration diagram for ilObjQuestionPoolSettingsGeneralGUI:

Public Member Functions
	__construct (private readonly ilCtrl $ctrl, private readonly ilAccessHandler $access, private readonly ilLanguage $lng, private readonly ilGlobalTemplateInterface $tpl, private readonly ilTabsGUI $tabs, private readonly ilObjQuestionPoolGUI $poolGUI, private readonly Refinery $refinery, private readonly UIFactory $ui_factory, private readonly UIRenderer $ui_renderer, private readonly HttpRequest $http_request,)

	executeCommand ()
	Command Execution. More...

Data Fields
const	CMD_SHOW_GENERAL_FORM = 'showForm'

const	CMD_SAVE_GENERAL_FORM = 'saveForm'

const	TAB_COMMON_SETTINGS = 'settings'

Protected Attributes
ilObjQuestionPool ilObject	$poolOBJ

Private Member Functions
	showFormCmd (?Form $form=null)

	saveFormCmd ()

	performSaveForm ($data)

	buildForm ()

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilObjQuestionPoolSettingsGeneralGUI::__construct	(	private readonly ilCtrl	$ctrl,
		private readonly ilAccessHandler	$access,
		private readonly ilLanguage	$lng,
		private readonly ilGlobalTemplateInterface	$tpl,
		private readonly ilTabsGUI	$tabs,
		private readonly ilObjQuestionPoolGUI	$poolGUI,
		private readonly Refinery	$refinery,
		private readonly UIFactory	$ui_factory,
		private readonly UIRenderer	$ui_renderer,
		private readonly HttpRequest	$http_request
	)

Definition at line 46 of file class.ilObjQuestionPoolSettingsGeneralGUI.php.

       {
         $this->poolOBJ = $poolGUI->getObject();
     }

Member Function Documentation

◆ buildForm()

ilObjQuestionPoolSettingsGeneralGUI::buildForm ( )

private

Definition at line 143 of file class.ilObjQuestionPoolSettingsGeneralGUI.php.

References ILIAS\UI\examples\Layout\Page\Standard\$refinery, ILIAS\Repository\ctrl(), ilObjQuestionPool\isSkillManagementGloballyActivated(), ILIAS\Repository\lng(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by saveFormCmd(), and showFormCmd().

                                 : Form
     {
         $items = [];
 
         $title_and_description = $this->poolOBJ->getObjectProperties()->getPropertyTitleAndDescription()->toForm(
             $this->lng,
             $this->ui_factory->input()->field(),
             $this->refinery
         );
 
         $items['general_settings'] = $this->ui_factory->input()->field()->section(
             [
                 'title_and_description' => $title_and_description
             ],
             $this->lng->txt('qpl_form_general_settings')
         );
 
         $online = $this->poolOBJ->getObjectProperties()->getPropertyIsOnline()->toForm(
             $this->lng,
             $this->ui_factory->input()->field(),
             $this->refinery
         );
         $availability = $this->ui_factory->input()->field()->section(
             ['online' => $online],
             $this->lng->txt('qpl_settings_availability')
         );
         $items['availability'] = $availability;
 
         $timg = $this->poolOBJ->getObjectProperties()->getPropertyTileImage()->toForm(
             $this->lng,
             $this->ui_factory->input()->field(),
             $this->refinery
         );
         $items['display_settings'] = $this->ui_factory->input()->field()->section(
             ['tile_image' => $timg],
             $this->lng->txt('tst_presentation_settings_section')
         );
 
         $additional_features_inputs = [];
 
         if (ilObjQuestionPool::isSkillManagementGloballyActivated()) {
             $additional_features_inputs['skill_service'] = $this->ui_factory->input()->field()->checkbox(
                 $this->lng->txt('tst_activate_skill_service')
             )->withValue($this->poolOBJ->isSkillServiceEnabled());
         }
 
         $items['additional_features'] = $this->ui_factory->input()->field()->section(
             $additional_features_inputs,
             $this->lng->txt('obj_features')
         );
 
         return $this->ui_factory->input()->container()->form()->standard(
             $this->ctrl->getFormAction($this, self::CMD_SAVE_GENERAL_FORM),
             $items
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjQuestionPoolSettingsGeneralGUI::executeCommand ( )

Command Execution.

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

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

                                     : void
     {
         // allow only write access
 
         if (!$this->access->checkAccess('write', '', $this->poolGUI->getRefId())) {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt('cannot_edit_question_pool'), true);
             $this->ctrl->redirectByClass(
                 [
                     ilRepositoryGUI::class,
                     self::class,
                     ilInfoScreenGUI::class
                 ],
                 'showSummary'
             );
         }
 
         $this->tabs->activateTab('settings');
         $this->tabs->activateSubTab('qpl_settings_subtab_general');
 
         // process command
 
         $nextClass = $this->ctrl->getNextClass();
 
         switch ($nextClass) {
             default:
                 $cmd = $this->ctrl->getCmd(self::CMD_SHOW_GENERAL_FORM) . 'Cmd';
                 $this->$cmd();
         }
     }

Here is the call graph for this function:

◆ performSaveForm()

ilObjQuestionPoolSettingsGeneralGUI::performSaveForm ( $data )

private

Definition at line 120 of file class.ilObjQuestionPoolSettingsGeneralGUI.php.

References $data, and null.

Referenced by saveFormCmd().

                                            : void
     {
         $title_and_description = $data['general_settings']['title_and_description'] ?? null;
         if ($title_and_description instanceof ilObjectPropertyTitleAndDescription) {
             $this->poolOBJ->getObjectProperties()->storePropertyTitleAndDescription(
                 $title_and_description
             );
         }
 
         $this->poolOBJ->getObjectProperties()->storePropertyIsOnline(
             $data['availability']['online'] ?? $this->poolOBJ->getObjectProperties()->getPropertyIsOnline()->withOffline()
         );
 
         $display_settings = $data['display_settings'] ?? [];
         if (isset($display_settings['tile_image'])) {
             $this->poolOBJ->getObjectProperties()->storePropertyTileImage($display_settings['tile_image']);
         }
 
         $this->poolOBJ->setSkillServiceEnabled($data['additional_features']['skill_service'] ?? false);
 
         $this->poolOBJ->saveToDb();
     }

Here is the caller graph for this function:

◆ saveFormCmd()

ilObjQuestionPoolSettingsGeneralGUI::saveFormCmd ( )

private

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

References buildForm(), ILIAS\Repository\ctrl(), ILIAS\UI\Implementation\Component\Progress\State\Bar\FAILURE, ILIAS\Repository\lng(), performSaveForm(), and showFormCmd().

                                   : void
     {
         $form = $this->buildForm()->withRequest($this->http_request);
         $result = $form->getInputGroup()->getContent();
 
         if (!$result->isOK()) {
             $this->tpl->setOnScreenMessage(MessageBox::FAILURE, $this->lng->txt('form_input_not_valid'));
             $this->showFormCmd($form);
             return;
         }
 
         $this->performSaveForm($result->value());
         $this->tpl->setOnScreenMessage(MessageBox::SUCCESS, $this->lng->txt("msg_obj_modified"), true);
         $this->ctrl->redirect($this, self::CMD_SHOW_GENERAL_FORM);
 
     }

Here is the call graph for this function:

◆ showFormCmd()

ilObjQuestionPoolSettingsGeneralGUI::showFormCmd ( ?Form $form = null )

private

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

References buildForm(), null, and ILIAS\Repository\tabs().

Referenced by saveFormCmd().

                                                     : void
     {
         $this->tabs->activateSubTab(self::TAB_COMMON_SETTINGS);
         if ($form === null) {
             $form = $this->buildForm();
         }
         $this->tpl->setContent($this->ui_renderer->render($form));
     }