Collaboration diagram for ilECSUserConsentModalGUI:

Public Member Functions
	__construct (int $a_usr_id, int $a_ref_id, ?ilRemoteObjectBaseGUI $remote_gui=null)

	hasConsented ()

	getTitleLink ()

	addLinkToToolbar (ilToolbarGUI $toolbar)

	addConsentModalToToolbar (ilToolbarGUI $toolbar)

	addConsentModalToCard (RepositoryObject $card)

Data Fields
const	CMD_RENDER_MODAL = 'renderConsentModal'

const	CMD_SAVE_CONSENT = 'saveConsent'

Protected Member Functions
	initMidAndServer ()

	lookupOrganization ()

	isLocalObject ()

	addRemoteLinkToToolbar (ilToolbarGUI $toolbar)

	getConsentModalComponents (int $a_trigger_type=self::TRIGGER_TYPE_STANDARD)

	saveConsent (ilPropertyFormGUI $form)

	initConsentForm ()

	getOrganisation ()

	getGUIClassName ()

	initRemoteObject ()

Protected Attributes
const	TRIGGER_TYPE_SHY = 1

const	TRIGGER_TYPE_STANDARD = 2

const	TRIGGER_TYPE_CARD = 3

ilRemoteObjectBaseGUI	$remote_gui = null

ilRemoteObjectBase	$remote_object

ilECSUserConsents	$consents

ilECSImportManager	$importManager

ilECSExportManager	$exportManager

UIRenderer	$ui_renderer

UIFactory	$ui_factory

RequestInterface	$request

ilToolbarGUI	$toolbar

ilLanguage	$lng

ilCtrlInterface	$ctrl

ilObjectDefinition	$objDefinition

Private Attributes
int	$usr_id

int	$ref_id

int	$obj_id

int	$mid

int	$server_id

Detailed Description

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

ilECSUserConsentModalGUI: ilObjRemoteCategoryGUI, ilObjRemoteCourseGUI, ilObjRemoteFileGUI ilECSUserConsentModalGUI: ilObjRemoteGlossaryGUI, ilObjRemoteGroupGUI, ilObjRemoteLearningModuleGUI ilECSUserConsentModalGUI: ilObjRemoteTestGUI, ilObjRemoteWikiGUI

Definition at line 34 of file class.ilECSUserConsentModalGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilECSUserConsentModalGUI::__construct	(	int	$a_usr_id,
		int	$a_ref_id,
		?ilRemoteObjectBaseGUI	$remote_gui = `null`
	)

Definition at line 63 of file class.ilECSUserConsentModalGUI.php.

References $DIC, $remote_gui, ILIAS\Repository\ctrl(), ilECSImportManager\getInstance(), ilECSExportManager\getInstance(), ilECSUserConsents\getInstanceByUserId(), initMidAndServer(), initRemoteObject(), and ILIAS\Repository\lng().

       {
         global $DIC;
 
         $this->usr_id = $a_usr_id;
         $this->ref_id = $a_ref_id;
         $this->remote_gui = $remote_gui;
         $this->consents = ilECSUserConsents::getInstanceByUserId($this->usr_id);
         $this->importManager = ilECSImportManager::getInstance();
         $this->exportManager = ilECSExportManager::getInstance();
 
         $this->ui_factory = $DIC->ui()->factory();
         $this->ui_renderer = $DIC->ui()->renderer();
         $this->request = $DIC->http()->request();
         $this->lng = $DIC->language();
         $this->lng->loadLanguageModule('ecs');
         $this->ctrl = $DIC->ctrl();
         $this->objDefinition = $DIC['objDefinition'];
 
         $this->remote_object = $this->initRemoteObject();
         $this->initMidAndServer();
         $this->obj_id = $this->remote_object->getId();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addConsentModalToCard()

ilECSUserConsentModalGUI::addConsentModalToCard ( RepositoryObject $card )

Definition at line 158 of file class.ilECSUserConsentModalGUI.php.

References $components, getConsentModalComponents(), ILIAS\UI\Component\Card\Card\getImage(), null, ILIAS\Repository\toolbar(), and ILIAS\UI\Component\Card\Card\withImage().

      : RepositoryObject {
         $components = $this->getConsentModalComponents(self::TRIGGER_TYPE_CARD);
         foreach ($components as $component) {
             if ($component === null) {
                 continue;
             }
             $this->toolbar->addComponent($component);
 
             $image = $card->getImage();
             $image = $image->withOnClick($component->getShowSignal());
             $card = $card
                 ->withImage($image)
                 ->withTitleAction($component->getShowSignal());
         }
         return $card;
     }

Here is the call graph for this function:

◆ addConsentModalToToolbar()

ilECSUserConsentModalGUI::addConsentModalToToolbar ( ilToolbarGUI $toolbar )

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

References $components, ilToolbarGUI\addComponent(), and getConsentModalComponents().

Referenced by addLinkToToolbar().

                                                                    : void
     {
         $components = $this->getConsentModalComponents();
         foreach ($components as $component) {
             $toolbar->addComponent($component);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addLinkToToolbar()

ilECSUserConsentModalGUI::addLinkToToolbar ( ilToolbarGUI $toolbar )

Definition at line 124 of file class.ilECSUserConsentModalGUI.php.

References addConsentModalToToolbar(), addRemoteLinkToToolbar(), ANONYMOUS_USER_ID, hasConsented(), and isLocalObject().

Referenced by ilRemoteObjectBaseGUI\infoScreen().

                                                            : void
     {
         if (
             $this->usr_id === ANONYMOUS_USER_ID ||
             $this->isLocalObject()
         ) {
             return;
         }
         if ($this->hasConsented()) {
             $this->addRemoteLinkToToolbar($toolbar);
         } else {
             $this->addConsentModalToToolbar($toolbar);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addRemoteLinkToToolbar()

ilECSUserConsentModalGUI::addRemoteLinkToToolbar ( ilToolbarGUI $toolbar )

protected

Definition at line 139 of file class.ilECSUserConsentModalGUI.php.

References ilToolbarGUI\addComponent(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by addLinkToToolbar().

                                                                     : void
     {
         $button = $this->ui_factory
             ->button()
             ->standard(
                 $this->lng->txt($this->remote_object->getType() . '_call'),
                 $this->ctrl->getLinkTarget($this->remote_gui, 'call')
             );
         $toolbar->addComponent($button);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getConsentModalComponents()

ilECSUserConsentModalGUI::getConsentModalComponents ( int $a_trigger_type = self::TRIGGER_TYPE_STANDARD )

protected

Definition at line 177 of file class.ilECSUserConsentModalGUI.php.

References $id, $valid, initConsentForm(), ILIAS\Repository\lng(), null, and saveConsent().

Referenced by addConsentModalToCard(), addConsentModalToToolbar(), and getTitleLink().

      : array {
         $form = $this->initConsentForm();
         $form_id = 'form_' . $form->getId();
         $agree = $this->ui_factory->button()
                                   ->primary('Agree and Proceed', '#')
                                   ->withOnLoadCode(
                                       function ($id) use ($form_id) {
                                           return "$('#$id').click(function() { $('#$form_id').submit(); return false; });";
                                       }
                                   );
 
         $submitted = (string) ($this->request->getParsedBody()['cmd'] ?? '');
         $valid = true;
         $error_html = '';
         if (strcmp($submitted, 'submit') === 0) {
             if (!$this->saveConsent($form)) {
                 $form->setValuesByPost();
                 $error = $this->ui_factory->messageBox()->failure(
                     $this->lng->txt('ecs_consent_required')
                 );
                 $error_html = $this->ui_renderer->render([$error]);
                 $valid = false;
             }
         }
 
         $modal = $this->ui_factory->modal()->roundtrip(
             $this->lng->txt('ecs_consent_modal_title'),
             $this->ui_factory->legacy()->content(
                 $error_html .
                 $form->getHTML()
             )
         )->withActionButtons([$agree]);
         if (!$valid) {
             $modal = $modal->withOnLoad($modal->getShowSignal());
         }
 
         $button = null;
         if ($a_trigger_type === self::TRIGGER_TYPE_STANDARD) {
             $button = $this->ui_factory->button()->standard(
                 $this->lng->txt($this->remote_object->getType() . '_call'),
                 '#'
             )->withOnClick(
                 $modal->getShowSignal()
             );
         } elseif ($a_trigger_type === self::TRIGGER_TYPE_SHY) {
             $button = $this->ui_factory->button()->shy(
                 $this->remote_object->getTitle(),
                 '#'
             )->withOnClick(
                 $modal->getShowSignal()
             );
         }
         return [$button, $modal];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGUIClassName()

ilECSUserConsentModalGUI::getGUIClassName ( )

protected

Definition at line 350 of file class.ilECSUserConsentModalGUI.php.

Referenced by initConsentForm().

                                         : string
     {
         return get_class($this->remote_gui);
     }

Here is the caller graph for this function:

◆ getOrganisation()

ilECSUserConsentModalGUI::getOrganisation ( )

protected

Definition at line 330 of file class.ilECSUserConsentModalGUI.php.

References Vendor\Package\$e, ilECSCommunityReader\getInstanceByServerId(), and null.

Referenced by initConsentForm().

                                         : ?ilECSOrganisation
     {
         $server_id = $this->importManager->lookupServerId($this->obj_id);
         if (0 === $server_id) {
             return null;
         }
         $community_reader = ilECSCommunityReader::getInstanceByServerId(
             $server_id
         );
         try {
             $part = $community_reader->getParticipantByMID($this->mid);
             if ($part instanceof ilECSParticipant) {
                 return $part->getOrganisation();
             }
             return null;
         } catch (ilECSConnectorException $e) {
             return null;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitleLink()

ilECSUserConsentModalGUI::getTitleLink ( )

Definition at line 111 of file class.ilECSUserConsentModalGUI.php.

References $components, ANONYMOUS_USER_ID, getConsentModalComponents(), hasConsented(), and isLocalObject().

Referenced by ilRemoteObjectBaseListGUI\insertTitle().

                                   : string
     {
         if (
             $this->usr_id === ANONYMOUS_USER_ID ||
             $this->isLocalObject() ||
             $this->hasConsented()
         ) {
             return '';
         }
         $components = $this->getConsentModalComponents(self::TRIGGER_TYPE_SHY);
         return $this->ui_renderer->render($components);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasConsented()

ilECSUserConsentModalGUI::hasConsented ( )

Definition at line 90 of file class.ilECSUserConsentModalGUI.php.

Referenced by addLinkToToolbar(), and getTitleLink().

                                   : bool
     {
         return $this->consents->hasConsented($this->server_id, $this->mid);
     }

Here is the caller graph for this function:

◆ initConsentForm()

ilECSUserConsentModalGUI::initConsentForm ( )

protected

Definition at line 260 of file class.ilECSUserConsentModalGUI.php.

References $provider, ilObject\_lookupTitle(), getGUIClassName(), getOrganisation(), ILIAS\Repository\lng(), and lookupOrganization().

Referenced by getConsentModalComponents().

                                         : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $form->setId(uniqid('form', false));
         $form->setFormAction('#');
 
         $ref_id_hidden = new ilHiddenInputGUI('consented_ref_id');
         $ref_id_hidden->setValue((string) $this->ref_id);
         $form->addItem($ref_id_hidden);
         $ref_type_hidden = new ilHiddenInputGUI('consented_type');
         $ref_type_hidden->setValue($this->getGUIClassName());
         $form->addItem($ref_type_hidden);
         $title = new ilNonEditableValueGUI(
             $this->lng->txt('title'),
             'title'
         );
         $title->setValue(
             ilObject::_lookupTitle($this->obj_id)
         );
         $form->addItem($title);
 
         $target = new ilNonEditableValueGUI(
             $this->lng->txt('ecs_form_target_platform'),
             'organisation'
         );
         $target->setValue($this->lookupOrganization());
         $form->addItem($target);
 
         // provider
         $organisation = $this->getOrganisation();
         if ($organisation instanceof ilECSOrganisation) {
             $provider = new ilNonEditableValueGUI(
                 $this->lng->txt('organization'),
                 'provider'
             );
             $provider->setValue($organisation->getName());
             $form->addItem($provider);
         }
 
         $consent = new ilCheckboxInputGUI(
             $this->lng->txt('ecs_form_consent'),
             'consent'
         );
         $consent->setValue("1");
         $consent->setChecked($this->consents->hasConsented($this->server_id, $this->mid));
         $consent->setRequired(true);
         $form->addItem($consent);
 
         $user_data_fields = [];
         foreach (['login',
                   'firstname',
                   'lastname',
                   'email',
                   'institution'
                  ] as $field) {
             $user_data_fields[] = $this->lng->txt('ecs_' . $field);
         }
         $listing = $this->ui_factory->listing()->unordered($user_data_fields);
         $listing_html = $this->ui_renderer->render([$listing]);
         $consent->setOptionTitle(
             $this->lng->txt(
                 'ecs_form_consent_option_title'
             ) . '<br />' . $listing_html
         );
         $submit = new ilHiddenInputGUI('cmd');
         $submit->setValue('submit');
         $form->addItem($submit);
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initMidAndServer()

ilECSUserConsentModalGUI::initMidAndServer ( )

protected

Definition at line 95 of file class.ilECSUserConsentModalGUI.php.

References ilECSImportManager\getInstance().

Referenced by __construct().

                                          : void
     {
         $this->mid = $this->remote_object->getMID();
         $this->server_id = ilECSImportManager::getInstance()->lookupServerId($this->remote_object->getId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initRemoteObject()

ilECSUserConsentModalGUI::initRemoteObject ( )

protected

Exceptions

ilDatabaseException
ilObjectNotFoundException

Definition at line 359 of file class.ilECSUserConsentModalGUI.php.

References ilObjectFactory\getInstanceByRefId().

Referenced by __construct().

                                          : ilRemoteObjectBase
     {
         $remote = ilObjectFactory::getInstanceByRefId($this->ref_id);
         if (!$remote instanceof ilRemoteObjectBase) {
             throw new ilObjectNotFoundException(
                 'Invalid ref_id given: ' . $this->ref_id
             );
         }
         return $remote;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isLocalObject()

ilECSUserConsentModalGUI::isLocalObject ( )

protected

Definition at line 106 of file class.ilECSUserConsentModalGUI.php.

Referenced by addLinkToToolbar(), and getTitleLink().

                                       : bool
     {
         return $this->remote_object->isLocalObject();
     }

Here is the caller graph for this function:

◆ lookupOrganization()

ilECSUserConsentModalGUI::lookupOrganization ( )

protected

Definition at line 101 of file class.ilECSUserConsentModalGUI.php.

Referenced by initConsentForm().

                                            : string
     {
         return $this->remote_object->getOrganization();
     }

Here is the caller graph for this function:

◆ saveConsent()

ilECSUserConsentModalGUI::saveConsent ( ilPropertyFormGUI $form )

protected

Definition at line 234 of file class.ilECSUserConsentModalGUI.php.

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

Referenced by getConsentModalComponents().

                                                            : bool
     {
         $consented = (bool) ($this->request->getParsedBody()['consent'] ?? 0);
         $ref_id_hidden = (int) ($this->request->getParsedBody()['consented_ref_id'] ?? 0);
         $ref_type_hidden = (string) ($this->request->getParsedBody()['consented_type'] ?? '');
         if ($consented) {
             $this->consents->add($this->server_id, $this->mid);
             $this->ctrl->setParameterByClass(
                 $ref_type_hidden,
                 'ref_id',
                 $ref_id_hidden
             );
             $this->ctrl->redirectToURL(
                 $this->ctrl->getLinkTargetByClass(
                     [
                         ilRepositoryGUI::class,
                         $ref_type_hidden
                     ],
                     'call'
                 )
             );
             return true;
         }
         return false;
     }