Class ilObjStudyProgrammeSettingsGUI. More...

Collaboration diagram for ilObjStudyProgrammeSettingsGUI:

Public Member Functions
	__construct ($a_parent_gui, $a_ref_id)

	executeCommand ()

Data Fields
	$ctrl

	$tpl

	$object

	$ilias

	$lng

const	PROP_TITLE = "title"

const	PROP_DESC = "desc"

const	PROP_TYPE = "type"

const	PROP_POINTS = "points"

const	PROP_STATUS = "status"

Protected Member Functions
	view ()

	update ()

	cancel ()

	buildModalHeading ($label, $current_node)

	buildForm ()

	getObject ()

	fillForm ($a_form)

	checkForm ($a_form)

	updateFromFrom ($a_form)

Static Protected Member Functions
static	getStatusOptions ()

Protected Attributes
	$ilAccess

	$ilLog

	$parent_gui

	$tmp_heading

Detailed Description

Class ilObjStudyProgrammeSettingsGUI.

Author: : Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

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

Constructor & Destructor Documentation

◆ __construct()

ilObjStudyProgrammeSettingsGUI::__construct	(	$a_parent_gui,
		$a_ref_id
	)

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

References $DIC, $ilAccess, $ilCtrl, $ilias, $ilLog, $lng, and $tpl.

     {
         global $DIC;
         $tpl = $DIC['tpl'];
         $ilCtrl = $DIC['ilCtrl'];
         $ilAccess = $DIC['ilAccess'];
         $ilToolbar = $DIC['ilToolbar'];
         $ilLocator = $DIC['ilLocator'];
         $tree = $DIC['tree'];
         $lng = $DIC['lng'];
         $ilLog = $DIC['ilLog'];
         $ilias = $DIC['ilias'];
 
         $this->parent_gui = $a_parent_gui;
         $this->ref_id = $a_ref_id;
         $this->parent_gui = $a_parent_gui;
 
         $this->tpl = $tpl;
         $this->ctrl = $ilCtrl;
         $this->ilAccess = $ilAccess;
         $this->ilLocator = $ilLocator;
         $this->tree = $tree;
         $this->toolbar = $ilToolbar;
         $this->ilLog = $ilLog;
         $this->ilias = $ilias;
         $this->lng = $lng;
         
         $this->object = null;
 
         $lng->loadLanguageModule("prg");
     }

Member Function Documentation

◆ buildForm()

ilObjStudyProgrammeSettingsGUI::buildForm ( )

protected

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

References $form, $header, ilStudyProgrammeType\getAllTypesArray(), ilNumberInputGUI\setMinValue(), ilSelectInputGUI\setOptions(), and ilFormPropertyGUI\setRequired().

Referenced by update(), and view().

     {
         $form = new ilAsyncPropertyFormGUI();
 
         if (!$this->ctrl->isAsynch()) {
             $form->setAsync(false);
         }
 
         $form->setFormAction($this->ctrl->getFormAction($this));
         
         $header = new ilFormSectionHeaderGUI();
         $header->setTitle($this->lng->txt("prg_edit"));
         $form->addItem($header);
         
         $item = new ilTextInputGUI($this->lng->txt("title"), self::PROP_TITLE);
         $item->setRequired(true);
         $form->addItem($item);
         
         $item = new ilTextAreaInputGUI($this->lng->txt("description"), self::PROP_DESC);
         $form->addItem($item);
         
         $header = new ilFormSectionHeaderGUI();
         $header->setTitle($this->lng->txt("prg_type"));
         $form->addItem($header);
         
         $item = new ilSelectInputGUI($this->lng->txt("type"), self::PROP_TYPE);
         $item->setOptions(ilStudyProgrammeType::getAllTypesArray());
         $form->addItem($item);
         
         $header = new ilFormSectionHeaderGUI();
         $header->setTitle($this->lng->txt("prg_assessment"));
         $form->addItem($header);
         
         $item = new ilNumberInputGUI($this->lng->txt("prg_points"), self::PROP_POINTS);
         $item->setMinValue(0);
         $form->addItem($item);
         
         $item = new ilSelectInputGUI($this->lng->txt("prg_status"), self::PROP_STATUS);
         $item->setOptions(self::getStatusOptions());
         $form->addItem($item);
         
         $form->addCommandButton("update", $this->lng->txt("save"));
         $form->addCommandButton("cancel", $this->lng->txt("cancel"));
         
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildModalHeading()

ilObjStudyProgrammeSettingsGUI::buildModalHeading	(	$label,
		$current_node
	)

protected

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

References ilLinkButton\getInstance().

Referenced by view().

     {
         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:

◆ cancel()

ilObjStudyProgrammeSettingsGUI::cancel ( )

protected

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

References ilAsyncOutputHandler\encodeAsyncResponse(), and ilAsyncOutputHandler\handleAsyncOutput().

     {
         ilAsyncOutputHandler::handleAsyncOutput(ilAsyncOutputHandler::encodeAsyncResponse());
 
         $this->ctrl->redirect($this->parent_gui);
     }

Here is the call graph for this function:

◆ checkForm()

ilObjStudyProgrammeSettingsGUI::checkForm ( $a_form )

protected

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

Referenced by update().

     {
         if (!$a_form->checkInput()) {
             return false;
         }
         return true;
     }

Here is the caller graph for this function:

◆ executeCommand()

ilObjStudyProgrammeSettingsGUI::executeCommand ( )

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

References $tmp_heading.

     {
         $cmd = $this->ctrl->getCmd();
 
         
         if ($cmd == "") {
             $cmd = "view";
         }
         
         switch ($cmd) {
             case "view":
             case "update":
             case "cancel":
                 $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->lng->txt("prg_async_" . $this->ctrl->getCmd());
             if (isset($this->tmp_heading)) {
                 $heading = $this->tmp_heading;
             }
             $output_handler->setHeading($heading);
             $output_handler->setContent($content);
             $output_handler->terminate();
         }
     }

◆ fillForm()

ilObjStudyProgrammeSettingsGUI::fillForm ( $a_form )

protected

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

References array, and getObject().

Referenced by view().

     {
         $obj = $this->getObject();
         
         $a_form->setValuesByArray(array( self::PROP_TITLE => $obj->getTitle()
             , self::PROP_DESC => $obj->getDescription()
             , self::PROP_TYPE => $obj->getSubtypeId()
             , self::PROP_POINTS => $obj->getPoints()
             , self::PROP_STATUS => $obj->getStatus()
             ));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObject()

ilObjStudyProgrammeSettingsGUI::getObject ( )

protected

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

References $object, and ilObjStudyProgramme\getInstanceByRefId().

Referenced by fillForm(), and updateFromFrom().

     {
         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:

◆ getStatusOptions()

static ilObjStudyProgrammeSettingsGUI::getStatusOptions ( )

staticprotected

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

References $DIC, $lng, array, ilStudyProgramme\STATUS_ACTIVE, ilStudyProgramme\STATUS_DRAFT, and ilStudyProgramme\STATUS_OUTDATED.

     {
         global $DIC;
         $lng = $DIC['lng'];
         
         return array( ilStudyProgramme::STATUS_DRAFT
                         => $lng->txt("prg_status_draft")
                     , ilStudyProgramme::STATUS_ACTIVE
                         => $lng->txt("prg_status_active")
                     , ilStudyProgramme::STATUS_OUTDATED
                         => $lng->txt("prg_status_outdated")
                     );
     }

◆ update()

ilObjStudyProgrammeSettingsGUI::update ( )

protected

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

References $form, $response, array, buildForm(), checkForm(), ilAsyncOutputHandler\encodeAsyncResponse(), ilAsyncOutputHandler\handleAsyncOutput(), ilUtil\sendFailure(), ilUtil\sendSuccess(), and updateFromFrom().

     {
         $form = $this->buildForm();
         $form->setValuesByPost();
         $update_possible = $this->checkForm($form);
 
         if ($update_possible) {
             $this->updateFromFrom($form);
             ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);
             $response = ilAsyncOutputHandler::encodeAsyncResponse(array("success"=>true, "message"=>$this->lng->txt("msg_obj_modified")));
         } else {
             // TODO:
             ilUtil::sendFailure($this->lng->txt("msg_form_save_error"));
             $response = ilAsyncOutputHandler::encodeAsyncResponse(array("success"=>false, "errors"=>$form->getErrors()));
         }
 
         if ($this->ctrl->isAsynch()) {
             return ilAsyncOutputHandler::handleAsyncOutput($form->getHTML(), $response, false);
         } else {
             if ($update_possible) {
                 $this->ctrl->redirect($this);
             } else {
                 return $form->getHTML();
             }
         }
     }

Here is the call graph for this function:

◆ updateFromFrom()

ilObjStudyProgrammeSettingsGUI::updateFromFrom ( $a_form )

protected

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

References getObject().

Referenced by update().

     {
         $obj = $this->getObject();
         
         $obj->setTitle($a_form->getItemByPostVar(self::PROP_TITLE)->getValue());
         $obj->setDescription($a_form->getItemByPostVar(self::PROP_DESC)->getValue());
 
         if ($obj->getSubtypeId() != $a_form->getItemByPostVar(self::PROP_TYPE)->getValue()) {
             $obj->setSubtypeId($a_form->getItemByPostVar(self::PROP_TYPE)->getValue());
             $obj->updateCustomIcon();
             $this->parent_gui->setTitleAndDescription();
         }
 
         $obj->setPoints($a_form->getItemByPostVar(self::PROP_POINTS)->getValue());
         $obj->setStatus($a_form->getItemByPostVar(self::PROP_STATUS)->getValue());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ view()

ilObjStudyProgrammeSettingsGUI::view ( )

protected

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

References $_GET, $form, buildForm(), buildModalHeading(), and fillForm().

     {
         $this->buildModalHeading($this->lng->txt('prg_async_settings'), isset($_GET["currentNode"]));
 
         $form = $this->buildForm();
         $this->fillForm($form);
         return $form->getHTML();
     }