ilMDCopyrightConfigurationGUI: ilMDCopyrightUsageGUI, ilMDCopyrightImageUploadHandlerGUI More...

Collaboration diagram for ilMDCopyrightConfigurationGUI:

Public Member Functions
	__construct (ilObjMDSettingsGUI $parent_obj_gui)

	executeCommand ()

	showCopyrightSelection (int $current_id=0, RoundTrip $current_modal=null)

	saveEntry ()

	confirmDeleteEntries ()

	deleteEntries ()

	updateEntry ()

	saveCopyrightPosition ()

Protected Member Functions
	initCopyrightEditModal (EntryInterface $entry=null, bool $open_on_load=false)

	deleteFile (EntryInterface $entry)

	deleteFileIfChanged (EntryInterface $entry, array $data)

	extractImageFromData (array $data)

	initEntryIdFromQuery ()

	initEntryIdFromPost ()

Protected Attributes
ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilToolbarGUI	$toolbar_gui

GlobalHttpState	$http

Factory	$refinery

UIFactory	$ui_factory

UIRenderer	$ui_renderer

IRSS	$irss

ilObjMDSettingsGUI	$parent_obj_gui

ilMDSettingsAccessService	$access_service

RendererInterface	$renderer

RepositoryInterface	$repository

Detailed Description

ilMDCopyrightConfigurationGUI: ilMDCopyrightUsageGUI, ilMDCopyrightImageUploadHandlerGUI

Definition at line 39 of file class.ilMDCopyrightConfigurationGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilMDCopyrightConfigurationGUI::__construct ( ilObjMDSettingsGUI $parent_obj_gui )

Definition at line 56 of file class.ilMDCopyrightConfigurationGUI.php.

References $DIC, $parent_obj_gui, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\UI\examples\Deck\repository().

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->tpl = $DIC->ui()->mainTemplate();
         $this->toolbar_gui = $DIC->toolbar();
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
         $this->ui_factory = $DIC->ui()->factory();
         $this->ui_renderer = $DIC->ui()->renderer();
         $this->irss = $DIC->resourceStorage();
 
         $this->parent_obj_gui = $parent_obj_gui;
         $this->access_service = new ilMDSettingsAccessService(
             $this->parent_obj_gui->getRefId(),
             $DIC->access()
         );
         $this->renderer = new Renderer(
             $DIC->ui()->factory(),
             $DIC->resourceStorage()
         );
         $this->repository = new DatabaseRepository(new Wrapper($DIC->database()));
 
         $this->lng->loadLanguageModule("meta");
     }

Here is the call graph for this function:

Member Function Documentation

◆ confirmDeleteEntries()

ilMDCopyrightConfigurationGUI::confirmDeleteEntries ( )

Definition at line 193 of file class.ilMDCopyrightConfigurationGUI.php.

References ILIAS\Repository\ctrl(), initEntryIdFromPost(), ILIAS\Repository\lng(), ILIAS\UI\examples\Deck\repository(), and showCopyrightSelection().

                                           : void
     {
         $entry_ids = $this->initEntryIdFromPost();
         if (!count($entry_ids)) {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt('select_one'));
             $this->showCopyrightSelection();
             return;
         }
 
         $c_gui = new ilConfirmationGUI();
         // set confirm/cancel commands
         $c_gui->setFormAction($this->ctrl->getFormAction($this, "deleteEntries"));
         $c_gui->setHeaderText($this->lng->txt("md_delete_cp_sure"));
         $c_gui->setCancel($this->lng->txt("cancel"), "showCopyrightSelection");
         $c_gui->setConfirm($this->lng->txt("confirm"), "deleteEntries");
 
         // add items to delete
         foreach ($entry_ids as $entry_id) {
             $entry = $this->repository->getEntry($entry_id);
             $c_gui->addItem('entry_id[]', (string) $entry_id, $entry->title());
         }
         $this->tpl->setContent($c_gui->getHTML());
     }

Here is the call graph for this function:

◆ deleteEntries()

ilMDCopyrightConfigurationGUI::deleteEntries ( )

Definition at line 217 of file class.ilMDCopyrightConfigurationGUI.php.

References deleteFile(), initEntryIdFromPost(), ILIAS\Repository\lng(), ILIAS\UI\examples\Deck\repository(), and showCopyrightSelection().

                                    : bool
     {
         $entry_ids = $this->initEntryIdFromPost();
         if (!count($entry_ids)) {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt('select_one'));
             $this->showCopyrightSelection();
             return true;
         }
 
         foreach ($entry_ids as $entry_id) {
             $entry = $this->repository->getEntry($entry_id);
             $this->deleteFile($entry);
             $this->repository->deleteEntry($entry_id);
         }
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('md_copyrights_deleted'));
         $this->showCopyrightSelection();
         return true;
     }

Here is the call graph for this function:

◆ deleteFile()

ilMDCopyrightConfigurationGUI::deleteFile ( EntryInterface $entry )

protected

Definition at line 408 of file class.ilMDCopyrightConfigurationGUI.php.

References $id, and ILIAS\MetaData\Copyright\EntryInterface\copyrightData().

Referenced by deleteEntries(), and deleteFileIfChanged().

                                                         : void
     {
         if (($image_file = $entry->copyrightData()->imageFile()) === '') {
             return;
         }
         if ($id = $this->irss->manage()->find($image_file)) {
             $this->irss->manage()->remove($id, new ilMDCopyrightImageStakeholder());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteFileIfChanged()

ilMDCopyrightConfigurationGUI::deleteFileIfChanged	(	EntryInterface	$entry,
		array	$data
	)

protected

Definition at line 418 of file class.ilMDCopyrightConfigurationGUI.php.

References ILIAS\MetaData\Copyright\EntryInterface\copyrightData(), and deleteFile().

Referenced by updateEntry().

      : void {
         if (($image_file = $entry->copyrightData()->imageFile()) === '') {
             return;
         }
         if (
             $data['copyright']['image'][0] === 'file_group' &&
             $image_file === ($data['copyright']['image'][1]['image_file'][0] ?? '')
         ) {
             return;
         }
         $this->deleteFile($entry);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilMDCopyrightConfigurationGUI::executeCommand ( )

Definition at line 84 of file class.ilMDCopyrightConfigurationGUI.php.

References $handler, ILIAS\Repository\ctrl(), initEntryIdFromQuery(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Deck\repository().

                                     : void
     {
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd();
 
         if (
             !$this->access_service->hasCurrentUserVisibleAccess() ||
             !$this->access_service->hasCurrentUserReadAccess()
         ) {
             throw new ilPermissionException($this->lng->txt('no_permission'));
         }
 
         switch ($next_class) {
             case strtolower(ilMDCopyrightUsageGUI::class):
                 // this command is used if copyrightUsageGUI calls getParentReturn (see ...UsageGUI->setTabs)
                 $this->ctrl->setReturn($this, 'showCopyrightSelection');
                 $entry = $this->repository->getEntry($this->initEntryIdFromQuery());
                 $gui = new ilMDCopyrightUsageGUI($entry);
                 $this->ctrl->forwardCommand($gui);
                 break;
 
             case strtolower(ilMDCopyrightImageUploadHandlerGUI::class):
                 $entry = $this->repository->getEntry($this->initEntryIdFromQuery());
                 $file_id = empty($entry?->copyrightData()?->imageFile()) ? '' : $entry?->copyrightData()?->imageFile();
                 $handler = new ilMDCopyrightImageUploadHandlerGUI($file_id);
                 $this->ctrl->forwardCommand($handler);
 
                 // no break
             default:
                 if (!$cmd || $cmd === 'view') {
                     $cmd = 'showCopyrightSelection';
                 }
 
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ extractImageFromData()

ilMDCopyrightConfigurationGUI::extractImageFromData ( array $data )

protected

Definition at line 434 of file class.ilMDCopyrightConfigurationGUI.php.

Referenced by saveEntry(), and updateEntry().

                                                         : string|URI
     {
         $v = $data['copyright']['image'];
         if ($v[0] === 'link_group') {
             return empty($link = $v[1]['image_link']) ? '' : $link;
         }
         if ($v[0] === 'file_group') {
             return $v[1]['image_file'][0] ?? '';
         }
         return '';
     }

Here is the caller graph for this function:

◆ initCopyrightEditModal()

ilMDCopyrightConfigurationGUI::initCopyrightEditModal	(	EntryInterface	$entry = `null`,
		bool	$open_on_load = `false`
	)

protected

Definition at line 262 of file class.ilMDCopyrightConfigurationGUI.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by showCopyrightSelection().

      : RoundTrip {
         $inputs = [];
         $ff = $this->ui_factory->input()->field();
 
         $title = $ff
             ->text($this->lng->txt('title'))
             ->withValue($entry?->title() ?? '')
             ->withRequired(true)
             ->withMaxLength(255);
         $inputs['title'] = $title;
 
         $des = $ff
             ->textarea($this->lng->txt('description'))
             ->withValue($entry?->description() ?? '');
         $inputs['description'] = $des;
 
         $usage = $ff
             ->radio($this->lng->txt('meta_copyright_usage'))
             ->withOption('0', $this->lng->txt('meta_copyright_in_use'))
             ->withOption('1', $this->lng->txt('meta_copyright_outdated'))
             ->withValue((int) $entry?->isOutdated());
         $inputs['outdated'] = $usage;
 
         $cp_data = $entry?->copyrightData();
 
         $full_name = $ff
             ->text($this->lng->txt('md_copyright_full_name'))
             ->withValue($cp_data?->fullName() ?? '');
 
         $link = $ff
             ->url(
                 $this->lng->txt('md_copyright_link'),
                 $this->lng->txt('md_copyright_link_info')
             )
             ->withValue((string) $cp_data?->link())
             ->withAdditionalTransformation(
                 $this->refinery->custom()->transformation(fn($v) => $v instanceof URI ? $v : null)
             );
 
         $image_link = $ff
             ->url($this->lng->txt('md_copyright_image_link'))
             ->withValue((string) $cp_data?->imageLink())
             ->withAdditionalTransformation($this->refinery->custom()->transformation(
                 fn($v) => $v instanceof URI ? $v : null
             ));
 
         $file_id = empty($cp_data?->imageFile()) ? '' : $cp_data?->imageFile();
         $image_file = $ff
             ->file(
                 new ilMDCopyrightImageUploadHandlerGUI($file_id),
                 $this->lng->txt('md_copyright_image_file')
             )
             ->withMaxFiles(1)
             ->withAcceptedMimeTypes([MimeType::IMAGE__PNG, MimeType::IMAGE__JPEG]);
         if ($file_id !== '') {
             $image_file = $image_file->withValue([$file_id]);
         };
 
         $image_value = 'link_group';
         if (!is_null($cp_data) && !$cp_data->isImageLink()) {
             $image_value = 'file_group';
         }
         $image = $ff
             ->switchableGroup(
                 [
                     'link_group' => $ff->group(
                         ['image_link' => $image_link],
                         $this->lng->txt('md_copyright_image_is_link')
                     ),
                     'file_group' => $ff->group(
                         ['image_file' => $image_file],
                         $this->lng->txt('md_copyright_image_is_file')
                     ),
                 ],
                 $this->lng->txt('md_copyright_image')
             )
             ->withValue($image_value);
 
         $alt_text = $ff
             ->text(
                 $this->lng->txt('md_copyright_alt_text'),
                 $this->lng->txt('md_copyright_alt_text_info')
             )
             ->withValue($cp_data?->altText() ?? '');
 
         $cop = $ff
             ->section(
                 [
                     'full_name' => $full_name,
                     'link' => $link,
                     'image' => $image,
                     'alt_text' => $alt_text
                 ],
                 $this->lng->txt('md_copyright_value')
             );
         $inputs['copyright'] = $cop;
 
         if (!isset($entry)) {
             $title = $this->lng->txt('md_copyright_add');
             $post_url = $this->ctrl->getLinkTarget($this, 'saveEntry');
         } else {
             $title = $this->lng->txt('md_copyright_edit');
             $this->ctrl->setParameter($this, 'entry_id', $entry->id());
             $post_url = $this->ctrl->getLinkTarget($this, 'updateEntry');
             $this->ctrl->clearParameters($this);
         }
 
         $modal = $this->ui_factory->modal()->roundtrip(
             $title,
             null,
             $inputs,
             $post_url
         );
         if ($open_on_load) {
             $modal = $modal->withOnLoad($modal->getShowSignal());
         }
         return $modal;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initEntryIdFromPost()

ilMDCopyrightConfigurationGUI::initEntryIdFromPost ( )

protected

Definition at line 458 of file class.ilMDCopyrightConfigurationGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by confirmDeleteEntries(), and deleteEntries().

                                             : array
     {
         $entries = [];
         if ($this->http->wrapper()->post()->has('entry_id')) {
             return $this->http->wrapper()->post()->retrieve(
                 'entry_id',
                 $this->refinery->kindlyTo()->listOf(
                     $this->refinery->kindlyTo()->int()
                 )
             );
         }
         return [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initEntryIdFromQuery()

ilMDCopyrightConfigurationGUI::initEntryIdFromQuery ( )

protected

Definition at line 446 of file class.ilMDCopyrightConfigurationGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by executeCommand(), and updateEntry().

                                              : int
     {
         $entry_id = 0;
         if ($this->http->wrapper()->query()->has('entry_id')) {
             $entry_id = $this->http->wrapper()->query()->retrieve(
                 'entry_id',
                 $this->refinery->kindlyTo()->int()
             );
         }
         return $entry_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveCopyrightPosition()

ilMDCopyrightConfigurationGUI::saveCopyrightPosition ( )

Definition at line 384 of file class.ilMDCopyrightConfigurationGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\UI\examples\Deck\repository().

                                            : bool
     {
         if (!$this->http->wrapper()->post()->has('order')) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('err_select_one'), true);
             $this->ctrl->redirect($this, 'showCopyrightSelection');
             return false;
         }
         $positions = $this->http->wrapper()->post()->retrieve(
             'order',
             $this->refinery->kindlyTo()->dictOf(
                 $this->refinery->kindlyTo()->string()
             )
         );
         asort($positions);
         $ids = [];
         foreach ($positions as $entry_id => $position_ignored) {
             $ids[] = (int) $entry_id;
         }
         $this->repository->reorderEntries(...$ids);
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'));
         $this->ctrl->redirect($this, 'showCopyrightSelection');
         return false;
     }

Here is the call graph for this function:

◆ saveEntry()

ilMDCopyrightConfigurationGUI::saveEntry ( )

Definition at line 170 of file class.ilMDCopyrightConfigurationGUI.php.

References $data, ILIAS\Repository\ctrl(), extractImageFromData(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\UI\examples\Deck\repository(), and showCopyrightSelection().

                                : void
     {
         $modal = $this
             ->initCopyrightEditModal(null, true)
             ->withRequest($this->http->request());
 
         if ($data = $modal->getData()) {
             $this->repository->createEntry(
                 $data['title'],
                 $data['description'],
                 (bool) $data['outdated'],
                 $data['copyright']['full_name'],
                 $data['copyright']['link'],
                 $this->extractImageFromData($data),
                 $data['copyright']['alt_text']
             );
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
 
             $this->ctrl->redirect($this, 'showCopyrightSelection');
         }
         $this->showCopyrightSelection(0, $modal);
     }

Here is the call graph for this function:

◆ showCopyrightSelection()

ilMDCopyrightConfigurationGUI::showCopyrightSelection	(	int	$current_id = `0`,
		RoundTrip	$current_modal = `null`
	)

Definition at line 122 of file class.ilMDCopyrightConfigurationGUI.php.

References initCopyrightEditModal(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Deck\repository().

Referenced by confirmDeleteEntries(), deleteEntries(), saveEntry(), and updateEntry().

      : void {
         $has_write = $this->access_service->hasCurrentUserWriteAccess();
 
         $table_gui = new ilMDCopyrightTableGUI(
             $this->repository,
             $this->renderer,
             $this,
             'showCopyrightSelection',
             $has_write
         );
         $table_gui->setTitle($this->lng->txt("md_copyright_selection"));
         $table_gui->parseSelections();
 
         $edit_modals = [];
         if ($has_write) {
             foreach ($this->repository->getAllEntries() as $entry) {
                 if ($entry->id() === $current_id) {
                     $modal = $current_modal;
                 } else {
                     $modal = $this->initCopyrightEditModal($entry);
                 }
                 $table_gui->setEditModalSignal($entry->id(), $modal->getShowSignal());
                 $edit_modals[] = $modal;
             }
             if ($current_id === 0 && !is_null($current_modal)) {
                 $add_modal = $current_modal;
             } else {
                 $add_modal = $this->initCopyrightEditModal();
             }
             $this->toolbar_gui->addComponent($this->ui_factory->button()->standard(
                 $this->lng->txt('md_copyright_add'),
                 $add_modal->getShowSignal()
             ));
 
             $table_gui->addMultiCommand("confirmDeleteEntries", $this->lng->txt("delete"));
             $table_gui->setSelectAllCheckbox("entry_id");
         }
 
         $this->tpl->setContent(
             $table_gui->getHTML() .
             (isset($add_modal) ? $this->ui_renderer->render($add_modal) : '') .
             $this->ui_renderer->render($edit_modals)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateEntry()

ilMDCopyrightConfigurationGUI::updateEntry ( )

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

References $data, ILIAS\Repository\ctrl(), deleteFileIfChanged(), extractImageFromData(), ILIAS\FileDelivery\http(), initEntryIdFromQuery(), ILIAS\Repository\lng(), ILIAS\UI\examples\Deck\repository(), and showCopyrightSelection().

                                  : void
     {
         $entry = $this->repository->getEntry($this->initEntryIdFromQuery());
         $modal = $this
             ->initCopyrightEditModal($entry, true)
             ->withRequest($this->http->request());
 
         if ($data = $modal->getData()) {
             $this->deleteFileIfChanged($entry, $data);
             $this->repository->updateEntry(
                 $entry->id(),
                 $data['title'],
                 $data['description'],
                 (bool) $data['outdated'],
                 $data['copyright']['full_name'],
                 $data['copyright']['link'],
                 $this->extractImageFromData($data),
                 $data['copyright']['alt_text']
             );
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
 
             $this->ctrl->redirect($this, 'showCopyrightSelection');
         }
         $this->showCopyrightSelection($entry->id(), $modal);
     }