ilPCVerificationGUI Class Reference

Class ilPCVerificationGUI. More...

Inheritance diagram for ilPCVerificationGUI:

Collaboration diagram for ilPCVerificationGUI:

Public Member Functions
	__construct ($a_pg_obj, $a_content_obj, $a_hier_id=0, $a_pc_id="")
	executeCommand ()
	insert (ilPropertyFormGUI $a_form=null)
	edit (ilPropertyFormGUI $a_form=null)
	create ()
	update ()
Public Member Functions inherited from ilPageContentGUI
	__construct ($a_pg_obj, $a_content_obj, $a_hier_id=0, $a_pc_id="")
	Constructor public. More...
	setContentObject ($a_val)
	Set content object. More...
	getContentObject ()
	Get content object. More...
	setPage ($a_val)
	Set page. More...
	getPage ()
	Get page. More...
	setPageConfig ($a_val)
	Set Page Config. More...
	getPageConfig ()
	Get Page Config. More...
	setStyleId ($a_styleid)
	Set Style Id. More...
	getStyleId ()
	Get Style Id. More...
	getStyle ()
	Get style object. More...
	getCharacteristicsOfCurrentStyle ($a_type)
	Get characteristics of current style. More...
	setCharacteristics ($a_chars)
	Set Characteristics. More...
	getCharacteristics ()
	Get characteristics. More...
	getHierId ()
	get hierarchical id in dom object More...
	setHierId ($a_hier_id)
	get hierarchical id in dom object More...
	getBBMenu ($a_ta_name="par_content")
	Get the bb menu incl. More...
	delete ()
	delete content element More...
	moveAfter ()
	move content element after another element More...
	moveBefore ()
	move content element before another element More...
	splitPage ()
	split page to new page at specified position More...
	splitPageNext ()
	split page to next page at specified position More...
	displayValidationError ()
	display validation errors More...
	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 ($a_type)
	Get table templates. More...

Protected Member Functions
	initForm (bool $a_insert=false)
Protected Member Functions inherited from ilPageContentGUI
	redirectToParent ($hier_id="")
	Redirect to parent. More...
	getParentReturn ($hier_id="")

Protected Attributes
	$user
Protected Attributes inherited from ilPageContentGUI
	$error
	$log

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 ()
	Get common bb buttons. More...
Data Fields inherited from ilPageContentGUI
	$content_obj
	$tpl
	$lng
	$ctrl
	$pg_obj
	$hier_id
	$dom
	$updated
	$target_script
	$return_location
	$page_config = null
Static Public Attributes inherited from ilPageContentGUI
static	$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	$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

Version

$I$

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

Constructor & Destructor Documentation

__construct()

ilPCVerificationGUI::__construct	(		$a_pg_obj,
			$a_content_obj,
			$a_hier_id = 0,
			$a_pc_id = ""
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and 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

(

)

Exceptions

ilDateTimeException

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

References Vendor\Package\$e, ilPageContentGUI\getPage(), initForm(), insert(), ilUtil\sendFailure(), ilUtil\sendInfo(), and user().

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

            $certificateFileService = new ilPortfolioCertificateFileService();
            try {
                $certificateFileService->createCertificateFile($userId, $objectId);
            } catch (\ILIAS\Filesystem\Exception\FileAlreadyExistsException $e) {
                ilUtil::sendInfo($this->lng->txt('certificate_file_not_found_error'), true);
                $this->log->warning($e->getMessage());
            } catch (\ILIAS\Filesystem\Exception\IOException $e) {
                ilUtil::sendInfo($this->lng->txt('certificate_file_input_output_error'), true);
                $this->log->error($e->getMessage());
                $this->ctrl->redirect($this, 'initForm');
            } catch (ilException $e) {
                ilUtil::sendFailure($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:

edit()

ilPCVerificationGUI::edit

(

ilPropertyFormGUI

$a_form = null

)

Parameters

ilPropertyFormGUI | null

$a_form

Exceptions

ilDateTimeException

Definition at line 56 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 32 of file class.ilPCVerificationGUI.php.

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

getValidCertificateByIdMap()

ilPCVerificationGUI::getValidCertificateByIdMap ( )

private

Returns

array<int, ilUserCertificatePresentation>

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

References user().

Referenced by initForm(), and update().

                                                  : array
    {
        $certificates = [];

        $repository = new ilUserCertificateRepository();
        $activeCertificates = $repository->fetchActiveCertificates((int) $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 69 of file class.ilPCVerificationGUI.php.

References ilTree\getNodeData(), ilTree\getRootId(), and 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)) {
                    $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

Parameters

false

$a_insert

Returns

ilPropertyFormGUI

Exceptions

ilDateTimeException

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

References $data, $type, ilSubEnabledFormPropertyGUI\addSubItem(), ilRadioOption\addSubItem(), ilDatePresentation\formatDate(), getValidCertificateByIdMap(), getValidWorkspaceCertificateNodeByIdMap(), IL_CAL_UNIX, 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

)

Parameters

ilPropertyFormGUI | null

$a_form

Exceptions

ilDateTimeException

Definition at line 42 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

ilDateTimeException

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

References Vendor\Package\$e, edit(), getValidCertificateByIdMap(), getValidWorkspaceCertificateNodeByIdMap(), initForm(), ilUtil\sendFailure(), ilUtil\sendInfo(), and 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(
                            (int) $this->user->getId(),
                            $objectId
                        );
                        $this->content_obj->setData('crta', $objectId);
                    }
                } catch (\ILIAS\Filesystem\Exception\FileNotFoundException $e) {
                    ilUtil::sendInfo($this->lng->txt('certificate_file_not_found_error'), true);
                    $this->log->warning($e->getMessage());
                } catch (\ILIAS\Filesystem\Exception\FileAlreadyExistsException $e) {
                    ilUtil::sendInfo($this->lng->txt('certificate_file_not_found_error'), true);
                    $this->log->warning($e->getMessage());
                } catch (\ILIAS\Filesystem\Exception\IOException $e) {
                    ilUtil::sendInfo($this->lng->txt('certificate_file_input_output_error'), true);
                    $this->log->warning($e->getMessage());
                } catch (ilException $e) {
                    ilUtil::sendFailure($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(
                        (int) $this->user->getId(),
                        (int) $oldContentData['id']
                    );
                } catch (\ILIAS\Filesystem\Exception\FileNotFoundException $e) {
                    ilUtil::sendInfo($this->lng->txt('certificate_file_not_found_error'));
                    $this->log->warning($e->getMessage());
                } catch (\ILIAS\Filesystem\Exception\IOException $e) {
                    ilUtil::sendInfo($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

ilPCVerificationGUI::$user

protected

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

SUPPORTED_TYPES

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

private

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

---

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

• Services/COPage/classes/class.ilPCVerificationGUI.php