Collaboration diagram for ilStudyProgrammeChangeExpireDateGUI:

Public Member Functions
	__construct (ilCtrl $ctrl, ilGlobalTemplateInterface $tpl, ilLanguage $lng, ilAccess $access, ilObjUser $user, Factory $input_factory, Renderer $renderer, Psr\Http\Message\ServerRequestInterface $request, ILIAS\Refinery\Factory $refinery_factory, ILIAS\Data\Factory $data_factory, ilPRGMessagePrinter $messages)

	executeCommand ()

	setBackTarget (string $target)

	setProgressIds (array $progress_ids)

	setRefId (int $ref_id)

Protected Member Functions
	showExpireDateConfig ()

	buildForm (ilObjStudyProgramme $prg, string $submit_action)

	getValidityOfQualificationSubForm (ilObjStudyProgramme $prg)

	buildFormElements (ILIAS\UI\Component\Input\Field\Factory $ff, Closure $txt, ilObjStudyProgramme $prg)

	changeExpireDate ()

	getBackTarget ()

	getProgressIds ()

	getRefId ()

	getObject ()

	redirectToParent ()

Protected Attributes
ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilAccess	$access

ilObjUser	$user

Factory	$input_factory

Renderer	$renderer

Psr Http Message ServerRequestInterface	$request

ILIAS Refinery Factory	$refinery_factory

ILIAS Data Factory	$data_factory

ilPRGMessagePrinter	$messages

string	$back_target = null

array	$progress_ids = []

int	$ref_id = null

ilObjStudyProgramme	$object = null

Private Attributes
const	CMD_SHOW_EXPIRE_DATE_CONFIG = "showExpireDateConfig"

const	CMD_CHANGE_EXPIRE_DATE = "changeExpireDate"

const	PROP_VALIDITY_OF_QUALIFICATION = "validity_qualification"

Detailed Description

Definition at line 26 of file class.ilStudyProgrammeChangeExpireDateGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeChangeExpireDateGUI::__construct	(	ilCtrl	$ctrl,
		ilGlobalTemplateInterface	$tpl,
		ilLanguage	$lng,
		ilAccess	$access,
		ilObjUser	$user,
		Factory	$input_factory,
		Renderer	$renderer,
		Psr\Http\Message\ServerRequestInterface	$request,
		ILIAS\Refinery\Factory	$refinery_factory,
		ILIAS\Data\Factory	$data_factory,
		ilPRGMessagePrinter	$messages
	)

Definition at line 49 of file class.ilStudyProgrammeChangeExpireDateGUI.php.

References $access, $ctrl, $data_factory, $input_factory, $lng, $messages, $refinery_factory, $renderer, $request, $tpl, $user, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), renderer(), and ILIAS\Repository\user().

       {
         $this->ctrl = $ctrl;
         $this->tpl = $tpl;
         $this->lng = $lng;
         $this->access = $access;
         $this->user = $user;
         $this->input_factory = $input_factory;
         $this->renderer = $renderer;
         $this->request = $request;
         $this->refinery_factory = $refinery_factory;
         $this->data_factory = $data_factory;
         $this->messages = $messages;
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildForm()

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

protected

Definition at line 109 of file class.ilStudyProgrammeChangeExpireDateGUI.php.

References $id, $txt, buildFormElements(), and ILIAS\Repository\lng().

Referenced by showExpireDateConfig().

                                                                                  : Standard
     {
         $ff = $this->input_factory->field();
         $txt = function ($id) {
             return $this->lng->txt($id);
         };
 
         return $this->input_factory->container()->form()->standard(
             $submit_action,
             $this->buildFormElements(
                 $ff,
                 $txt,
                 $prg
             )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildFormElements()

ilStudyProgrammeChangeExpireDateGUI::buildFormElements	(	ILIAS\UI\Component\Input\Field\Factory	$ff,
		Closure	$txt,
		ilObjStudyProgramme	$prg
	)

protected

Definition at line 156 of file class.ilStudyProgrammeChangeExpireDateGUI.php.

References $txt, getValidityOfQualificationSubForm(), and ilObjStudyProgrammeSettingsGUI\PROP_VALIDITY_OF_QUALIFICATION.

Referenced by buildForm().

      : array {
         return [
             $ff->section(
                 [
                     ilObjStudyProgrammeSettingsGUI::PROP_VALIDITY_OF_QUALIFICATION => $this->getValidityOfQualificationSubForm($prg)
                 ],
                 $txt("prg_validity_of_qualification"),
                 ""
             )
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ changeExpireDate()

ilStudyProgrammeChangeExpireDateGUI::changeExpireDate ( )

protected

Definition at line 172 of file class.ilStudyProgrammeChangeExpireDateGUI.php.

References ILIAS\Repository\ctrl(), getObject(), getProgressIds(), ILIAS\Repository\lng(), null, ilObjStudyProgrammeSettingsGUI\OPT_VALIDITY_OF_QUALIFICATION_DATE, and ILIAS\Repository\user().

Referenced by executeCommand().

                                          : void
     {
         $form = $this
             ->buildForm($this->getObject(), $this->ctrl->getFormAction($this, "changeExpireDate"))
             ->withRequest($this->request);
 
         $result = $form->getInputGroup()->getContent();
 
         $msg_collection = $this->messages->getMessageCollection('msg_change_expire_date');
 
         if ($result->isOK()) {
             $values = $result->value();
             $programme = $this->getObject();
             $acting_usr_id = $this->user->getId();
 
             $vq_data = $values[0][self::PROP_VALIDITY_OF_QUALIFICATION];
             $vq_type = $vq_data[0];
             $validity = null;
             if ($vq_type === ilObjStudyProgrammeSettingsGUI::OPT_VALIDITY_OF_QUALIFICATION_DATE) {
                 $validity = array_shift($vq_data[1]);
                 if (!$validity) {
                     $this->tpl->setOnScreenMessage("failure", $this->lng->txt('error_updating_expire_date'), true);
                     $this->ctrl->setParameter($this, 'prgrs_ids', implode(',', $this->getProgressIds()));
                     $this->ctrl->redirectByClass(self::class, self::CMD_SHOW_EXPIRE_DATE_CONFIG);
                 }
             }
             foreach ($this->getProgressIds() as $progress_id) {
                 $assignment_id = $progress_id->getAssignmentId();
                 $programme->changeProgressValidityDate($assignment_id, $acting_usr_id, $msg_collection, $validity, );
             }
 
             $this->messages->showMessages($msg_collection);
             $this->ctrl->redirectByClass('ilObjStudyProgrammeMembersGUI', 'view');
         }
         $this->tpl->setOnScreenMessage("failure", $this->lng->txt('error_updating_expire_date'), true);
         $this->ctrl->setParameter($this, 'prgrs_ids', implode(',', $this->getProgressIds()));
         $this->ctrl->redirectByClass(self::class, self::CMD_SHOW_EXPIRE_DATE_CONFIG);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilStudyProgrammeChangeExpireDateGUI::executeCommand ( )

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

References changeExpireDate(), ILIAS\Repository\ctrl(), redirectToParent(), and showExpireDateConfig().

                                     : void
     {
         $cmd = $this->ctrl->getCmd();
 
         switch ($cmd) {
             case self::CMD_SHOW_EXPIRE_DATE_CONFIG:
                 $this->showExpireDateConfig();
                 break;
             case self::CMD_CHANGE_EXPIRE_DATE:
                 $this->changeExpireDate();
                 break;
             case 'cancel':
                 $this->redirectToParent();
                 break;
             default:
                 throw new Exception('Unknown command ' . $cmd);
         }
     }

Here is the call graph for this function:

◆ getBackTarget()

ilStudyProgrammeChangeExpireDateGUI::getBackTarget ( )

protected

Definition at line 211 of file class.ilStudyProgrammeChangeExpireDateGUI.php.

References $back_target.

Referenced by redirectToParent().

                                       : ?string
     {
         return $this->back_target;
     }

Here is the caller graph for this function:

◆ getObject()

ilStudyProgrammeChangeExpireDateGUI::getObject ( )

protected

Definition at line 241 of file class.ilStudyProgrammeChangeExpireDateGUI.php.

References $object, ilObjStudyProgramme\getInstanceByRefId(), getRefId(), and null.

Referenced by changeExpireDate(), and showExpireDateConfig().

                                   : ilObjStudyProgramme
     {
         $ref_id = $this->getRefId();
         if (is_null($ref_id)) {
             throw new LogicException("Can't create object. No ref_id given.");
         }
 
         if ($this->object === null) {
             $this->object = ilObjStudyProgramme::getInstanceByRefId($ref_id);
         }
         return $this->object;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProgressIds()

ilStudyProgrammeChangeExpireDateGUI::getProgressIds ( )

protected

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

References $progress_ids.

Referenced by changeExpireDate(), and showExpireDateConfig().

                                        : array
     {
         return $this->progress_ids;
     }

Here is the caller graph for this function:

◆ getRefId()

ilStudyProgrammeChangeExpireDateGUI::getRefId ( )

protected

Definition at line 231 of file class.ilStudyProgrammeChangeExpireDateGUI.php.

References $ref_id.

Referenced by getObject().

                                  : ?int
     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ getValidityOfQualificationSubForm()

ilStudyProgrammeChangeExpireDateGUI::getValidityOfQualificationSubForm ( ilObjStudyProgramme $prg )

protected

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

References $id, $txt, ilObjStudyProgramme\getSettings(), ILIAS\Repository\lng(), null, ilObjStudyProgrammeSettingsGUI\OPT_NO_VALIDITY_OF_QUALIFICATION, and ilObjStudyProgrammeSettingsGUI\OPT_VALIDITY_OF_QUALIFICATION_DATE.

Referenced by buildFormElements().

                                                                                   : FormInput
     {
         $ff = $this->input_factory->field();
         $txt = function ($id) {
             return $this->lng->txt($id);
         };
 
         $option = ilObjStudyProgrammeSettingsGUI::OPT_NO_VALIDITY_OF_QUALIFICATION;
         $format = $this->data_factory->dateFormat()->germanShort();
         $vq_date_sub_form = $ff
             ->dateTime('', $txt('validity_qualification_date_desc'))
             ->withFormat($format);
         $date = $prg->getSettings()->getValidityOfQualificationSettings()->getQualificationDate();
         if ($date !== null) {
             $vq_date_sub_form = $vq_date_sub_form->withValue($date->format($format->toString()));
             $option = ilObjStudyProgrammeSettingsGUI::OPT_VALIDITY_OF_QUALIFICATION_DATE;
         }
 
         $sg = $ff->switchableGroup(
             [
                 ilObjStudyProgrammeSettingsGUI::OPT_NO_VALIDITY_OF_QUALIFICATION =>
                     $ff->group([], $txt('prg_no_validity_qualification')),
                 ilObjStudyProgrammeSettingsGUI::OPT_VALIDITY_OF_QUALIFICATION_DATE =>
                     $ff->group([$vq_date_sub_form], $txt('validity_qualification_date'))
             ],
             ''
         );
         return $sg->withValue($option);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redirectToParent()

ilStudyProgrammeChangeExpireDateGUI::redirectToParent ( )

protected

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

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

Referenced by executeCommand().

                                          : void
     {
         $back_target = $this->getBackTarget();
         if (is_null($back_target)) {
             throw new LogicException("Can't redirect. No back target given.");
         }
 
         $this->ctrl->redirectToURL($back_target);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBackTarget()

ilStudyProgrammeChangeExpireDateGUI::setBackTarget ( string $target )

Definition at line 216 of file class.ilStudyProgrammeChangeExpireDateGUI.php.

                                                  : void
     {
         $this->back_target = $target;
     }

◆ setProgressIds()

ilStudyProgrammeChangeExpireDateGUI::setProgressIds ( array $progress_ids )

Definition at line 226 of file class.ilStudyProgrammeChangeExpireDateGUI.php.

References $progress_ids.

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

◆ setRefId()

ilStudyProgrammeChangeExpireDateGUI::setRefId ( int $ref_id )

Definition at line 236 of file class.ilStudyProgrammeChangeExpireDateGUI.php.

References $ref_id.

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

◆ showExpireDateConfig()

ilStudyProgrammeChangeExpireDateGUI::showExpireDateConfig ( )

protected

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

References buildForm(), ILIAS\Repository\ctrl(), getObject(), getProgressIds(), and renderer().

Referenced by executeCommand().

                                              : void
     {
         $this->tpl->loadStandardTemplate();
         $this->ctrl->setParameter($this, 'prgrs_ids', implode(',', $this->getProgressIds()));
         $action = $this->ctrl->getFormAction(
             $this,
             self::CMD_CHANGE_EXPIRE_DATE
         );
         $this->ctrl->clearParameters($this);
 
         $form = $this->buildForm($this->getObject(), $action);
 
         $this->tpl->setContent($this->renderer->render($form));
     }