ilObjStudyProgrammeSettingsGUI: ilStudyProgrammeCommonSettingsGUI More...

Collaboration diagram for ilObjStudyProgrammeSettingsGUI:

Public Member Functions
	__construct (ilGlobalTemplateInterface $tpl, ilCtrl $ilCtrl, ilLanguage $lng, Factory $input_factory, Renderer $renderer, Psr\Http\Message\ServerRequestInterface $request, ILIAS\Refinery\Factory $refinery_factory, ILIAS\Data\Factory $data_factory, ilStudyProgrammeTypeRepository $type_repository, ilStudyProgrammeCommonSettingsGUI $common_settings_gui, ilTabsGUI $tabs, ILIAS\HTTP\Wrapper\RequestWrapper $request_wrapper)

	setRefId (int $ref_id)

	executeCommand ()

Data Fields
const	PROP_TITLE = "title"

const	PROP_DESC = "desc"

const	PROP_DEADLINE = "deadline"

const	PROP_VALIDITY_OF_QUALIFICATION = "validity_qualification"

const	OPT_NO_DEADLINE = 'opt_no_deadline'

const	OPT_DEADLINE_PERIOD = "opt_deadline_period"

const	OPT_DEADLINE_DATE = "opt_deadline_date"

const	OPT_NO_VALIDITY_OF_QUALIFICATION = 'opt_no_validity_qualification'

const	OPT_VALIDITY_OF_QUALIFICATION_PERIOD = "opt_validity_qualification_period"

const	OPT_VALIDITY_OF_QUALIFICATION_DATE = "opt_validity_qualification_date"

Protected Member Functions
	view ()

	update ()

	buildModalHeading (string $label, bool $current_node)

	buildForm (ilObjStudyProgramme $prg, string $submit_action)

	buildFormElements (InputFieldFactory $ff, ilObjectTranslation $trans, array $sp_types, ilStudyProgrammeSettings $settings)

	getEditSection (InputFieldFactory $ff, ilObjectTranslation $trans)

	getObject ()

	txt (string $code)

Protected Attributes
ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilLanguage	$lng

ILIAS UI Component Input Factory	$input_factory

ILIAS UI Renderer	$renderer

Psr Http Message ServerRequestInterface	$request

ILIAS Refinery Factory	$refinery_factory

ILIAS Data Factory	$data_factory

ilStudyProgrammeTypeRepository	$type_repository

ilStudyProgrammeCommonSettingsGUI	$common_settings_gui

ilTabsGUI	$tabs

ILIAS HTTP Wrapper RequestWrapper	$request_wrapper

ilObjStudyProgramme	$object

string	$tmp_heading

int	$ref_id

Private Attributes
const	TAB_SETTINGS = 'settings'

const	TAB_COMMON_SETTINGS = 'commonSettings'

Detailed Description

ilObjStudyProgrammeSettingsGUI: ilStudyProgrammeCommonSettingsGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjStudyProgrammeSettingsGUI::__construct	(	ilGlobalTemplateInterface	$tpl,
		ilCtrl	$ilCtrl,
		ilLanguage	$lng,
		Factory	$input_factory,
		Renderer	$renderer,
		Psr\Http\Message\ServerRequestInterface	$request,
		ILIAS\Refinery\Factory	$refinery_factory,
		ILIAS\Data\Factory	$data_factory,
		ilStudyProgrammeTypeRepository	$type_repository,
		ilStudyProgrammeCommonSettingsGUI	$common_settings_gui,
		ilTabsGUI	$tabs,
		ILIAS\HTTP\Wrapper\RequestWrapper	$request_wrapper
	)

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

References $common_settings_gui, $data_factory, $input_factory, $lng, $refinery_factory, $renderer, $request, $request_wrapper, $tabs, $tpl, $type_repository, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), and ILIAS\Repository\tabs().

       {
         $this->tpl = $tpl;
         $this->ctrl = $ilCtrl;
         $this->lng = $lng;
         $this->input_factory = $input_factory;
         $this->renderer = $renderer;
         $this->request = $request;
         $this->refinery_factory = $refinery_factory;
         $this->data_factory = $data_factory;
         $this->type_repository = $type_repository;
         $this->common_settings_gui = $common_settings_gui;
         $this->tabs = $tabs;
         $this->request_wrapper = $request_wrapper;
 
         $this->object = null;
 
         $lng->loadLanguageModule("prg");
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildForm()

ilObjStudyProgrammeSettingsGUI::buildForm	(	ilObjStudyProgramme	$prg,
		string	$submit_action
	)

protected

Definition at line 221 of file class.ilObjStudyProgrammeSettingsGUI.php.

References ILIAS\LTI\ToolProvider\$settings, buildFormElements(), ilContainer\getObjectTranslation(), ilObjStudyProgramme\getSettings(), ilObject\setDescription(), ilObject\setTitle(), ilObjStudyProgramme\updateCustomIcon(), and ilObjStudyProgramme\updateSettings().

Referenced by view().

      : ILIAS\UI\Component\Input\Container\Form\Form {
         $trans = $prg->getObjectTranslation();
         $ff = $this->input_factory->field();
         $sp_types = $this->type_repository->getAllTypesArray();
         $settings = $prg->getSettings();
 
         return $this->input_factory->container()->form()->standard(
             $submit_action,
             $this->buildFormElements(
                 $ff,
                 $trans,
                 $sp_types,
                 $settings
             )
         )->withAdditionalTransformation(
             $this->refinery_factory->custom()->transformation(
                 function ($values) use ($prg) {
                     $object_data = $values[0];
                     $prg->setTitle($object_data[self::PROP_TITLE]);
                     $prg->setDescription($object_data[self::PROP_DESC]);
 
                     $settings = $prg->getSettings()
                         ->withAssessmentSettings($values['prg_assessment'])
                         ->withDeadlineSettings($values['prg_deadline'])
                         ->withValidityOfQualificationSettings($values['prg_validity_of_qualification'])
                         ->withAutoMailSettings($values['automail_settings'])
                         ->withTypeSettings($values['prg_type']);
 
                     $prg->updateSettings($settings);
                     $prg->updateCustomIcon();
                     return $prg;
                 }
             )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildFormElements()

ilObjStudyProgrammeSettingsGUI::buildFormElements	(	InputFieldFactory	$ff,
		ilObjectTranslation	$trans,
		array	$sp_types,
		ilStudyProgrammeSettings	$settings
	)

protected

Definition at line 260 of file class.ilObjStudyProgrammeSettingsGUI.php.

References ilStudyProgrammeSettings\getAssessmentSettings(), ilStudyProgrammeSettings\getAutoMailSettings(), ilStudyProgrammeSettings\getDeadlineSettings(), getEditSection(), ilStudyProgrammeSettings\getTypeSettings(), ilStudyProgrammeSettings\getValidityOfQualificationSettings(), and ILIAS\Repository\lng().

Referenced by buildForm().

      : array {
         $return = [
             $this->getEditSection($ff, $trans),
             "prg_type" => $settings
                 ->getTypeSettings()
                 ->toFormInput($ff, $this->lng, $this->refinery_factory, $sp_types)
             ,
             "prg_assessment" => $settings
                 ->getAssessmentSettings()
                 ->toFormInput($ff, $this->lng, $this->refinery_factory)
             ,
             "prg_deadline" => $settings
                 ->getDeadlineSettings()
                 ->toFormInput($ff, $this->lng, $this->refinery_factory, $this->data_factory)
             ,
             "prg_validity_of_qualification" => $settings
                 ->getValidityOfQualificationSettings()
                 ->toFormInput($ff, $this->lng, $this->refinery_factory, $this->data_factory)
             ,
             "automail_settings" => $settings
                 ->getAutoMailSettings()
                 ->toFormInput($ff, $this->lng, $this->refinery_factory)
         ];
 
         return $return;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildModalHeading()

ilObjStudyProgrammeSettingsGUI::buildModalHeading	(	string	$label,
		bool	$current_node
	)

protected

Definition at line 195 of file class.ilObjStudyProgrammeSettingsGUI.php.

References ILIAS\Repository\ctrl(), and ilLinkButton\getInstance().

Referenced by view().

                                                                            : void
     {
         if (!$current_node) {
             $this->ctrl->saveParameterByClass('ilobjstudyprogrammesettingsgui', 'ref_id');
             $heading_button = ilLinkButton::getInstance();
             $heading_button->setCaption('prg_open_node');
             $heading_button->setUrl(
                 $this->ctrl->getLinkTargetByClass(
                     'ilobjstudyprogrammetreegui',
                     'view'
                 )
             );
 
             $heading =
                 "<div class=''>" .
                 $label .
                 "<div class='pull-right'>" .
                 $heading_button->render() .
                 "</div></div>"
             ;
             $this->tmp_heading = $heading;
         } else {
             $this->tmp_heading = "<div class=''>" . $label . "</div>";
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjStudyProgrammeSettingsGUI::executeCommand ( )

Definition at line 101 of file class.ilObjStudyProgrammeSettingsGUI.php.

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

                                     : void
     {
         $next_class = $this->ctrl->getNextClass();
         switch ($next_class) {
             case 'ilstudyprogrammecommonsettingsgui':
                 $this->tabs->activateSubTab(self::TAB_COMMON_SETTINGS);
                 $this->common_settings_gui->setObject($this->getObject());
                 $content = $this->ctrl->forwardCommand($this->common_settings_gui);
                 break;
             default:
                 $cmd = $this->ctrl->getCmd();
                 if ($cmd === "" || $cmd === null) {
                     $cmd = "view";
                 }
                 switch ($cmd) {
                     case "view":
                         $content = $this->view();
                         break;
                     case "update":
                         $content = $this->$cmd();
                         break;
                     default:
                         throw new ilException(
                             "ilObjStudyProgrammeSettingsGUI: Command not supported: $cmd"
                         );
                 }
         }
 
         if (!$this->ctrl->isAsynch()) {
             $this->tpl->setContent($content);
         } else {
             $output_handler = new ilAsyncOutputHandler();
             $heading = $this->tmp_heading ?? $this->lng->txt("prg_async_" . $this->ctrl->getCmd());
             $output_handler->setHeading($heading);
             $output_handler->setContent($content);
             $output_handler->terminate();
         }
     }

Here is the call graph for this function:

◆ getEditSection()

ilObjStudyProgrammeSettingsGUI::getEditSection	(	InputFieldFactory	$ff,
		ilObjectTranslation	$trans
	)

protected

Definition at line 292 of file class.ilObjStudyProgrammeSettingsGUI.php.

References $lang, ilMDLanguageItem\_getLanguages(), ILIAS\Repository\ctrl(), ilObjectTranslation\getDefaultDescription(), ilObjectTranslation\getDefaultLanguage(), ilObjectTranslation\getDefaultTitle(), txt(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by buildFormElements().

      : ILIAS\UI\Component\Input\Field\Section {
         $languages = ilMDLanguageItem::_getLanguages();
         $lang = array_key_exists($trans->getDefaultLanguage(), $languages) ? $languages[$trans->getDefaultLanguage()] : '?';
         return $ff->section(
             [
                 self::PROP_TITLE =>
                     $ff->text($this->txt("title"))
                        ->withValue($trans->getDefaultTitle())
                        ->withRequired(true),
                 self::PROP_DESC =>
                     $ff->textarea($this->txt("description"))
                        ->withValue($trans->getDefaultDescription() ?? "")
             ],
             $this->txt("prg_edit"),
             $this->txt("language") . ": " . $lang .
             ' <a href="' . $this->ctrl->getLinkTargetByClass("ilobjecttranslationgui", "") .
             '">&raquo; ' . $this->txt("obj_more_translations") . '</a>'
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObject()

ilObjStudyProgrammeSettingsGUI::getObject ( )

protected

Definition at line 315 of file class.ilObjStudyProgrammeSettingsGUI.php.

References $object, and ilObjStudyProgramme\getInstanceByRefId().

Referenced by executeCommand(), update(), and view().

                                   : ilObjStudyProgramme
     {
         if ($this->object === null) {
             $this->object = ilObjStudyProgramme::getInstanceByRefId($this->ref_id);
         }
         return $this->object;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRefId()

ilObjStudyProgrammeSettingsGUI::setRefId ( int $ref_id )

Definition at line 96 of file class.ilObjStudyProgrammeSettingsGUI.php.

References $ref_id.

                                          : void
     {
         $this->ref_id = $ref_id;
     }

◆ txt()

ilObjStudyProgrammeSettingsGUI::txt ( string $code )

protected

Definition at line 323 of file class.ilObjStudyProgrammeSettingsGUI.php.

References ILIAS\Repository\lng().

Referenced by getEditSection().

                                         : string
     {
         return $this->lng->txt($code);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilObjStudyProgrammeSettingsGUI::update ( )

protected

Returns: string|void

Definition at line 154 of file class.ilObjStudyProgrammeSettingsGUI.php.

References $response, ILIAS\Repository\ctrl(), ilAsyncOutputHandler\encodeAsyncResponse(), getObject(), ilAsyncOutputHandler\handleAsyncOutput(), and ILIAS\Repository\lng().

     {
         $form = $this
             ->buildForm($this->getObject(), $this->ctrl->getFormAction($this, "update"))
             ->withRequest($this->request);
 
         $result = $form->getInputGroup()->getContent();
 
         // This could further be improved by providing a new container for async-forms in the
         // UI-Framework.
 
         if ($result->isOK()) {
             $result->value()->update();
             $this->tpl->setOnScreenMessage("success", $this->lng->txt("msg_obj_modified"), true);
 
             if ($this->ctrl->isAsynch()) {
                 $response = ilAsyncOutputHandler::encodeAsyncResponse(
                     array(
                     "success" => true,
                     "message" => $this->lng->txt("msg_obj_modified"))
                 );
                 return ilAsyncOutputHandler::handleAsyncOutput($this->renderer->render($form), $response, false);
             }
 
             $this->ctrl->redirect($this);
         } else {
             $this->tpl->setOnScreenMessage("failure", $this->lng->txt("msg_form_save_error"));
 
             if ($this->ctrl->isAsynch()) {
                 $response = ilAsyncOutputHandler::encodeAsyncResponse(
                     array(
                     "success" => false,
                     "errors" => $form->getError())
                 );
                 return ilAsyncOutputHandler::handleAsyncOutput($this->renderer->render($form), $response, false);
             }
 
             return $this->renderer->render($form);
         }
     }

Here is the call graph for this function:

◆ view()

ilObjStudyProgrammeSettingsGUI::view ( )

protected

Definition at line 140 of file class.ilObjStudyProgrammeSettingsGUI.php.

References buildForm(), buildModalHeading(), ILIAS\Repository\ctrl(), getObject(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                              : string
     {
         $this->buildModalHeading(
             $this->lng->txt('prg_async_settings'),
             $this->request_wrapper->has("currentNode")
         );
 
         $form = $this->buildForm($this->getObject(), $this->ctrl->getFormAction($this, "update"));
         return $this->renderer->render($form);
     }