Collaboration diagram for ilStudyProgrammeChangeExpireDateGUI:

Public Member Functions
	__construct (ilCtrl $ctrl, ilGlobalTemplateInterface $tpl, ilLanguage $lng, ilAccess $access, ilObjUser $user, Factory $input_factory, Renderer $renderer, ServerRequest $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)

Data Fields
const	CMD_SHOW_EXPIRE_DATE_CONFIG = "showExpireDateConfig"

const	CMD_CHANGE_EXPIRE_DATE = "changeExpireDate"

const	PROP_VALIDITY_OF_QUALIFICATION = "validity_qualification"

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
	$gui

	$ctrl

	$tpl

	$lng

	$access

	$user

	$back_target

	$input_factory

	$renderer

	$request

	$refinery_factory

	$data_factory

	$progress_ids

	$ref_id

	$object

	$messages

Detailed Description

Definition at line 13 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,
		ServerRequest	$request,
		\ILIAS\Refinery\Factory	$refinery_factory,
		\ILIAS\Data\Factory	$data_factory,
		ilPRGMessagePrinter	$messages
	)

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

      {
        $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;
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ buildForm()

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

protected

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

                                                                                  : 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
            )
        );
    }

References $txt, and buildFormElements().

Referenced by showExpireDateConfig().

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 212 of file class.ilStudyProgrammeChangeExpireDateGUI.php.

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

Referenced by buildForm().

Here is the caller graph for this function:

◆ changeExpireDate()

ilStudyProgrammeChangeExpireDateGUI::changeExpireDate ( )

protected

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

                                          : 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 = DateTimeImmutable::createFromFormat('d.m.Y', array_shift($vq_data[1]));
                if (!$validity) {
                    ilUtil::sendFailure($this->lng->txt('error_updating_expire_date'), true);
                    $this->ctrl->redirectByClass(self::class, self::CMD_SHOW_EXPIRE_DATE_CONFIG);
                }
            }
            foreach ($this->getProgressIds() as $progress_id) {
                $programme->changeProgressValidityDate($progress_id, $acting_usr_id, $msg_collection, $validity, );
            }
 
            $this->messages->showMessages($msg_collection);
            $this->ctrl->redirectByClass('ilObjStudyProgrammeMembersGUI', 'view');
        }
        ilUtil::sendFailure($this->lng->txt('error_updating_expire_date'), true);
        $this->ctrl->redirectByClass(self::class, self::CMD_SHOW_EXPIRE_DATE_CONFIG);
    }

References $result, ilObjStudyProgrammeSettingsGUI\OPT_VALIDITY_OF_QUALIFICATION_DATE, ilUtil\sendFailure(), and user().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilStudyProgrammeChangeExpireDateGUI::executeCommand ( )

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

                                     : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        switch ($next_class) {
            default:
                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);
                        break;
                }
                break;
        }
    }

References changeExpireDate(), CMD_CHANGE_EXPIRE_DATE, CMD_SHOW_EXPIRE_DATE_CONFIG, redirectToParent(), and showExpireDateConfig().

Here is the call graph for this function:

◆ getBackTarget()

ilStudyProgrammeChangeExpireDateGUI::getBackTarget ( )

protected

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

                                       : string
    {
        return $this->back_target;
    }

◆ getObject()

ilStudyProgrammeChangeExpireDateGUI::getObject ( )

protected

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

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

References ilObjStudyProgramme\getInstanceByRefId().

Referenced by showExpireDateConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProgressIds()

ilStudyProgrammeChangeExpireDateGUI::getProgressIds ( )

protected

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

                                        : array
    {
        return $this->progress_ids;
    }

Referenced by showExpireDateConfig().

Here is the caller graph for this function:

◆ getRefId()

ilStudyProgrammeChangeExpireDateGUI::getRefId ( )

protected

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

                                  : int
    {
        return $this->ref_id;
    }

◆ getValidityOfQualificationSubForm()

ilStudyProgrammeChangeExpireDateGUI::getValidityOfQualificationSubForm ( ilObjStudyProgramme $prg )

protected

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

                                                                                   : Input
    {
        $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);
    }

References $format, $txt, ilObjStudyProgramme\getSettings(), ilObjStudyProgrammeSettingsGUI\OPT_NO_VALIDITY_OF_QUALIFICATION, and ilObjStudyProgrammeSettingsGUI\OPT_VALIDITY_OF_QUALIFICATION_DATE.

Here is the call graph for this function:

◆ redirectToParent()

ilStudyProgrammeChangeExpireDateGUI::redirectToParent ( )

protected

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

                                          : void
    {
        ilUtil::redirect($this->getBackTarget());
    }

References ilUtil\redirect().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBackTarget()

ilStudyProgrammeChangeExpireDateGUI::setBackTarget ( string $target )

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

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

◆ setProgressIds()

ilStudyProgrammeChangeExpireDateGUI::setProgressIds ( array $progress_ids )

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

                                                        : void
    {
        $this->progress_ids = array_map('intval', $progress_ids);
    }

◆ setRefId()

ilStudyProgrammeChangeExpireDateGUI::setRefId ( int $ref_id )

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

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

◆ showExpireDateConfig()

ilStudyProgrammeChangeExpireDateGUI::showExpireDateConfig ( )

protected

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

                                              : 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));
    }