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, $a_pc_id="")
	Constructor public. More...
	executeCommand ()
	execute command More...
	insert (ilPropertyFormGUI $a_form=null)
	Insert new verification form. More...
	edit (ilPropertyFormGUI $a_form=null)
	Edit verification form. More...
	create ()
	Create new verification. More...
	update ()
	Update verification. More...
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...
	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 ($a_insert=false)
	Init verification form. More...
Protected Member Functions inherited from ilPageContentGUI
	getCharacteristicsOfCurrentStyle ($a_type)
	Get characteristics of current style. More...

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

Private Member Functions
	initStorage (int $objectId, string $subDirectory='')

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 37 of file class.ilPCVerificationGUI.php.

Constructor & Destructor Documentation

__construct()

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

Constructor public.

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

References $DIC, and user().

    {
        global $DIC;

        $this->tpl = $DIC["tpl"];
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        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

(

)

Create new verification.

Exceptions

ilException

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

References $form, $type, ilObject\_lookupType(), ilPageContentGUI\getPage(), initForm(), insert(), ilUtil\sendFailure(), ilUtil\sendInfo(), and user().

    {
        $form = $this->initForm(true);
        if ($form->checkInput()) {
            $option = $form->getInput('certificate_selection');

            if ('certificate_workspace_option' === $option) {
                $type = ilObject::_lookupType($form->getInput("object"));
                if ($type) {
                    $this->content_obj = new ilPCVerification($this->getPage());
                    $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
                    $verificationObjectId = $form->getInput("object");

                    $this->content_obj->setData($type, $verificationObjectId);

                    $this->updated = $this->pg_obj->update();
                    if ($this->updated === true) {
                        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
                    }
                }
            } elseif ('certificate_persistent_option' === $option) {
                $objectId = $form->getInput("persistent_object");

                $userId = $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());
                    return $this->ctrl->redirect($this, 'initForm');
                } catch (ilException $e) {
                    ilUtil::sendFailure($this->lng->txt('error_creating_certificate_pdf'), true);
                    $this->log->error($e->getMessage());
                    return $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

)

Edit verification form.

Parameters

ilPropertyFormGUI

$a_form

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

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

Referenced by update().

    {
        $tpl = $this->tpl;

        $this->displayValidationError();

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

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPCVerificationGUI::executeCommand

(

)

execute command

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

References $ret.

    {
        // get next class that processes or forwards current command
        $next_class = $this->ctrl->getNextClass($this);

        // get current command
        $cmd = $this->ctrl->getCmd();

        switch ($next_class) {
            default:
                $ret = $this->$cmd();
                break;
        }

        return $ret;
    }

initForm()

ilPCVerificationGUI::initForm (   $a_insert = false )

protected

Init verification form.

Parameters

bool

$a_insert

Returns

ilPropertyFormGUI

Exceptions

ilDateTimeException

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

References $certificate, $certificates, ilPageContentGUI\$ctrl, $data, $form, $ilCtrl, $ilUser, ilPageContentGUI\$lng, $root, $tree, $type, $user, ilSubEnabledFormPropertyGUI\addSubItem(), ilRadioOption\addSubItem(), ilDatePresentation\formatDate(), IL_CAL_UNIX, and ilFormPropertyGUI\setRequired().

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

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        $lng = $this->lng;

        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this));
        if ($a_insert) {
            $form->setTitle($this->lng->txt("cont_insert_verification"));
        } else {
            $form->setTitle($this->lng->txt("cont_update_verification"));
        }

        $lng->loadLanguageModule("wsp");
        $workspaceOptions = array();

        $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');

        $tree = new ilWorkspaceTree($ilUser->getId());
        $root = $tree->getRootId();
        if ($root) {
            $root = $tree->getNodeData($root);
            foreach ($tree->getSubTree($root) as $node) {
                if (in_array($node["type"], array("excv", "tstv", "crsv", "scov"))) {
                    $workspaceOptions[$node["obj_id"]] = $node["title"] . " (" . $lng->txt("wsp_type_" . $node["type"]) . ")";
                }
            }
            asort($workspaceOptions);
        }

        $workspaceCertificates = new ilSelectInputGUI($this->lng->txt("cont_verification_object"), "object");
        $workspaceCertificates->setRequired(true);
        $workspaceCertificates->setOptions($workspaceOptions);

        $repository = new ilUserCertificateRepository();

        $certificates = $repository->fetchActiveCertificates($ilUser->getId());

        $persistentOptions = array();
        foreach ($certificates as $certificate) {
            $userCertificate = $certificate->getUserCertificate();
            $dateTime = ilDatePresentation::formatDate(new ilDateTime($userCertificate->getAcquiredTimestamp(), IL_CAL_UNIX));

            $type = $lng->txt("wsp_type_" . $userCertificate->getObjType() . 'v');
            $additionalInformation = ' (' . $type . ' / ' . $dateTime . ')';
            $persistentOptions[$userCertificate->getObjId()] = $certificate->getObjectTitle() . $additionalInformation;
        }

        $persistentObject = new ilSelectInputGUI($this->lng->txt("cont_verification_object"), "persistent_object");
        $persistentObject->setRequired(true);
        $persistentObject->setOptions($persistentOptions);

        $persistentRadioButton->addSubItem($persistentObject);
        $workspaceRadioButton->addSubItem($workspaceCertificates);

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

        $certificateSource->setValue('certificate_persistent_option');

        $form->addItem($certificateSource);

        if ($a_insert) {
            $form->addCommandButton("create_verification", $this->lng->txt("save"));
            $form->addCommandButton("cancelCreate", $this->lng->txt("cancel"));
        } else {
            $data = $this->content_obj->getData();

            if ($data['type'] === 'crta') {
                $certificateSource->setValue('certificate_persistent_option');
                $persistentObject->setValue($data["id"]);
            } else {
                $certificateSource->setValue('certificate_workspace_option');
                $workspaceCertificates->setValue($data["id"]);
            }


            $form->addCommandButton("update", $this->lng->txt("save"));
            $form->addCommandButton("cancelUpdate", $this->lng->txt("cancel"));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initStorage()

ilPCVerificationGUI::initStorage ( int  $objectId, string  $subDirectory = ''  )

private

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

References $path.

    {
        $storage = new ilVerificationStorageFile($objectId);
        $storage->create();

        $path = $storage->getAbsolutePath() . "/";

        if ($subDirectory !== '') {
            $path .= $subDirectory . "/";

            if (!is_dir($path)) {
                mkdir($path);
            }
        }

        return $path;
    }

insert()

ilPCVerificationGUI::insert

(

ilPropertyFormGUI

$a_form = null

)

Insert new verification form.

Parameters

ilPropertyFormGUI

$a_form

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

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

Referenced by create().

    {
        $tpl = $this->tpl;

        $this->displayValidationError();

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

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilPCVerificationGUI::update

(

)

Update verification.

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

References $form, $type, ilObject\_lookupType(), edit(), initForm(), ilUtil\sendFailure(), ilUtil\sendInfo(), and user().

    {
        $form = $this->initForm(true);
        if ($form->checkInput()) {
            $option = $form->getInput('certificate_selection');
            if ('certificate_workspace_option' === $option) {
                $object = $form->getInput("object");
                $type = ilObject::_lookupType($object);
                if ($type) {
                    $oldContentData = $this->content_obj->getData();

                    if ('crta' === $oldContentData['type']) {
                        $userId = $this->user->getId();
                        $oldObjectId = $oldContentData['id'];

                        $certificateFileService = new ilPortfolioCertificateFileService();
                        try {
                            $certificateFileService->deleteCertificateFile($userId, $oldObjectId);
                        } 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->content_obj->setData($type, $object);
                    $this->updated = $this->pg_obj->update();
                    if ($this->updated === true) {
                        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
                    }
                }
            } elseif ('certificate_persistent_option' === $option) {
                $oldContentData = $this->content_obj->getData();

                $objectId = $form->getInput("persistent_object");

                $certificateFileService = new ilPortfolioCertificateFileService();

                try {
                    $userId = $this->user->getId();

                    $certificateFileService->createCertificateFile($userId, $objectId);
                    if ('crta' === $oldContentData['type']) {
                        $oldObjectId = $oldContentData['id'];
                        $certificateFileService->deleteCertificateFile($userId, $oldObjectId);
                    }
                } 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());
                    return $this->ctrl->redirect($this, 'initForm');
                }

                $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->pg_obj->addHierIDs();
        $this->edit($form);
    }

Here is the call graph for this function:

Field Documentation

$user

ilPCVerificationGUI::$user

protected

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

Referenced by initForm().

---

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

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