Collaboration diagram for ilFileVersionFormGUI:

Public Member Functions
	__construct (ilFileVersionsGUI $file_version_gui, private int $save_mode=self::MODE_ADD)
	ilFileVersionFormGUI constructor. More...

	saveObject ()

	getHTML ()

Data Fields
const	MODE_ADD = 1

const	MODE_REPLACE = 2

const	F_TITLE = 'title'

const	F_DESCRIPTION = "description"

const	F_FILE = "file"

const	F_SAVE_MODE = 'save_mode'

Private Member Functions
	initForm ()

	resolveParentCommand (int $mode)

Private Attributes
ilObjFile	$file

ILIAS UI Component Input Container Form Standard	$form

ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$ui_renderer

RequestInterface	$request

ilGlobalTemplateInterface	$global_tpl

ilLanguage	$lng

ILIAS ResourceStorage Services	$resource_services

string	$post_url

UploadLimitResolver	$upload_limit

Detailed Description

Class ilFileVersionFormGUI.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 28 of file class.ilFileVersionFormGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileVersionFormGUI::__construct	(	ilFileVersionsGUI	$file_version_gui,
		private int	$save_mode = `self::MODE_ADD`
	)

ilFileVersionFormGUI constructor.

Definition at line 52 of file class.ilFileVersionFormGUI.php.

References $DIC, ilFileVersionsGUI\getFile(), initForm(), ILIAS\Repository\lng(), and resolveParentCommand().

     {
         global $DIC;
         $this->file = $file_version_gui->getFile();
         ;
         $this->lng = $DIC->language();
         $this->ui_factory = $DIC->ui()->factory();
         $this->ui_renderer = $DIC->ui()->renderer();
         $this->request = $DIC->http()->request();
         $this->global_tpl = $DIC->ui()->mainTemplate();
         $this->resource_services = $DIC->resourceStorage();
         $this->post_url = $DIC->ctrl()->getFormAction(
             $file_version_gui,
             $this->resolveParentCommand($save_mode)
         );
         $this->lng->loadLanguageModule('file');
         $this->upload_limit = $DIC['ui.upload_limit_resolver'];
         $this->initForm();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getHTML()

ilFileVersionFormGUI::getHTML ( )

Definition at line 157 of file class.ilFileVersionFormGUI.php.

References ILIAS\Repository\form().

                              : string
     {
         return $this->ui_renderer->render($this->form);
     }

Here is the call graph for this function:

◆ initForm()

ilFileVersionFormGUI::initForm ( )

private

Definition at line 72 of file class.ilFileVersionFormGUI.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Repository\form(), ILIAS\Repository\lng(), ilFileVersionsUploadHandlerGUI\MODE_APPEND, ilFileVersionsUploadHandlerGUI\MODE_REPLACE, and ilObject\TITLE_LENGTH.

Referenced by __construct().

                                : void
     {
         switch ($this->save_mode) {
             case self::MODE_REPLACE:
                 $this->global_tpl->setOnScreenMessage('info', $this->lng->txt('replace_file_info'));
                 $group_title = $this->lng->txt('replace_file');
                 break;
             case self::MODE_ADD:
             default:
                 $this->global_tpl->setOnScreenMessage('info', $this->lng->txt('file_new_version_info'));
                 $group_title = $this->lng->txt('file_new_version');
                 break;
         }
 
         $upload_handler = new ilFileVersionsUploadHandlerGUI(
             $this->file,
             $this->save_mode === self::MODE_REPLACE
                 ? ilFileVersionsUploadHandlerGUI::MODE_REPLACE
                 : ilFileVersionsUploadHandlerGUI::MODE_APPEND
         );
 
         $size = new DataSize(
             $this->upload_limit->getBestPossibleUploadLimitInBytes($upload_handler),
             DataSize::MB
         );
 
         $inputs = [
             self::F_TITLE => $this->ui_factory->input()->field()->text(
                 $this->lng->txt(self::F_TITLE),
                 $this->lng->txt("if_no_title_then_filename")
             )->withRequired(false)
              ->withMaxLength(ilObject::TITLE_LENGTH)
              ->withValue($this->file->getTitle()),
 
             self::F_DESCRIPTION => $this->ui_factory->input()->field()->textarea(
                 $this->lng->txt(self::F_DESCRIPTION)
             ),
             self::F_FILE => $this->ui_factory->input()->field()->file(
                 $upload_handler,
                 $this->lng->txt(self::F_FILE),
                 sprintf(
                     $this->lng->txt('upload_files_limit'),
                     (string) $size
                 ),
             )->withMaxFiles(1)
              ->withRequired(true),
         ];
 
         $group = $this->ui_factory->input()->field()->group($inputs, $group_title);
 
         $this->form = $this->ui_factory->input()->container()->form()->standard($this->post_url, [$group]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resolveParentCommand()

ilFileVersionFormGUI::resolveParentCommand ( int $mode )

private

Definition at line 162 of file class.ilFileVersionFormGUI.php.

References ilFileVersionsGUI\CMD_CREATE_NEW_VERSION, and ilFileVersionsGUI\CMD_CREATE_REPLACING_VERSION.

Referenced by __construct().

                                                     : string
     {
         return match ($mode) {
             self::MODE_REPLACE => ilFileVersionsGUI::CMD_CREATE_REPLACING_VERSION,
             default => ilFileVersionsGUI::CMD_CREATE_NEW_VERSION,
         };
     }

Here is the caller graph for this function:

◆ saveObject()

ilFileVersionFormGUI::saveObject ( )

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

References $data, ensureSuffix(), ILIAS\Repository\form(), and ILIAS\Repository\int().

                                 : bool
     {
         $this->form = $this->form->withRequest($this->request);
         $data = $this->form->getData()[0] ?? null;
         if ($data === null) {
             return false;
         }
 
         $title = !empty($data[self::F_TITLE]) ? $data[self::F_TITLE] : $this->file->getTitle();
         $description = $data[self::F_DESCRIPTION] !== '' ? $data[self::F_DESCRIPTION] : $this->file->getDescription();
         $revision_number = $data[self::F_FILE][0] ?? null;
         if ($revision_number === null) {
             return false;
         }
         $revision_number = (int) $revision_number;
 
         // Title differs, update Revision and Object
         $rid = $this->resource_services->manage()->find($this->file->getResourceId());
         $resource = $this->resource_services->manage()->getResource($rid);
         $new_revision = $resource->getSpecificRevision($revision_number);
 
         $new_revision->setTitle(
             $this->ensureSuffix($title, $new_revision->getInformation()->getSuffix())
         );
         $this->resource_services->manage()->updateRevision($new_revision);
 
         $this->file->setDescription($description);
         $this->file->updateObjectFromCurrentRevision();
 
         return true;
     }