ilPCVerificationGUI Class Reference

Class ilPCVerificationGUI Handles user commands on verifications. More...

Inheritance diagram for ilPCVerificationGUI:

Collaboration diagram for ilPCVerificationGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPCVerification $a_content_obj, string $a_hier_id='0', string $a_pc_id="")
	executeCommand ()
	insert (?ilPropertyFormGUI $a_form=null)
	edit (?ilPropertyFormGUI $a_form=null)
	create_verification ()
	create ()
	update ()
Public Member Functions inherited from ilPageContentGUI
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id="", string $a_pc_id="0")
	setContentObject (ilPageContent $a_val)
	getContentObject ()
	setPage (ilPageObject $a_val)
	getPage ()
	setPageConfig (ilPageConfig $a_val)
	getPageConfig ()
	setStyleId (int $a_styleid)
	getStyleId ()
	getStyle ()
	getCharacteristicsOfCurrentStyle (array $a_type)
	Get characteristics of current style and call setCharacteristics, if style is given. More...
	setCharacteristics (array $a_chars)
	getCharacteristics ()
	getHierId ()
	setHierId (string $a_hier_id)
	set hierarchical id in dom object More...
	delete ()
	displayValidationError ()
	cancelCreate ()
	cancel creating page content More...
	cancelUpdate ()
	cancel update More...
	cancel ()
	Cancel. More...
	deactivate ()
	gui function set enabled if is not enabled and vice versa More...
	cut ()
	Cut single element. More...
	copy ()
	Copy single element. More...
	getTemplateOptions (string $a_type="")
	Get table templates. More...

Protected Member Functions
	initForm (bool $a_insert=false)
Protected Member Functions inherited from ilPageContentGUI
	redirectToParent (string $hier_id="")
	getParentReturn (string $hier_id="")
	updateAndReturn ()
	setCurrentTextLang (string $lang_key)
	getCurrentTextLang ()
	setEditorToolContext ()
	initEditor ()
	getEditorScriptTag (string $form_pc_id="", string $form_cname="")

Protected Attributes
ilObjUser	$user
Protected Attributes inherited from ilPageContentGUI
ILIAS COPage Editor GUIService	$editor_gui
ILIAS COPage InternalGUIService	$gui
EditSessionRepository	$edit_repo
string	$pc_id = ""
array	$chars
ilObjStyleSheet	$style = null
LOMServices	$lom_services
ilLogger	$log
int	$styleid = 0
EditGUIRequest	$request
string	$sub_command = ""
int	$requested_ref_id = 0
ILIAS GlobalScreen ScreenContext ContextServices	$tool_context
Style Content CharacteristicManager	$char_manager

Private Member Functions
	getValidWorkspaceCertificateNodeByIdMap ()
	getValidCertificateByIdMap ()

Private Attributes
const	SUPPORTED_TYPES = ['excv', 'tstv', 'crsv', 'cmxv', 'ltiv', 'scov']

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
Data Fields inherited from ilPageContentGUI
ilPageContent	$content_obj
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilCtrl	$ctrl
ilPageObject	$pg_obj
string	$hier_id = ""
DOMDocument	$dom
	$updated
string	$target_script = ""
string	$return_location = ""
ilPageConfig	$page_config = null
Static Public Attributes inherited from ilPageContentGUI
static string	$style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;"
Static Protected Attributes inherited from ilPageContentGUI
static array	$common_bb_buttons

Detailed Description

Class ilPCVerificationGUI Handles user commands on verifications.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilPCVerificationGUI::__construct	(	ilPageObject	$a_pg_obj,
		?ilPCVerification	$a_content_obj,
		string	$a_hier_id = '0',
		string	$a_pc_id = ""
	)

Definition at line 31 of file class.ilPCVerificationGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\user().

      {
        global $DIC;

        $this->user = $DIC->user();
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
    }

Here is the call graph for this function:

Member Function Documentation

create()

ilPCVerificationGUI::create

(

)

Definition at line 199 of file class.ilPCVerificationGUI.php.

References Vendor\Package\$e, ILIAS\Repository\ctrl(), ilPageContentGUI\getPage(), initForm(), insert(), ILIAS\Repository\int(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by create_verification().

                            : void
    {
        $form = $this->initForm(true);
        if ($form->checkInput()) {
            $objectId = (int) $form->getInput('persistent_object');
            $userId = $this->user->getId();

            $certificateFileService = new ilPortfolioCertificateFileService();
            try {
                $certificateFileService->createCertificateFile($userId, $objectId);
            } catch (\ILIAS\Filesystem\Exception\FileAlreadyExistsException $e) {
                $this->tpl->setOnScreenMessage('info', $this->lng->txt('certificate_file_not_found_error'), true);
                $this->log->warning($e->getMessage());
            } catch (\ILIAS\Filesystem\Exception\IOException $e) {
                $this->tpl->setOnScreenMessage('info', $this->lng->txt('certificate_file_input_output_error'), true);
                $this->log->error($e->getMessage());
                $this->ctrl->redirect($this, 'initForm');
            } catch (ilException $e) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('error_creating_certificate_pdf'), true);
                $this->log->error($e->getMessage());
                $this->ctrl->redirect($this, 'initForm');
            }

            $this->content_obj = new ilPCVerification($this->getPage());
            $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
            $this->content_obj->setData('crta', $objectId);

            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, 'jump' . $this->hier_id);
            }

            $this->log->info('File could not be created');
        }

        $this->insert($form);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

create_verification()

ilPCVerificationGUI::create_verification

(

)

Definition at line 194 of file class.ilPCVerificationGUI.php.

References create().

                                         : void
    {
        $this->create();
    }

Here is the call graph for this function:

edit()

ilPCVerificationGUI::edit

(

?ilPropertyFormGUI

$a_form = null

)

Definition at line 59 of file class.ilPCVerificationGUI.php.

References ilPageContentGUI\displayValidationError(), and initForm().

Referenced by update().

                                                           : void
    {
        $this->displayValidationError();

        if (!$a_form) {
            $a_form = $this->initForm();
        }
        $this->tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPCVerificationGUI::executeCommand

(

)

Definition at line 43 of file class.ilPCVerificationGUI.php.

References ILIAS\Repository\ctrl().

                                    : void
    {
        $cmd = $this->ctrl->getCmd();
        $this->$cmd();
    }

Here is the call graph for this function:

getValidCertificateByIdMap()

ilPCVerificationGUI::getValidCertificateByIdMap ( )

private

Returns

array<int, ilUserCertificatePresentation>

Exceptions

JsonException

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

References ILIAS\Repository\user().

Referenced by initForm(), and update().

                                                 : array
    {
        $certificates = [];

        $repository = new ilUserCertificateRepository();
        $activeCertificates = $repository->fetchActiveCertificates($this->user->getId());
        foreach ($activeCertificates as $certificate) {
            $certificates[$certificate->getObjId()] = $certificate;
        }

        return $certificates;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getValidWorkspaceCertificateNodeByIdMap()

ilPCVerificationGUI::getValidWorkspaceCertificateNodeByIdMap ( )

private

Returns

array<int, array>

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

References ilTree\getNodeData(), ilTree\getRootId(), and ILIAS\Repository\user().

Referenced by initForm(), and update().

                                                              : array
    {
        $nodes = [];

        $tree = new ilWorkspaceTree($this->user->getId());
        $root = $tree->getRootId();
        if ($root) {
            $root = $tree->getNodeData($root);
            foreach ($tree->getSubTree($root) as $node) {
                if (in_array($node['type'], self::SUPPORTED_TYPES, true)) {
                    $nodes[$node['obj_id']] = $node;
                }
            }
        }

        return $nodes;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilPCVerificationGUI::initForm ( bool  $a_insert = false )

protected

Definition at line 107 of file class.ilPCVerificationGUI.php.

References $data, ilSubEnabledFormPropertyGUI\addSubItem(), ilRadioOption\addSubItem(), ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), getValidCertificateByIdMap(), getValidWorkspaceCertificateNodeByIdMap(), IL_CAL_UNIX, ILIAS\Repository\lng(), ilFormPropertyGUI\setRequired(), and ilRadioOption\setValue().

Referenced by create(), edit(), insert(), and update().

                                                       : ilPropertyFormGUI
    {
        $this->lng->loadLanguageModule('wsp');

        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));

        $data = [];
        if ($a_insert) {
            $form->setTitle($this->lng->txt('cont_insert_verification'));
            $form->addCommandButton('create_verification', $this->lng->txt('save'));
            $form->addCommandButton('cancelCreate', $this->lng->txt('cancel'));
        } else {
            $form->setTitle($this->lng->txt('cont_update_verification'));
            $form->addCommandButton('update', $this->lng->txt('save'));
            $form->addCommandButton('cancelUpdate', $this->lng->txt('cancel'));
            $data = $this->content_obj->getData();
        }

        $certificateOptions = [];
        foreach ($this->getValidCertificateByIdMap() as $certificate) {
            $userCertificate = $certificate->getUserCertificate();
            $dateTime = ilDatePresentation::formatDate(new ilDateTime(
                $userCertificate->getAcquiredTimestamp(),
                IL_CAL_UNIX
            ));

            $type = $this->lng->txt('wsp_type_' . $userCertificate->getObjType() . 'v');
            if ('sahs' === $userCertificate->getObjType()) {
                $type = $this->lng->txt('wsp_type_scov');
            }
            $additionalInformation = ' (' . $type . ' / ' . $dateTime . ')';
            $certificateOptions[$userCertificate->getObjId()] = $certificate->getObjectTitle() . $additionalInformation;
        }

        if ($a_insert || (isset($data['type']) && 'crta' === $data['type'])) {
            $certificate = new ilSelectInputGUI($this->lng->txt('certificate'), 'persistent_object');
            $certificate->setRequired(true);
            $certificate->setOptions($certificateOptions);
            $form->addItem($certificate);
            if (isset($data['id'])) {
                $certificate->setValue($data['id']);
            }

            return $form;
        }

        $certificateSource = new ilRadioGroupInputGUI(
            $this->lng->txt('certificate_selection'),
            'certificate_selection'
        );

        $workspaceRadioButton = new ilRadioOption(
            $this->lng->txt('certificate_workspace_option'),
            'certificate_workspace_option'
        );
        $persistentRadioButton = new ilRadioOption(
            $this->lng->txt('certificate_persistent_option'),
            'certificate_persistent_option'
        );

        $workspaceCertificates = new ilSelectInputGUI($this->lng->txt('cont_verification_object'), 'object');
        $workspaceCertificates->setRequired(true);
        $workspaceOptions = [];
        foreach ($this->getValidWorkspaceCertificateNodeByIdMap() as $node) {
            $workspaceOptions[$node['obj_id']] = $node['title'] . ' (' . $this->lng->txt('wsp_type_' . $node['type']) . ')';
        }
        asort($workspaceOptions);
        $workspaceCertificates->setOptions($workspaceOptions);

        $certificate = new ilSelectInputGUI($this->lng->txt('cont_verification_object'), 'persistent_object');
        $certificate->setRequired(true);
        $certificate->setOptions($certificateOptions);
        $persistentRadioButton->addSubItem($certificate);
        $workspaceRadioButton->addSubItem($workspaceCertificates);

        $certificateSource->addOption($persistentRadioButton);
        $certificateSource->addOption($workspaceRadioButton);

        $form->addItem($certificateSource);

        $certificateSource->setValue('certificate_workspace_option');
        $workspaceCertificates->setValue($data['id']);

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilPCVerificationGUI::insert

(

?ilPropertyFormGUI

$a_form = null

)

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

References ilPageContentGUI\displayValidationError(), and initForm().

Referenced by create().

                                                             : void
    {
        $this->displayValidationError();

        if (!$a_form) {
            $a_form = $this->initForm(true);
        }
        $this->tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilPCVerificationGUI::update

(

)

Exceptions

JsonException
ilDateTimeException

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

References Vendor\Package\$e, ILIAS\Repository\ctrl(), edit(), getValidCertificateByIdMap(), getValidWorkspaceCertificateNodeByIdMap(), initForm(), ILIAS\Repository\int(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

                            : void
    {
        $form = $this->initForm();
        if ($form->checkInput()) {
            $option = 'certificate_persistent_option';
            if ($form->getItemByPostVar('certificate_selection')) {
                $option = $form->getInput('certificate_selection');
            }

            $oldContentData = $this->content_obj->getData();

            if ('certificate_workspace_option' === $option) {
                $objectId = (int) $form->getInput('object');
                $validWorkSpaceCertificates = $this->getValidWorkspaceCertificateNodeByIdMap();

                if (isset($validWorkSpaceCertificates[$objectId])) {
                    $this->content_obj->setData($validWorkSpaceCertificates[$objectId]['type'], $objectId);
                }
            } elseif ('certificate_persistent_option' === $option) {
                try {
                    $objectId = (int) $form->getInput('persistent_object');
                    $validCertificates = $this->getValidCertificateByIdMap();

                    if (isset($validCertificates[$objectId])) {
                        $certificateFileService = new ilPortfolioCertificateFileService();
                        $certificateFileService->createCertificateFile(
                            $this->user->getId(),
                            $objectId
                        );
                        $this->content_obj->setData('crta', $objectId);
                    }
                } catch (\ILIAS\Filesystem\Exception\FileNotFoundException | \ILIAS\Filesystem\Exception\FileAlreadyExistsException $e) {
                    $this->tpl->setOnScreenMessage('info', $this->lng->txt('certificate_file_not_found_error'), true);
                    $this->log->warning($e->getMessage());
                } catch (\ILIAS\Filesystem\Exception\IOException $e) {
                    $this->tpl->setOnScreenMessage('info', $this->lng->txt('certificate_file_input_output_error'), true);
                    $this->log->warning($e->getMessage());
                } catch (ilException $e) {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('error_creating_certificate_pdf'), true);
                    $this->log->error($e->getMessage());
                    $this->ctrl->redirect($this, 'initForm');
                }
            }

            if ('crta' === $oldContentData['type']) {
                try {
                    $certificateFileService = new ilPortfolioCertificateFileService();
                    $certificateFileService->deleteCertificateFile(
                        $this->user->getId(),
                        (int) $oldContentData['id']
                    );
                } catch (\ILIAS\Filesystem\Exception\FileNotFoundException $e) {
                    $this->tpl->setOnScreenMessage('info', $this->lng->txt('certificate_file_not_found_error'));
                    $this->log->warning($e->getMessage());
                } catch (\ILIAS\Filesystem\Exception\IOException $e) {
                    $this->tpl->setOnScreenMessage('info', $this->lng->txt('certificate_file_input_output_error'));
                    $this->log->warning($e->getMessage());
                }
            }

            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, 'jump' . $this->hier_id);
            }
        }

        $this->pg_obj->addHierIDs();
        $this->edit($form);
    }

Here is the call graph for this function:

Field Documentation

$user

ilObjUser ilPCVerificationGUI::$user

protected

Definition at line 29 of file class.ilPCVerificationGUI.php.

SUPPORTED_TYPES

const ilPCVerificationGUI::SUPPORTED_TYPES = ['excv', 'tstv', 'crsv', 'cmxv', 'ltiv', 'scov']

private

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

---

The documentation for this class was generated from the following file:

• components/ILIAS/COPage/PC/Verification/class.ilPCVerificationGUI.php