Certificate Settings. More...

Inheritance diagram for ilObjCertificateSettingsGUI:

Collaboration diagram for ilObjCertificateSettingsGUI:

Public Member Functions
	__construct ( $data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true, ?ilUserCertificateRepository $user_certificate_repo=null, ?ilCertificateActiveValidator $certificate_active_validator=null,)

	executeCommand ()

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	settings ()

	certificatesOverview ()

	downloadCertificate ()

	save ()

Public Member Functions inherited from ilObjectGUI
	getRefId ()

	setAdminMode (string $mode)

	getAdminMode ()

	getObject ()

	executeCommand ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelObject ()
	cancel action and go back to previous page More...

	createObject ()
	create new object form More...

	editAvailabilityPeriodObject ()

	saveAvailabilityPeriodObject ()

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()

	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()

	addExternalEditFormCustom (ilPropertyFormGUI $form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...

	isVisible (int $ref_id, string $type)

	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...

	setColumnSettings (ilColumnGUI $column_gui)

	addToDeskObject ()

	removeFromDeskObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Data Fields
const	TAB_CERTIFICATES = 'certificates'

const	CMD_CERTIFICATES_OVERVIEW = 'certificatesOverview'

const	CMD_DOWNLOAD_CERTIFICATE = 'downloadCertificate'

Data Fields inherited from ilObjectGUI
const	ADMIN_MODE_NONE = ""

const	ADMIN_MODE_SETTINGS = "settings"

const	ADMIN_MODE_REPOSITORY = "repository"

const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

const	SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]

Protected Attributes
ILIAS HTTP GlobalHttpState	$httpState

ILIAS FileUpload FileUpload	$upload

ilObject	$object

Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service

GlobalHttpState	$http

ServerRequestInterface	$request

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilSetting	$settings

ilToolbarGUI	$toolbar

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

ilObjectService	$object_service

ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilCtrl	$ctrl

ilErrorHandling	$error

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ILIAS	$ilias

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Refinery	$refinery

ilFavouritesManager	$favourites

CustomIconFactory	$custom_icon_factory

UIFactory	$ui_factory

UIRenderer	$ui_renderer

Filesystem	$temp_file_system

ilObject	$object = null

bool	$creation_mode = false

	$data

int	$id

bool	$call_by_reference = false

bool	$prepare_output

int	$ref_id

int	$obj_id

int	$maxcount

array	$form_action = []

array	$return_location = []

array	$target_frame = []

string	$tmp_import_dir

string	$sub_objects = ""

bool	$omit_locator = false

string	$type = ""

string	$admin_mode = self::ADMIN_MODE_NONE

int	$requested_ref_id = 0

int	$requested_crtptrefid = 0

int	$requested_crtcb = 0

string	$requested_new_type = ""

string	$link_params

string	$html = ""

Private Attributes
IRSS	$irss

readonly ilLogger	$logger

readonly ilUserCertificateRepository	$user_certificate_repo

readonly ilCertificateActiveValidator	$certificate_active_validator

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode (int $ref_id, string $cmd="")

static	_gotoSharedWorkspaceNode (int $wsp_id)

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	createActionDispatcherGUI ()

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...

	addHeaderAction ()
	Add header action menu. More...

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	setTabs ()
	set admin tabs More...

	setAdminTabs ()
	set admin tabs More...

	setLocator ()

	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...

	omitLocator (bool $omit=true)

	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	getCreationFormsHTML (StandardForm\|ilPropertyFormGUI\|array $form)

	getTitleForCreationFormPage ()

	getCreationFormTitle ()

	initCreateForm (string $new_type)

	didacticTemplatesToForm ()

	initDidacticTemplate (ilPropertyFormGUI $form)

	retrieveAdditionalDidacticTemplateOptions ()

	addAdoptContentLinkToToolbar ()

	addImportButtonToToolbar ()

	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)

	parseDidacticTemplateVar (string $var, string $type)

	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...

	initEditForm ()

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	routeImportCmdObject ()

	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)

	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)

	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...

	setFormAction (string $cmd, string $form_action)

	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	getTabs ()
	@abstract overwrite in derived GUI class of your object type More...

	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

	getCreatableObjectTypes ()

	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)

	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Detailed Description

Certificate Settings.

Author: Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de

Version: $Id$ @ilCtrl_Calls ilObjCertificateSettingsGUI: ilPermissionGUI @ilCtrl_IsCalledBy ilObjCertificateSettingsGUI: ilAdministrationGUI

Definition at line 33 of file class.ilObjCertificateSettingsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjCertificateSettingsGUI::__construct	(		$data,
		int	$id = `0`,
		bool	$call_by_reference = `true`,
		bool	$prepare_output = `true`,
		?ilUserCertificateRepository	$user_certificate_repo = `null`,
		?ilCertificateActiveValidator	$certificate_active_validator = `null`
	)

Definition at line 48 of file class.ilObjCertificateSettingsGUI.php.

      {
        global $DIC;
 
        parent::__construct($data, $id, $call_by_reference, $prepare_output);
 
        $this->httpState = $DIC->http();
        $this->upload = $DIC->upload();
        $this->logger = $DIC->logger()->root();
        $this->type = 'cert';
        $this->lng->loadLanguageModule('certificate');
        $this->lng->loadLanguageModule('cert');
        $this->lng->loadLanguageModule('trac');
 
        $this->irss = $DIC->resourceStorage();
 
        $this->user_certificate_repo = $user_certificate_repo ?: new ilUserCertificateRepository();
        $this->certificate_active_validator = $certificate_active_validator ?: new ilCertificateActiveValidator();
    }

References ilObjectGUI\$call_by_reference, $certificate_active_validator, ilObjectGUI\$data, $DIC, ilObjectGUI\$id, ilObjectGUI\$prepare_output, $user_certificate_repo, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), and ILIAS\Repository\upload().

Here is the call graph for this function:

Member Function Documentation

◆ certificatesOverview()

ilObjCertificateSettingsGUI::certificatesOverview ( )

Definition at line 249 of file class.ilObjCertificateSettingsGUI.php.

                                          : void
    {
        if (
            !$this->certificate_active_validator->validate() ||
            !$this->rbac_system->checkAccess('read', $this->object->getRefId())
        ) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->WARNING);
        }
 
        $this->tabs_gui->activateTab(self::TAB_CERTIFICATES);
 
        $table = new CertificateOverviewTable();
 
        $this->tpl->setContent($table->render());
    }

References error(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ downloadCertificate()

ilObjCertificateSettingsGUI::downloadCertificate ( )

Definition at line 265 of file class.ilObjCertificateSettingsGUI.php.

                                         : void
    {
        if (
            !$this->certificate_active_validator->validate() ||
            !$this->rbac_system->checkAccess('read', $this->object->getRefId())
        ) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->WARNING);
        }
 
        $certificate_id = $this->httpState->wrapper()->query()->retrieve(
            'cert_overview_id',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int()),
                $this->refinery->always([]),
            ])
        );
 
        if ($certificate_id === []) {
            $this->ctrl->redirect($this, self::CMD_CERTIFICATES_OVERVIEW);
        }
 
        // Only one download at a time is possible
        $certificate_id = $certificate_id[array_key_first($certificate_id)];
 
        try {
            $user_certificate = $this->user_certificate_repo->fetchCertificate($certificate_id);
            if (!$user_certificate->isCurrentlyActive()) {
                throw new Exception('Certificate is not active');
            }
        } catch (Exception $ex) {
            $this->logger->error('Fetching user certificate for download failed. Ex.: ' . $ex->getMessage());
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('error_creating_certificate_pdf'), true);
            $this->ctrl->redirect($this, self::CMD_CERTIFICATES_OVERVIEW);
        }
 
        $pdf_generator = new ilPdfGenerator($this->user_certificate_repo);
 
        $pdf_action = new ilCertificatePdfAction(
            $pdf_generator,
            new ilCertificateUtilHelper(),
            $this->lng->txt('error_creating_certificate_pdf')
        );
 
        $pdf_action->downloadPdf($user_certificate->getUserId(), $user_certificate->getObjId());
        $this->ctrl->redirect($this, self::CMD_CERTIFICATES_OVERVIEW);
    }

References ILIAS\Repository\ctrl(), error(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ executeCommand()

ilObjCertificateSettingsGUI::executeCommand ( )

Reimplemented from ilObjectGUI.

Definition at line 74 of file class.ilObjCertificateSettingsGUI.php.

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this) ?? '';
        $cmd = $this->ctrl->getCmd();
 
        $this->prepareOutput();
 
        if (!$this->rbac_system->checkAccess('read', $this->object->getRefId())) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }
 
        switch (strtolower($next_class)) {
            case strtolower(ilPermissionGUI::class):
                $this->tabs_gui->setTabActive('perm_settings');
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
 
                break;
            default:
                if (!$cmd || $cmd === 'view') {
                    $cmd = 'settings';
                }
 
                $this->$cmd();
 
                break;
        }
    }

References ILIAS\Repository\ctrl(), error(), ILIAS\Repository\lng(), and ilObjectGUI\prepareOutput().

Here is the call graph for this function:

◆ getAdminTabs()

ilObjCertificateSettingsGUI::getAdminTabs ( )

administration tabs show only permissions and trash folder

Reimplemented from ilObjectGUI.

Definition at line 103 of file class.ilObjCertificateSettingsGUI.php.

                                  : void
    {
        if ($this->certificate_active_validator->validate() && $this->rbac_system->checkAccess('read', $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                self::TAB_CERTIFICATES,
                $this->lng->txt('overview'),
                $this->ctrl->getLinkTarget($this, self::CMD_CERTIFICATES_OVERVIEW)
            );
        }
 
        if ($this->rbac_system->checkAccess('visible,read', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                'settings',
                $this->ctrl->getLinkTarget($this, 'settings'),
                ['settings', 'view']
            );
        }
 
        if ($this->rbac_system->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                'perm_settings',
                $this->ctrl->getLinkTargetByClass(ilPermissionGUI::class, 'perm'),
                [],
                strtolower(ilPermissionGUI::class)
            );
        }
    }

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

Here is the call graph for this function:

◆ save()

ilObjCertificateSettingsGUI::save ( )

Definition at line 312 of file class.ilObjCertificateSettingsGUI.php.

                          : void
    {
        $form_settings = new ilSetting('certificate');
 
        $mode = $this->httpState->wrapper()->post()->retrieve(
            'persistent_certificate_mode',
            $this->refinery->kindlyTo()->string()
        );
        $previousMode = $form_settings->get('persistent_certificate_mode', 'persistent_certificate_mode_cron');
        if ($mode !== $previousMode && $mode === 'persistent_certificate_mode_instant') {
            $cron = new ilCertificateCron();
            $cron->init();
            $cron->run();
        }
 
        $form_settings->set(
            'pageformat',
            $this->httpState->wrapper()->post()->retrieve('pageformat', $this->refinery->kindlyTo()->string())
        );
        $form_settings->set(
            'active',
            (string) ($this->httpState->wrapper()->post()->has('active') && $this->httpState->wrapper()->post()->retrieve(
                'active',
                $this->refinery->kindlyTo()->bool()
            ))
        );
        $form_settings->set('persistent_certificate_mode', $mode);
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'));
        $this->settings();
    }

References $cron, ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and settings().

Here is the call graph for this function:

◆ settings()

ilObjCertificateSettingsGUI::settings ( )

Definition at line 131 of file class.ilObjCertificateSettingsGUI.php.

                              : void
    {
        $this->tabs_gui->setTabActive('settings');
        $form_settings = new ilSetting('certificate');
 
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('certificate_settings'));
 
        $active = new ilCheckboxInputGUI($this->lng->txt('active'), 'active');
        $active->setChecked((bool) $form_settings->get('active', '0'));
        $form->addItem($active);
 
        $info = new ilNonEditableValueGUI($this->lng->txt('info'), 'info');
        $info->setValue($this->lng->txt('certificate_usage'));
        $form->addItem($info);
 
        $bgimage = new ilImageFileInputGUI($this->lng->txt('certificate_background_image'), 'background');
        $bgimage->setRequired(false);
 
        if (strcmp($this->ctrl->getCmd(), 'save') === 0) {
            $backgroundDelete = $this->httpState->wrapper()->post()->has('background_delete') && $this->httpState->wrapper()->post()->retrieve(
                'background_delete',
                $this->refinery->kindlyTo()->bool()
            );
            if ($backgroundDelete) {
                $this->object->deleteBackgroundImage();
            }
        }
 
        if (
            $this->upload->hasUploads() &&
            $this->httpState->request()->getMethod() === 'POST' &&
            $bgimage->checkInput()
        ) {
            if (!$this->upload->hasBeenProcessed()) {
                $this->upload->process();
            }
 
            if (is_array($this->upload->getResults()) && $this->upload->getResults() !== []) {
                $results = $this->upload->getResults();
                $file = array_pop($results);
                if ($file->isOK()) {
                    $result = $this->object->uploadBackgroundImage($file);
                    if ($result === false) {
                        $bgimage->setAlert($this->lng->txt('certificate_error_upload_bgimage'));
                    }
                }
            }
        }
 
        if ($this->object->hasBackgroundImage()) {
            $rid = $this->object->getBackgroundImageIdentification();
            if ($rid instanceof ResourceIdentification) {
                $bgimage->setImage($this->irss->consume()->src($rid)->getSrc(true));
            } elseif (is_string($rid)) {
                $bgimage->setImage($rid);
            }
        }
        $bgimage->setInfo($this->lng->txt('default_background_info'));
        $form->addItem($bgimage);
        $format = new ilSelectInputGUI($this->lng->txt('certificate_page_format'), 'pageformat');
        $defaultformats = [
            'a4' => $this->lng->txt('certificate_a4'), // (297 mm x 210 mm)
            'a4landscape' => $this->lng->txt('certificate_a4_landscape'), // (210 mm x 297 mm)',
            'a5' => $this->lng->txt('certificate_a5'), // (210 mm x 148.5 mm)
            'a5landscape' => $this->lng->txt('certificate_a5_landscape'), // (148.5 mm x 210 mm)
            'letter' => $this->lng->txt('certificate_letter'), // (11 inch x 8.5 inch)
            'letterlandscape' => $this->lng->txt('certificate_letter_landscape') // (11 inch x 8.5 inch)
        ];
        $format->setOptions($defaultformats);
        $format->setValue($form_settings->get('pageformat', ''));
        $format->setInfo($this->lng->txt('certificate_page_format_info'));
        $form->addItem($format);
 
        if ($this->rbac_system->checkAccess('write', $this->object->getRefId())) {
            $form->addCommandButton('save', $this->lng->txt('save'));
        }
 
        if (!ilObjUserTracking::_enabledLearningProgress()) {
            ilAdministrationSettingsFormHandler::addFieldsToForm(
                ilAdministrationSettingsFormHandler::FORM_CERTIFICATE,
                $form,
                $this
            );
        }
 
        $persistentCertificateMode = new ilRadioGroupInputGUI(
            $this->lng->txt('persistent_certificate_mode'),
            'persistent_certificate_mode'
        );
        $persistentCertificateMode->setRequired(true);
 
        $cronJobMode = new ilRadioOption(
            $this->lng->txt('persistent_certificate_mode_cron'),
            'persistent_certificate_mode_cron'
        );
        $cronJobMode->setInfo($this->lng->txt('persistent_certificate_mode_cron_info'));
 
        $instantMode = new ilRadioOption(
            $this->lng->txt('persistent_certificate_mode_instant'),
            'persistent_certificate_mode_instant'
        );
        $instantMode->setInfo($this->lng->txt('persistent_certificate_mode_instant_info'));
 
        $persistentCertificateMode->addOption($cronJobMode);
        $persistentCertificateMode->addOption($instantMode);
 
        $persistentCertificateMode->setValue($form_settings->get(
            'persistent_certificate_mode',
            'persistent_certificate_mode_cron'
        ));
 
        $form->addItem($persistentCertificateMode);
 
        $this->tpl->setContent($form->getHTML());
    }