@ilCtrl_Calls ilObjBadgeAdministrationGUI: ilPermissionGUI, ilBadgeManagementGUI @ilCtrl_IsCalledBy ilObjBadgeAdministrationGUI: ilAdministrationGUI More...

Inheritance diagram for ilObjBadgeAdministrationGUI:

Collaboration diagram for ilObjBadgeAdministrationGUI:

Public Member Functions
	__construct ( $a_data, int $a_id, bool $a_call_by_reference=true, bool $a_prepare_output=true)

	executeCommand ()

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

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

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)

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

Data Fields
const string	TABLE_ALL_OBJECTS_ACTION = 'ALL_OBJECTS'

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]

Private Member Functions
	getTableAction ()

	handleTableActionsCmd ()

	assertActive ()

	editSettingsCmd (?ilPropertyFormGUI $a_form=null)

	saveSettingsCmd ()

	initFormSettings ()

	listTypesCmd ()

	activateTypes ()

	deactivateTypes ()

	listImageTemplatesCmd ()

	addImageTemplateCmd (?ilPropertyFormGUI $a_form=null)

	initImageTemplateForm (string $a_mode)

	saveImageTemplateCmd ()

	editImageTemplate (?ilPropertyFormGUI $a_form=null)

	setImageTemplateFormValues (ilPropertyFormGUI $a_form, ilBadgeImageTemplate $a_tmpl)

	updateImageTemplateCmd ()

	confirmDeleteImageTemplates ()

	deleteImageTemplatesCmd ()

	listObjectBadgeUsers ()

	listObjectBadgesCmd ()

	getObjectBadgesFromMultiAction ()

	toggleObjectBadges (bool $a_status)

	activateObjectBadges ()

	deactivateObjectBadges ()

	confirmDeleteObjectBadges ()

	deleteObjectBadgesCmd ()

Private Attributes
const string	LIST_TYPES_ACTION = 'listTypes'

const string	LIST_IMG_TPL_ACTION = 'listImageTemplates'

const string	LIST_OBJ_BADGES_ACTION = 'listObjectBadges'

const string	EDIT_SETTINGS_ACTION = 'editSettings'

const string	SAVE_SETTINGS_ACTION = 'saveSettings'

const string	SAVE_IMG_TPL_ACTION = 'saveImageTemplate'

const string	UPDATE_IMG_TPL_ACTION = 'updateImageTemplate'

const string	ADD_IMG_TPL_ACTION = 'addImageTemplate'

const string	DELETE_IMG_TPL_ACTION = 'deleteImageTemplates'

const string	DELETE_OBJ_BADGES_ACTION = 'deleteObjectBadges'

const string	DEFAULT_ACTION = self::EDIT_SETTINGS_ACTION

const string	TABLE_ACTIONS = 'handleTableActions'

ilRbacSystem	$rbacsystem

ilBadgeGUIRequest	$badge_request

ilTabsGUI	$tabs

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)

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 = ""

Detailed Description

@ilCtrl_Calls ilObjBadgeAdministrationGUI: ilPermissionGUI, ilBadgeManagementGUI @ilCtrl_IsCalledBy ilObjBadgeAdministrationGUI: ilAdministrationGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjBadgeAdministrationGUI::__construct	(		$a_data,
		int	$a_id,
		bool	$a_call_by_reference = `true`,
		bool	$a_prepare_output = `true`
	)

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

      {
        global $DIC;
 
        $this->rbacsystem = $DIC->rbac()->system();
        $this->ctrl = $DIC->ctrl();
        $this->access = $DIC->access();
        $this->lng = $DIC->language();
        $this->toolbar = $DIC->toolbar();
        $this->tpl = $DIC['tpl'];
        $this->tabs = $DIC->tabs();
        $this->type = 'bdga';
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
 
        $this->badge_request = new ilBadgeGUIRequest(
            $DIC->http(),
            $DIC->refinery()
        );
 
        $this->lng->loadLanguageModule('badge');
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Member Function Documentation

◆ activateObjectBadges()

ilObjBadgeAdministrationGUI::activateObjectBadges ( )

private

Definition at line 658 of file class.ilObjBadgeAdministrationGUI.php.

                                           : void
    {
        $this->toggleObjectBadges(true);
    }

Referenced by handleTableActionsCmd().

Here is the caller graph for this function:

◆ activateTypes()

ilObjBadgeAdministrationGUI::activateTypes ( )

private

Definition at line 264 of file class.ilObjBadgeAdministrationGUI.php.

                                    : void
    {
        $this->assertActive();
 
        $tmpl_ids = $this->badge_request->getMultiActionBadgeIdsFromUrl();
        if ($this->checkPermissionBool('write') && count($tmpl_ids) > 0) {
            $handler = ilBadgeHandler::getInstance();
            $change_state = [];
            foreach ($handler->getInactiveTypes() as $type) {
                if (!in_array($type, $tmpl_ids)) {
                    $change_state[] = $type;
                }
            }
 
            if (current($tmpl_ids) === self::TABLE_ALL_OBJECTS_ACTION) {
                $handler->setInactiveTypes([]);
            } else {
                $handler->setInactiveTypes($change_state);
            }
 
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('settings_saved'), true);
        }
 
        $this->ctrl->redirect($this, self::LIST_TYPES_ACTION);
    }

References $handler, ilObjectGUI\$type, assertActive(), ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ilBadgeHandler\getInstance(), and ILIAS\Repository\lng().

Referenced by handleTableActionsCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addImageTemplateCmd()

ilObjBadgeAdministrationGUI::addImageTemplateCmd ( ?ilPropertyFormGUI $a_form = null )

private

Definition at line 345 of file class.ilObjBadgeAdministrationGUI.php.

     : void {
        $this->checkPermission('write');
 
        $this->assertActive();
        $this->tabs_gui->setTabActive('imgtmpl');
 
        if (!$a_form) {
            $a_form = $this->initImageTemplateForm('create');
        }
 
        $this->tpl->setContent($a_form->getHTML());
    }

◆ assertActive()

ilObjBadgeAdministrationGUI::assertActive ( )

private

Definition at line 191 of file class.ilObjBadgeAdministrationGUI.php.

                                   : void
    {
        if (!ilBadgeHandler::getInstance()->isActive()) {
            $this->ctrl->redirect($this, self::DEFAULT_ACTION);
        }
    }

References ILIAS\Repository\ctrl(), and ilBadgeHandler\getInstance().

Referenced by activateTypes(), deactivateTypes(), executeCommand(), listImageTemplatesCmd(), and listTypesCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDeleteImageTemplates()

ilObjBadgeAdministrationGUI::confirmDeleteImageTemplates ( )

private

Definition at line 524 of file class.ilObjBadgeAdministrationGUI.php.

                                                  : void
    {
        $this->checkPermission('write');
 
        $tmpl_ids = $this->badge_request->getBadgeAssignableUsers();
        if ($tmpl_ids === [self::TABLE_ALL_OBJECTS_ACTION]) {
            $tmpl_ids = [];
            foreach (ilBadgeImageTemplate::getInstances() as $template) {
                $tmpl_ids[] = $template->getId();
            }
        }
 
        if (!$tmpl_ids) {
            $this->ctrl->redirect($this, self::LIST_IMG_TPL_ACTION);
        }
 
        $this->tabs->clearTargets();
        $this->tabs->setBackTarget(
            $this->lng->txt('back'),
            $this->ctrl->getLinkTarget($this, self::LIST_IMG_TPL_ACTION)
        );
 
        $confirmation_gui = new ilConfirmationGUI();
        $confirmation_gui->setFormAction($this->ctrl->getFormAction($this));
        $confirmation_gui->setHeaderText($this->lng->txt('badge_template_deletion_confirmation'));
        $confirmation_gui->setCancel($this->lng->txt('cancel'), self::LIST_IMG_TPL_ACTION);
        $confirmation_gui->setConfirm($this->lng->txt('delete'), self::DELETE_IMG_TPL_ACTION);
 
        foreach ($tmpl_ids as $tmpl_id) {
            $tmpl = new ilBadgeImageTemplate($tmpl_id);
            $confirmation_gui->addItem('id[]', $tmpl_id, $tmpl->getTitle());
        }
 
        $this->tpl->setContent($confirmation_gui->getHTML());
    }

References ILIAS\Repository\ctrl(), ilBadgeImageTemplate\getInstances(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by handleTableActionsCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDeleteObjectBadges()

ilObjBadgeAdministrationGUI::confirmDeleteObjectBadges ( )

private

Definition at line 668 of file class.ilObjBadgeAdministrationGUI.php.

                                                : void
    {
        $badge_ids = $this->badge_request->getMultiActionBadgeIdsFromUrl();
 
        $this->tabs->clearTargets();
        $this->tabs->setBackTarget(
            $this->lng->txt('back'),
            $this->ctrl->getLinkTarget($this, self::LIST_OBJ_BADGES_ACTION)
        );
 
        $confirmation_gui = new ilConfirmationGUI();
        $confirmation_gui->setFormAction($this->ctrl->getFormAction($this));
        $confirmation_gui->setHeaderText($this->lng->txt('badge_deletion_confirmation'));
        $confirmation_gui->setCancel($this->lng->txt('cancel'), self::LIST_OBJ_BADGES_ACTION);
        $confirmation_gui->setConfirm($this->lng->txt('delete'), self::DELETE_OBJ_BADGES_ACTION);
 
        if ($badge_ids === [self::TABLE_ALL_OBJECTS_ACTION]) {
            $badge_ids = [];
            $filter = [
                'type' => '',
                'title' => '',
                'object' => ''
            ];
            foreach (ilBadge::getObjectInstances($filter) as $badge_item) {
                $badge_ids[] = $badge_item['id'];
            }
        }
        foreach ($badge_ids as $badge_id) {
            $badge = new ilBadge($badge_id);
            $parent = $badge->getParentMeta();
 
            $container = '(' . $parent['type'] . '/' .
                $parent['id'] . ') ' .
                $parent['title'];
            if ($parent['deleted']) {
                $container .= ' <span class="il_ItemAlertProperty">' . $this->lng->txt('deleted') . '</span>';
            }
 
            $confirmation_gui->addItem(
                'id[]',
                $badge_id,
                $container . ' - ' .
                $badge->getTitle() .
                ' (' . count(ilBadgeAssignment::getInstancesByBadgeId($badge_id)) . ')'
            );
        }
 
        $this->tpl->setContent($confirmation_gui->getHTML());
    }

References $container, ILIAS\Repository\ctrl(), ilBadgeAssignment\getInstancesByBadgeId(), ilBadge\getObjectInstances(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by handleTableActionsCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deactivateObjectBadges()

ilObjBadgeAdministrationGUI::deactivateObjectBadges ( )

private

Definition at line 663 of file class.ilObjBadgeAdministrationGUI.php.

                                             : void
    {
        $this->toggleObjectBadges(false);
    }

Referenced by handleTableActionsCmd().

Here is the caller graph for this function:

◆ deactivateTypes()

ilObjBadgeAdministrationGUI::deactivateTypes ( )

private

Definition at line 290 of file class.ilObjBadgeAdministrationGUI.php.

                                      : void
    {
        $this->assertActive();
 
        $tmpl_ids = $this->badge_request->getMultiActionBadgeIdsFromUrl();
        if ($this->checkPermissionBool('write') && count($tmpl_ids) > 0) {
            $handler = ilBadgeHandler::getInstance();
            $change_state = [];
            foreach ($handler->getInactiveTypes() as $type) {
                if (!in_array($type, $tmpl_ids)) {
                    $change_state[] = $type;
                }
            }
 
            $res = [];
            if (current($tmpl_ids) === self::TABLE_ALL_OBJECTS_ACTION) {
                $types = $handler->getAvailableTypes(false);
                foreach ($types as $id => $type) {
                    $res[] = $id;
                }
                $handler->setInactiveTypes($res);
            } else {
                $handler->setInactiveTypes($change_state);
            }
            $inactive = array_merge($handler->getInactiveTypes(), $tmpl_ids);
            $handler->setInactiveTypes($inactive);
 
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('settings_saved'), true);
        }
 
        $this->ctrl->redirect($this, self::LIST_TYPES_ACTION);
    }

References $handler, ilObjectGUI\$id, $res, ilObjectGUI\$type, assertActive(), ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ilBadgeHandler\getInstance(), and ILIAS\Repository\lng().

Referenced by handleTableActionsCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteImageTemplatesCmd()

ilObjBadgeAdministrationGUI::deleteImageTemplatesCmd ( )

private

Definition at line 560 of file class.ilObjBadgeAdministrationGUI.php.

                                              : void
    {
        $tmpl_ids = $this->badge_request->getIds();
 
        if ($this->checkPermissionBool('write') && count($tmpl_ids) > 0) {
            if (current($tmpl_ids) === self::TABLE_ALL_OBJECTS_ACTION) {
                $tmpl_ids = [];
                foreach (ilBadgeImageTemplate::getInstances() as $template) {
                    $tmpl_ids[] = $template->getId();
                }
            }
            foreach ($tmpl_ids as $tmpl_id) {
                $tmpl = new ilBadgeImageTemplate((int) $tmpl_id);
                $tmpl->delete();
            }
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('badge_deletion'), true);
        } else {
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_FAILURE, $this->lng->txt('badge_select_one'), true);
        }
 
        $this->ctrl->redirect($this, self::LIST_IMG_TPL_ACTION);
    }

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

Here is the call graph for this function:

◆ deleteObjectBadgesCmd()

ilObjBadgeAdministrationGUI::deleteObjectBadgesCmd ( )

private

Definition at line 718 of file class.ilObjBadgeAdministrationGUI.php.

                                            : void
    {
        $badge_ids = $this->badge_request->getMultiActionBadgeIdsFromPost();
 
        foreach ($badge_ids as $badge_id) {
            $badge = new ilBadge($badge_id);
            $badge->delete();
        }
 
        $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, self::LIST_OBJ_BADGES_ACTION);
    }

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

Here is the call graph for this function:

◆ editImageTemplate()

ilObjBadgeAdministrationGUI::editImageTemplate ( ?ilPropertyFormGUI $a_form = null )

private

Definition at line 435 of file class.ilObjBadgeAdministrationGUI.php.

     : void {
        $this->checkPermission('write');
 
        $this->assertActive();
        $this->tabs_gui->setTabActive('imgtmpl');
 
        $tmpl_ids = $this->badge_request->getMultiActionBadgeIdsFromUrl();
        if (count($tmpl_ids) !== 1) {
            $tmpl_id = $this->badge_request->getTemplateId();
            if (!$tmpl_id) {
                $this->ctrl->redirect($this, self::LIST_IMG_TPL_ACTION);
            }
 
            $tmpl_ids = [$tmpl_id];
        }
 
        $template_id = (int) array_pop($tmpl_ids);
        $this->ctrl->setParameter($this, 'tid', $template_id);
 
        $tmpl = new ilBadgeImageTemplate($template_id);
 
        if (!$a_form) {
            $a_form = $this->initImageTemplateForm('edit');
            $this->setImageTemplateFormValues($a_form, $tmpl);
        }
 
        $this->tpl->setContent($a_form->getHTML());
    }

Referenced by handleTableActionsCmd().

Here is the caller graph for this function:

◆ editSettingsCmd()

ilObjBadgeAdministrationGUI::editSettingsCmd ( ?ilPropertyFormGUI $a_form = null )

private

Definition at line 202 of file class.ilObjBadgeAdministrationGUI.php.

                                                                       : void
    {
        $this->tabs_gui->setTabActive('settings');
 
        if (!$a_form) {
            $a_form = $this->initFormSettings();
        }
 
        $this->tpl->setContent($a_form->getHTML());
    }

References initFormSettings().

Referenced by saveSettingsCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjBadgeAdministrationGUI::executeCommand ( )

Reimplemented from ilObjectGUI.

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

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this) ?? '';
        $cmd = $this->ctrl->getCmd() ?? '';
 
        $this->prepareOutput();
 
        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;
 
            case strtolower(ilBadgeManagementGUI::class):
                $this->assertActive();
                $this->tabs_gui->setTabActive('activity');
                $gui = new ilBadgeManagementGUI($this->ref_id, $this->obj_id, $this->type);
                $this->ctrl->forwardCommand($gui);
                break;
 
            default:
                if ($cmd === '' || $cmd === null || $cmd === 'view' || !method_exists($this, $cmd . 'Cmd')) {
                    $cmd = self::DEFAULT_ACTION;
                }
                $cmd .= 'Cmd';
 
                if ($this->badge_request->getBadgeIdFromUrl()) {
                    $this->ctrl->setParameter($this, 'tid', $this->badge_request->getBadgeIdFromUrl());
                }
 
                $this->$cmd();
                break;
        }
    }

References assertActive(), ILIAS\Repository\ctrl(), DEFAULT_ACTION, and ilObjectGUI\prepareOutput().

Here is the call graph for this function:

◆ getAdminTabs()

ilObjBadgeAdministrationGUI::getAdminTabs ( )

administration tabs show only permissions and trash folder

Reimplemented from ilObjectGUI.

Definition at line 110 of file class.ilObjBadgeAdministrationGUI.php.

                                  : void
    {
        if ($this->rbacsystem->checkAccess('read', $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                'settings',
                $this->lng->txt('settings'),
                $this->ctrl->getLinkTarget($this, self::EDIT_SETTINGS_ACTION)
            );
 
            if (ilBadgeHandler::getInstance()->isActive()) {
                $this->tabs_gui->addTab(
                    'types',
                    $this->lng->txt('badge_types'),
                    $this->ctrl->getLinkTarget($this, self::LIST_TYPES_ACTION)
                );
 
                $this->tabs_gui->addTab(
                    'imgtmpl',
                    $this->lng->txt('badge_image_templates'),
                    $this->ctrl->getLinkTarget($this, self::LIST_IMG_TPL_ACTION)
                );
 
                $this->tabs_gui->addTab(
                    'activity',
                    $this->lng->txt('badge_activity_badges'),
                    $this->ctrl->getLinkTargetByClass('ilbadgemanagementgui', '')
                );
 
                $this->tabs_gui->addTab(
                    'obj_badges',
                    $this->lng->txt('badge_object_badges'),
                    $this->ctrl->getLinkTarget($this, self::LIST_OBJ_BADGES_ACTION)
                );
            }
        }
 
        if ($this->rbacsystem->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                'perm_settings',
                $this->lng->txt('perm_settings'),
                $this->ctrl->getLinkTargetByClass('ilpermissiongui', 'perm')
            );
        }
    }

References ilBadgeHandler\getInstance(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getObjectBadgesFromMultiAction()

ilObjBadgeAdministrationGUI::getObjectBadgesFromMultiAction ( )

private

Definition at line 626 of file class.ilObjBadgeAdministrationGUI.php.

                                                     : array
    {
        $badge_ids = $this->badge_request->getMultiActionBadgeIdsFromUrl();
        if (!$badge_ids ||
            !$this->access->checkAccess('write', '', $this->object->getRefId())) {
            $this->ctrl->redirect($this, self::LIST_OBJ_BADGES_ACTION);
        }
 
        return $badge_ids;
    }

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

Here is the call graph for this function:

◆ getSafePostCommands()

ilObjBadgeAdministrationGUI::getSafePostCommands ( )

This method must return a list of safe POST commands.

Safe post commands returned by this method will no longer be CSRF protected and will NOT be appended by an ilCtrlToken.

Returns: string[]

Implements ilCtrlSecurityInterface.

Definition at line 155 of file class.ilObjBadgeAdministrationGUI.php.

                                         : array
    {
        return [];
    }

◆ getTableAction()

ilObjBadgeAdministrationGUI::getTableAction ( )

private

Definition at line 160 of file class.ilObjBadgeAdministrationGUI.php.

                                     : ?string
    {
        return $this->http->wrapper()->query()->retrieve(
            'tid_table_action',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always(null)
            ])
        );
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by handleTableActionsCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUnsafeGetCommands()

ilObjBadgeAdministrationGUI::getUnsafeGetCommands ( )

This method must return a list of unsafe GET commands.

Unsafe get commands returned by this method will now be CSRF protected, which means an ilCtrlToken is appended each time a link-target is generated to the class implementing this interface with a command from that list.

Tokens will be validated in

See also: ilCtrlInterface::getCmd(), whereas the fallback command will be used if the CSRF validation fails.

Returns: string[]

Implements ilCtrlSecurityInterface.

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

                                          : array
    {
        return [self::TABLE_ACTIONS];
    }

References TABLE_ACTIONS.

◆ handleTableActionsCmd()

ilObjBadgeAdministrationGUI::handleTableActionsCmd ( )

private

Definition at line 171 of file class.ilObjBadgeAdministrationGUI.php.

                                            : void
    {
        match ($this->getTableAction()) {
            'badge_type_activate' => $this->activateTypes(),
            'badge_type_deactivate' => $this->deactivateTypes(),
            'badge_image_template_editImageTemplate', 'obj_badge_user' => $this->editImageTemplate(),
            'obj_badge_activate' => $this->activateObjectBadges(),
            'obj_badge_deactivate' => $this->deactivateObjectBadges(),
            'obj_badge_show_users' => $this->listObjectBadgeUsers(),
            'badge_image_template_delete' => $this->confirmDeleteImageTemplates(),
            'obj_badge_delete' => $this->confirmDeleteObjectBadges(),
            default => $this->ctrl->redirect($this, self::DEFAULT_ACTION),
        };
    }

References activateObjectBadges(), activateTypes(), confirmDeleteImageTemplates(), confirmDeleteObjectBadges(), ILIAS\Repository\ctrl(), deactivateObjectBadges(), deactivateTypes(), editImageTemplate(), getTableAction(), and listObjectBadgeUsers().

Here is the call graph for this function:

◆ initFormSettings()

ilObjBadgeAdministrationGUI::initFormSettings ( )

private

Definition at line 230 of file class.ilObjBadgeAdministrationGUI.php.

                                       : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, self::SAVE_SETTINGS_ACTION));
        $form->setTitle($this->lng->txt('badge_settings'));
 
        if ($this->access->checkAccess('write', '', $this->object->getRefId())) {
            $form->addCommandButton(self::SAVE_SETTINGS_ACTION, $this->lng->txt('save'));
            $form->addCommandButton(self::EDIT_SETTINGS_ACTION, $this->lng->txt('cancel'));
        }
 
        $act = new ilCheckboxInputGUI($this->lng->txt('badge_service_activate'), 'act');
        $act->setInfo($this->lng->txt('badge_service_activate_info'));
        $form->addItem($act);
 
        $handler = ilBadgeHandler::getInstance();
        $act->setChecked($handler->isActive());
 
        return $form;
    }

References $handler, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilBadgeHandler\getInstance(), and ILIAS\Repository\lng().

Referenced by editSettingsCmd(), and saveSettingsCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initImageTemplateForm()

ilObjBadgeAdministrationGUI::initImageTemplateForm ( string $a_mode )

private

Definition at line 360 of file class.ilObjBadgeAdministrationGUI.php.

     : ilPropertyFormGUI {
        $form = new ilPropertyFormGUI();
        if ($a_mode === 'create') {
            $form->setFormAction($this->ctrl->getFormAction($this, self::SAVE_IMG_TPL_ACTION));
        } else {
            $form->setFormAction($this->ctrl->getFormAction($this, self::UPDATE_IMG_TPL_ACTION));
        }
        $form->setTitle($this->lng->txt('badge_image_template_form'));
 
        $title = new ilTextInputGUI($this->lng->txt('title'), 'title');
        $title->setMaxLength(255);
        $title->setRequired(true);
        $form->addItem($title);
 
        $img = new ilImageFileInputGUI($this->lng->txt('image'), 'img');
        $img->setSuffixes(['png', 'svg']);
        if ($a_mode === 'create') {
            $img->setRequired(true);
        }
        $img->setUseCache(false);
        $img->setAllowDeletion(false);
        $form->addItem($img);
 
        $types_mode = new ilRadioGroupInputGUI($this->lng->txt('badge_template_types'), 'tmode');
        $types_mode->setRequired(true);
        $types_mode->setValue('all');
        $form->addItem($types_mode);
 
        $type_all = new ilRadioOption($this->lng->txt('badge_template_types_all'), 'all');
        $types_mode->addOption($type_all);
 
        $type_spec = new ilRadioOption($this->lng->txt('badge_template_types_specific'), 'spec');
        $types_mode->addOption($type_spec);
 
        $types = new ilCheckboxGroupInputGUI($this->lng->txt('badge_types'), 'type');
        $types->setRequired(true);
        $type_spec->addSubItem($types);
 
        foreach (ilBadgeHandler::getInstance()->getAvailableTypes(false) as $id => $type) {
            $types->addOption(new ilCheckboxOption($type->getCaption(), $id));
        }
 
        if ($a_mode === 'create') {
            $form->addCommandButton(self::SAVE_IMG_TPL_ACTION, $this->lng->txt('save'));
        } else {
            $form->addCommandButton(self::UPDATE_IMG_TPL_ACTION, $this->lng->txt('save'));
        }
        $form->addCommandButton(self::LIST_IMG_TPL_ACTION, $this->lng->txt('cancel'));
 
        return $form;
    }

References ILIAS\Repository\ctrl(), and ilFormGUI\setFormAction().

Here is the call graph for this function:

◆ listImageTemplatesCmd()

ilObjBadgeAdministrationGUI::listImageTemplatesCmd ( )

private

Definition at line 327 of file class.ilObjBadgeAdministrationGUI.php.

                                            : void
    {
        $this->assertActive();
        $this->tabs_gui->setTabActive('imgtmpl');
 
        if ($this->checkPermissionBool('write')) {
            $this->toolbar->addButton(
                $this->lng->txt('badge_add_template'),
                $this->ctrl->getLinkTarget($this, self::ADD_IMG_TPL_ACTION)
            );
        }
 
        $template_table = new ilBadgeImageTemplateTableGUI(
            $this->access->checkAccess('write', '', $this->object->getRefId())
        );
        $template_table->renderTable(ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTarget($this, self::TABLE_ACTIONS));
    }

References ILIAS\Repository\access(), assertActive(), ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

◆ listObjectBadgesCmd()

ilObjBadgeAdministrationGUI::listObjectBadgesCmd ( )

private

Definition at line 613 of file class.ilObjBadgeAdministrationGUI.php.

                                          : void
    {
        $this->assertActive();
        $this->tabs_gui->setTabActive('obj_badges');
 
        $tbl = new ilObjectBadgeTableGUI($this, $this->access->checkAccess('write', '', $this->object->getRefId()));
        $tbl->renderTable(ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTarget($this, self::TABLE_ACTIONS));
    }

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

Here is the call graph for this function:

◆ listObjectBadgeUsers()

ilObjBadgeAdministrationGUI::listObjectBadgeUsers ( )

private

Definition at line 587 of file class.ilObjBadgeAdministrationGUI.php.

                                           : void
    {
        $parent_obj_id = $this->badge_request->getParentId();
        if (!$parent_obj_id && $this->badge_request->getBadgeIdFromUrl()) {
            // In this case, we want't to list the users that have been awarded a specific badge
            $badge = new ilBadge($this->badge_request->getBadgeIdFromUrl());
            $parent_obj_id = $badge->getParentId();
        }
        if (!$parent_obj_id) {
            $this->ctrl->redirect($this, self::LIST_OBJ_BADGES_ACTION);
        }
 
        $this->assertActive();
 
        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $this->lng->txt('back'),
            $this->ctrl->getLinkTarget($this, self::LIST_OBJ_BADGES_ACTION)
        );
 
        $this->ctrl->saveParameter($this, 'pid');
 
        $tbl = new ilBadgeUserTableGUI(null, null, $parent_obj_id, $this->badge_request->getBadgeId());
        $tbl->renderTable(ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTarget($this, self::TABLE_ACTIONS));
    }

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

Referenced by handleTableActionsCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listTypesCmd()

ilObjBadgeAdministrationGUI::listTypesCmd ( )

private

Definition at line 255 of file class.ilObjBadgeAdministrationGUI.php.

                                   : void
    {
        $this->assertActive();
        $this->tabs_gui->setTabActive('types');
 
        $tpl = new ilBadgeTypesTableGUI($this->access->checkAccess('write', '', $this->object->getRefId()));
        $tpl->renderTable(ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTarget($this, self::TABLE_ACTIONS));
    }

References ilObjectGUI\$tpl, ILIAS\Repository\access(), assertActive(), and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ saveImageTemplateCmd()

ilObjBadgeAdministrationGUI::saveImageTemplateCmd ( )

private

Definition at line 414 of file class.ilObjBadgeAdministrationGUI.php.

                                           : void
    {
        $this->checkPermission('write');
 
        $form = $this->initImageTemplateForm('create');
        if ($form->checkInput()) {
            $tmpl = new ilBadgeImageTemplate();
            $tmpl->setTitle($form->getInput('title'));
            $tmpl->setTypes($form->getInput('type'));
            $tmpl->create();
 
            $tmpl->processImageUpload($tmpl);
 
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, self::LIST_IMG_TPL_ACTION);
        }
 
        $form->setValuesByPost();
        $this->addImageTemplateCmd($form);
    }

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

Here is the call graph for this function:

◆ saveSettingsCmd()

ilObjBadgeAdministrationGUI::saveSettingsCmd ( )

private

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

                                      : void
    {
        $this->checkPermission('write');
 
        $form = $this->initFormSettings();
        if ($form->checkInput()) {
            $handler = ilBadgeHandler::getInstance();
            $handler->setActive((bool) $form->getInput('act'));
 
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, self::EDIT_SETTINGS_ACTION);
        }
 
        $form->setValuesByPost();
        $this->editSettingsCmd($form);
    }

References $handler, ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), editSettingsCmd(), ilBadgeHandler\getInstance(), initFormSettings(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ setImageTemplateFormValues()

ilObjBadgeAdministrationGUI::setImageTemplateFormValues	(	ilPropertyFormGUI	$a_form,
		ilBadgeImageTemplate	$a_tmpl
	)

private

Definition at line 466 of file class.ilObjBadgeAdministrationGUI.php.

     : void {
        $a_form->getItemByPostVar('title')->setValue($a_tmpl->getTitle());
        if ($a_tmpl->getImageRid() !== null) {
            $img = $a_tmpl->getImageFromResourceId();
            $a_form->getItemByPostVar('img')->setImage($img);
            $a_form->getItemByPostVar('img')->setValue($a_tmpl->getImageRid());
        } else {
            $a_form->getItemByPostVar('img')->setImage($a_tmpl->getImagePath());
            $a_form->getItemByPostVar('img')->setValue($a_tmpl->getImage());
        }
 
        if ($a_tmpl->getTypes()) {
            $a_form->getItemByPostVar('tmode')->setValue('spec');
            $a_form->getItemByPostVar('type')->setValue($a_tmpl->getTypes());
        } else {
            $a_form->getItemByPostVar('tmode')->setValue('all');
        }
    }

References ilBadgeImageTemplate\getImageFromResourceId(), ilBadgeImageTemplate\getImageRid(), and ilPropertyFormGUI\getItemByPostVar().

Here is the call graph for this function:

◆ toggleObjectBadges()

ilObjBadgeAdministrationGUI::toggleObjectBadges ( bool $a_status )

private

Definition at line 637 of file class.ilObjBadgeAdministrationGUI.php.

                                                       : void
    {
        $badge_ids = $this->getObjectBadgesFromMultiAction();
        if (current($badge_ids) === self::TABLE_ALL_OBJECTS_ACTION) {
            $filter = ['type' => '' , 'title' => '', 'object' => ''];
            $badge_ids = [];
            foreach (ilBadge::getObjectInstances($filter) as $badge_item) {
                $badge_ids[] = $badge_item['id'];
            }
        }
 
        foreach ($badge_ids as $badge_id) {
            $badge = new ilBadge($badge_id);
            $badge->setActive($a_status);
            $badge->update();
        }
 
        $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, self::LIST_OBJ_BADGES_ACTION);
    }

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

Here is the call graph for this function:

◆ updateImageTemplateCmd()

ilObjBadgeAdministrationGUI::updateImageTemplateCmd ( )

private

Definition at line 488 of file class.ilObjBadgeAdministrationGUI.php.

                                             : void
    {
        $this->checkPermission('write');
 
        $tmpl_id = $this->badge_request->getTemplateId();
        if (!$tmpl_id) {
            $this->ctrl->redirect($this, self::LIST_IMG_TPL_ACTION);
        }
 
        $this->ctrl->setParameter($this, 'tid', $tmpl_id);
 
        $tmpl = new ilBadgeImageTemplate($tmpl_id);
 
        $form = $this->initImageTemplateForm('update');
        if ($form->checkInput()) {
            $tmpl->setTitle($form->getInput('title'));
 
            if ($form->getInput('tmode') !== 'all') {
                $tmpl->setTypes($form->getInput('type'));
            } else {
                $tmpl->setTypes(null);
            }
 
            $tmpl->update();
 
            $tmpl->processImageUpload($tmpl);
 
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, self::LIST_IMG_TPL_ACTION);
        }
 
        $this->setImageTemplateFormValues($form, $tmpl);
        $form->setValuesByPost();
        $this->editImageTemplate($form);
    }