Collaboration diagram for ilObjQuestionPoolSettingsGeneralGUI:

Public Member Functions
	__construct (ilCtrl $ctrl, ilAccessHandler $access, ilLanguage $lng, ilTemplate $tpl, ilTabsGUI $tabs, ilObjQuestionPoolGUI $poolGUI)
	Constructor. More...

	executeCommand ()
	Command Execution. More...

Data Fields
const	CMD_SHOW_FORM = 'showForm'
	command constants More...

const	CMD_SAVE_FORM = 'saveForm'

Protected Member Functions
	formPropertyExists (ilPropertyFormGUI $form, $propertyId)

Protected Attributes
	$ctrl = null

	$access = null

	$lng = null

	$tpl = null

	$tabs = null

	$poolGUI = null

	$poolOBJ = null

Private Member Functions
	showFormCmd (ilPropertyFormGUI $form=null)

	saveFormCmd ()

	performSaveForm (ilPropertyFormGUI $form)

	buildForm ()

	getTaxonomySelectInputOptions ()

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilObjQuestionPoolSettingsGeneralGUI::__construct	(	ilCtrl	$ctrl,
		ilAccessHandler	$access,
		ilLanguage	$lng,
		ilTemplate	$tpl,
		ilTabsGUI	$tabs,
		ilObjQuestionPoolGUI	$poolGUI
	)

Constructor.

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

References $access, $ctrl, $lng, $poolGUI, $tabs, and $tpl.

         {
                 $this->ctrl = $ctrl;
                 $this->access = $access;
                 $this->lng = $lng;
                 $this->tpl = $tpl;
                 $this->tabs = $tabs;
                 
                 $this->poolGUI = $poolGUI;
                 $this->poolOBJ = $poolGUI->object;
         }

Member Function Documentation

◆ buildForm()

ilObjQuestionPoolSettingsGeneralGUI::buildForm ( )

private

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

References ilMD\getGeneral(), getTaxonomySelectInputOptions(), ilObjQuestionPool\isSkillManagementGloballyActivated(), ilCheckboxInputGUI\setChecked(), ilTextAreaInputGUI\setCols(), ilFormPropertyGUI\setInfo(), and ilFormPropertyGUI\setRequired().

Referenced by saveFormCmd(), and showFormCmd().

         {
                 require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
                 $form = new ilPropertyFormGUI();
                 
                 $form->setFormAction($this->ctrl->getFormAction($this));
                 $form->addCommandButton(self::CMD_SAVE_FORM, $this->lng->txt('save'));
                 
                 $form->setTitle($this->lng->txt('qpl_form_general_settings'));
                 $form->setId('properties');
 
                 include_once 'Services/MetaData/classes/class.ilMD.php';
                 $md_obj = new ilMD($this->poolOBJ->getId(), 0, "qpl");
                 $md_section = $md_obj->getGeneral();
 
                 $title = new ilTextInputGUI($this->lng->txt("title"), "title");
                 $title->setRequired(true);
                 $title->setValue($md_section->getTitle());
                 $form->addItem($title);
 
                 $ids = $md_section->getDescriptionIds();
                 if($ids)
                 {
                         $desc_obj = $md_section->getDescription(array_pop($ids));
 
                         $desc = new ilTextAreaInputGUI($this->lng->txt("description"), "description");
                         $desc->setCols(50);
                         $desc->setRows(4);
                         $desc->setValue($desc_obj->getDescription());
                         $form->addItem($desc);
                 }
 
                 // online
                 
                 $online = new ilCheckboxInputGUI($this->lng->txt('qpl_settings_general_form_property_online'), 'online');
                 $online->setInfo($this->lng->txt('qpl_settings_general_form_property_online_description'));
                 $online->setChecked($this->poolOBJ->getOnline());
                 $form->addItem($online);
                 
                 // show taxonomies
                 
                 $showTax = new ilCheckboxInputGUI($this->lng->txt('qpl_settings_general_form_property_show_taxonomies'), 'show_taxonomies');
                 $showTax->setInfo($this->lng->txt('qpl_settings_general_form_prop_show_tax_desc'));
                 $showTax->setChecked($this->poolOBJ->getShowTaxonomies());
                 $form->addItem($showTax);
         
                 $taxSelectOptions = $this->getTaxonomySelectInputOptions();
         
                 // pool navigation taxonomy
 
                         $navTax = new ilSelectInputGUI($this->lng->txt('qpl_settings_general_form_property_nav_taxonomy'), 'nav_taxonomy');
                         $navTax->setInfo($this->lng->txt('qpl_settings_general_form_property_nav_taxonomy_description'));
                         $navTax->setValue($this->poolOBJ->getNavTaxonomyId());
                         $navTax->setOptions($taxSelectOptions);
                 $showTax->addSubItem($navTax);
 
                 // skill service activation
                 
                 if( ilObjQuestionPool::isSkillManagementGloballyActivated() )
                 {
                         $skillService = new ilCheckboxInputGUI($this->lng->txt('tst_activate_skill_service'), 'skill_service');
                         $skillService->setChecked($this->poolOBJ->isSkillServiceEnabled());
                         $form->addItem($skillService);
                 }
                 
                 return $form;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjQuestionPoolSettingsGeneralGUI::executeCommand ( )

Command Execution.

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

References $cmd, and ilUtil\sendInfo().

         {
                 // allow only write access
                 
                 if (!$this->access->checkAccess('write', '', $this->poolGUI->ref_id)) 
                 {
                         ilUtil::sendInfo($this->lng->txt('cannot_edit_question_pool'), true);
                         $this->ctrl->redirectByClass('ilObjQuestionPoolGUI', 'infoScreen');
                 }
                 
                 // activate corresponding tab (auto activation does not work in ilObjTestGUI-Tabs-Salad)
                 
                 $this->tabs->activateTab('settings');
                 
                 // process command
                 
                 $nextClass = $this->ctrl->getNextClass();
                 
                 switch($nextClass)
                 {
                         default:
                                 $cmd = $this->ctrl->getCmd(self::CMD_SHOW_FORM).'Cmd';
                                 $this->$cmd();
                 }
         }

Here is the call graph for this function:

◆ formPropertyExists()

ilObjQuestionPoolSettingsGeneralGUI::formPropertyExists	(	ilPropertyFormGUI	$form,
			$propertyId
	)

protected

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

References ilPropertyFormGUI\getItemByPostVar().

Referenced by performSaveForm().

         {
                 return $form->getItemByPostVar($propertyId) instanceof ilFormPropertyGUI;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTaxonomySelectInputOptions()

ilObjQuestionPoolSettingsGeneralGUI::getTaxonomySelectInputOptions ( )

private

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

References ilObject\_lookupTitle().

Referenced by buildForm().

         {
                 $taxSelectOptions = array(
                         '0' => $this->lng->txt('qpl_settings_general_form_property_opt_notax_selected')
                 );
                 
                 foreach($this->poolOBJ->getTaxonomyIds() as $taxId)
                 {
                         $taxSelectOptions[$taxId] = ilObject::_lookupTitle($taxId);
                 }
                 
                 return $taxSelectOptions;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ performSaveForm()

ilObjQuestionPoolSettingsGeneralGUI::performSaveForm ( ilPropertyFormGUI $form )

private

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

References formPropertyExists(), ilMD\getGeneral(), ilPropertyFormGUI\getItemByPostVar(), ilMDBase\save(), and ilMDBase\update().

Referenced by saveFormCmd().

         {
                 include_once 'Services/MetaData/classes/class.ilMD.php';
                 $md_obj = new ilMD($this->poolOBJ->getId(), 0, "qpl");
                 $md_section = $md_obj->getGeneral();
 
                 // title
                 $md_section->setTitle($form->getItemByPostVar('title')->getValue());
                 $md_section->update();
 
                 // Description
                 $md_desc_ids = $md_section->getDescriptionIds();
                 if ($md_desc_ids)
                 {
                         $md_desc = $md_section->getDescription(array_pop($md_desc_ids));
                         $md_desc->setDescription($form->getItemByPostVar('description')->getValue());
                         $md_desc->update();
                 }
                 else
                 {
                         $md_desc = $md_section->addDescription();
                         $md_desc->setDescription($form->getItemByPostVar('description')->getValue());
                         $md_desc->save();
                 }
 
                 $this->poolOBJ->setTitle($form->getItemByPostVar('title')->getValue());
                 $this->poolOBJ->setDescription($form->getItemByPostVar('description')->getValue());
                 $this->poolOBJ->update();
 
                 $online = $form->getItemByPostVar('online');
                 $this->poolOBJ->setOnline($online->getChecked());
 
                 $showTax = $form->getItemByPostVar('show_taxonomies');
                 $this->poolOBJ->setShowTaxonomies($showTax->getChecked());
                 
                 $navTax = $form->getItemByPostVar('nav_taxonomy');
                 $this->poolOBJ->setNavTaxonomyId($navTax->getValue());
 
                 if( $this->formPropertyExists($form, 'skill_service') )
                 {
                         $skillService = $form->getItemByPostVar('skill_service');
                         $this->poolOBJ->setSkillServiceEnabled($skillService->getChecked());
                 }
                 
                 $this->poolOBJ->saveToDb();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveFormCmd()

ilObjQuestionPoolSettingsGeneralGUI::saveFormCmd ( )

private

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

References $errors, buildForm(), performSaveForm(), ilUtil\sendFailure(), ilUtil\sendSuccess(), and showFormCmd().

         {
                 $form = $this->buildForm();
                 
                 // form validation and initialisation
                 
                 $errors = !$form->checkInput(); // ALWAYS CALL BEFORE setValuesByPost()
                 $form->setValuesByPost(); // NEVER CALL THIS BEFORE checkInput()
 
                 // return to form when any form validation errors exist
                 
                 if($errors)
                 {
                         ilUtil::sendFailure($this->lng->txt('form_input_not_valid'));
                         return $this->showFormCmd($form);
                 }
                 
                 // perform saving the form data
                 
                 $this->performSaveForm($form);
                 
                 // redirect to form output
                 
                 ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);
                 $this->ctrl->redirect($this, self::CMD_SHOW_FORM);
         }

Here is the call graph for this function:

◆ showFormCmd()

ilObjQuestionPoolSettingsGeneralGUI::showFormCmd ( ilPropertyFormGUI $form = null )

private

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

References buildForm().

Referenced by saveFormCmd().

         {
                 if( $form === null )
                 {
                         $form = $this->buildForm();
                 }
                 
                 $this->tpl->setContent( $this->ctrl->getHTML($form) );
         }