ilObjBadgeAdministrationGUI Class Reference

ilObjBadgeAdministrationGUI: ilPermissionGUI, ilBadgeManagementGUI 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 ()
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	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]

Protected Member Functions
	assertActive ()
	editSettings (?ilPropertyFormGUI $a_form=null)
	saveSettings ()
	initFormSettings ()
	listTypes ()
	activateTypes ()
	deactivateTypes ()
	listImageTemplates ()
	addImageTemplate (?ilPropertyFormGUI $a_form=null)
	initImageTemplateForm (string $a_mode)
	saveImageTemplate ()
	editImageTemplate (?ilPropertyFormGUI $a_form=null)
	setImageTemplateFormValues (ilPropertyFormGUI $a_form, ilBadgeImageTemplate $a_tmpl)
	updateImageTemplate ()
	confirmDeleteImageTemplates ()
	deleteImageTemplates ()
	applyObjectFilter ()
	resetObjectFilter ()
	listObjectBadgeUsers ()
	applylistObjectBadgeUsers ()
	resetlistObjectBadgeUsers ()
	listObjectBadges ()
	getObjectBadgesFromMultiAction ()
	toggleObjectBadges (bool $a_status)
	activateObjectBadges ()
	deactivateObjectBadges ()
	confirmDeleteObjectBadges ()
	deleteObjectBadges ()
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 ()
	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)

Private Attributes
ILIAS ResourceStorage Services	$resource_storage
ilRbacSystem	$rbacsystem
ilBadgeGUIRequest	$badge_request
ilTabsGUI	$tabs
Services	$http

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 Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service
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
ilObjectCustomIconFactory	$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

ilObjBadgeAdministrationGUI: ilPermissionGUI, ilBadgeManagementGUI ilObjBadgeAdministrationGUI: ilAdministrationGUI

Definition at line 29 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 38 of file class.ilObjBadgeAdministrationGUI.php.

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

      {
        global $DIC;

        $this->resource_storage = $DIC->resourceStorage();
        $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';
        $this->http = $DIC->http();
        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');
    }

Here is the call graph for this function:

Member Function Documentation

activateObjectBadges()

ilObjBadgeAdministrationGUI::activateObjectBadges ( )

protected

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

References toggleObjectBadges().

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

activateTypes()

ilObjBadgeAdministrationGUI::activateTypes ( )

protected

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

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

Referenced by executeCommand().

                                      : void
    {
        $lng = $this->lng;
        $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('success', $lng->txt('settings_saved'), true);
        }
        $this->ctrl->redirect($this, 'listTypes');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addImageTemplate()

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

protected

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

References ilObjectGUI\$tpl, assertActive(), ilObjectGUI\checkPermission(), initImageTemplateForm(), and ILIAS\UICore\GlobalTemplate\setContent().

Referenced by saveImageTemplate().

     : void {
        $tpl = $this->tpl;

        $this->checkPermission('write');

        $this->assertActive();
        $this->tabs_gui->setTabActive('imgtmpl');

        if (!$a_form) {
            $a_form = $this->initImageTemplateForm('create');
        }

        $tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

applylistObjectBadgeUsers()

ilObjBadgeAdministrationGUI::applylistObjectBadgeUsers ( )

protected

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

References listObjectBadges().

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

Here is the call graph for this function:

applyObjectFilter()

ilObjBadgeAdministrationGUI::applyObjectFilter ( )

protected

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

References listObjectBadges().

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

Here is the call graph for this function:

assertActive()

ilObjBadgeAdministrationGUI::assertActive ( )

protected

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

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

Referenced by activateTypes(), addImageTemplate(), deactivateTypes(), editImageTemplate(), executeCommand(), listImageTemplates(), listObjectBadges(), listObjectBadgeUsers(), and listTypes().

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

Here is the call graph for this function:

Here is the caller graph for this function:

confirmDeleteImageTemplates()

ilObjBadgeAdministrationGUI::confirmDeleteImageTemplates ( )

protected

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

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, $tabs, ilObjectGUI\$tpl, ilObjectGUI\checkPermission(), ilBadgeImageTemplate\getInstances(), ILIAS\UICore\GlobalTemplate\setContent(), and ilLanguage\txt().

Referenced by executeCommand().

                                                    : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;

        $this->checkPermission('write');

        $tmpl_ids = $this->badge_request->getBadgeAssignableUsers();
        if ($tmpl_ids === ['ALL_OBJECTS']) {
            $tmpl_ids = [];
            foreach (ilBadgeImageTemplate::getInstances() as $template) {
                $tmpl_ids[] = $template->getId();
            }
        }

        if (!$tmpl_ids) {
            $ilCtrl->redirect($this, 'listImageTemplates');
        }

        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $lng->txt('back'),
            $ilCtrl->getLinkTarget($this, 'listImageTemplates')
        );

        $confirmation_gui = new ilConfirmationGUI();
        $confirmation_gui->setFormAction($ilCtrl->getFormAction($this));
        $confirmation_gui->setHeaderText($lng->txt('badge_template_deletion_confirmation'));
        $confirmation_gui->setCancel($lng->txt('cancel'), 'listImageTemplates');
        $confirmation_gui->setConfirm($lng->txt('delete'), 'deleteImageTemplates');

        foreach ($tmpl_ids as $tmpl_id) {
            $tmpl = new ilBadgeImageTemplate($tmpl_id);
            $confirmation_gui->addItem('id[]', $tmpl_id, $tmpl->getTitle());
        }

        $tpl->setContent($confirmation_gui->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmDeleteObjectBadges()

ilObjBadgeAdministrationGUI::confirmDeleteObjectBadges ( )

protected

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

References $container, ilObjectGUI\$ctrl, ilObjectGUI\$lng, $tabs, ilObjectGUI\$tpl, ilTabsGUI\clearTargets(), ilBadgeAssignment\getInstancesByBadgeId(), ilBadge\getObjectInstances(), ILIAS\UICore\GlobalTemplate\setContent(), and ilLanguage\txt().

Referenced by executeCommand().

                                                  : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;

        $badge_ids = $this->badge_request->getMultiActionBadgeIdsFromUrl();

        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $lng->txt('back'),
            $ilCtrl->getLinkTarget($this, 'listObjectBadges')
        );

        $confirmation_gui = new ilConfirmationGUI();
        $confirmation_gui->setFormAction($ilCtrl->getFormAction($this));
        $confirmation_gui->setHeaderText($lng->txt('badge_deletion_confirmation'));
        $confirmation_gui->setCancel($lng->txt('cancel'), 'listObjectBadges');
        $confirmation_gui->setConfirm($lng->txt('delete'), 'deleteObjectBadges');

        if ($badge_ids === ['ALL_OBJECTS']) {
            $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">' . $lng->txt('deleted') . '</span>';
            }

            $confirmation_gui->addItem(
                'id[]',
                $badge_id,
                $container . ' - ' .
                $badge->getTitle() .
                ' (' . count(ilBadgeAssignment::getInstancesByBadgeId($badge_id)) . ')'
            );
        }

        $tpl->setContent($confirmation_gui->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deactivateObjectBadges()

ilObjBadgeAdministrationGUI::deactivateObjectBadges ( )

protected

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

References toggleObjectBadges().

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

deactivateTypes()

ilObjBadgeAdministrationGUI::deactivateTypes ( )

protected

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

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

Referenced by executeCommand().

                                        : void
    {
        $lng = $this->lng;
        $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('success', $lng->txt('settings_saved'), true);
        }
        $this->ctrl->redirect($this, 'listTypes');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteImageTemplates()

ilObjBadgeAdministrationGUI::deleteImageTemplates ( )

protected

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

References ilObjectGUI\$lng, ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ilBadgeImageTemplate\getInstances(), and ilLanguage\txt().

                                             : void
    {
        $lng = $this->lng;
        $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('success', $lng->txt('badge_deletion'), true);
        } else {
            $this->tpl->setOnScreenMessage('failure', $lng->txt('badge_select_one'), true);
        }

        $this->ctrl->redirect($this, 'listImageTemplates');
    }

Here is the call graph for this function:

deleteObjectBadges()

ilObjBadgeAdministrationGUI::deleteObjectBadges ( )

protected

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

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, and ilLanguage\txt().

                                           : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $badge_ids = $this->badge_request->getMultiActionBadgeIdsFromPost();

        foreach ($badge_ids as $badge_id) {
            $badge = new ilBadge($badge_id);
            $badge->delete();
        }

        $this->tpl->setOnScreenMessage('success', $lng->txt('settings_saved'), true);
        $ilCtrl->redirect($this, 'listObjectBadges');
    }

Here is the call graph for this function:

editImageTemplate()

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

protected

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

References ilObjectGUI\$ctrl, ilObjectGUI\$tpl, assertActive(), ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), initImageTemplateForm(), ILIAS\Repository\int(), ILIAS\UICore\GlobalTemplate\setContent(), and setImageTemplateFormValues().

Referenced by executeCommand(), and updateImageTemplate().

     : void {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;

        $this->checkPermission('write');

        $this->assertActive();
        $this->tabs_gui->setTabActive('imgtmpl');

        $tmpl_ids = $this->badge_request->getMultiActionBadgeIdsFromUrl();
        if (count($tmpl_ids) !== 1) {
            $this->ctrl->redirect($this, 'listImageTemplates');
        }

        $template_id = (int) array_pop($tmpl_ids);
        $ilCtrl->setParameter($this, 'tid', $template_id);

        $tmpl = new ilBadgeImageTemplate($template_id);

        if (!$a_form) {
            $a_form = $this->initImageTemplateForm('edit');
            $this->setImageTemplateFormValues($a_form, $tmpl);
        }

        $tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editSettings()

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

protected

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

References initFormSettings().

Referenced by saveSettings().

                                                                      : void
    {
        $this->tabs_gui->setTabActive('settings');

        if (!$a_form) {
            $a_form = $this->initFormSettings();
        }

        $this->tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilObjBadgeAdministrationGUI::executeCommand

(

)

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

References activateObjectBadges(), activateTypes(), assertActive(), confirmDeleteImageTemplates(), confirmDeleteObjectBadges(), ILIAS\Repository\ctrl(), deactivateObjectBadges(), deactivateTypes(), editImageTemplate(), ILIAS\FileDelivery\http(), listObjectBadgeUsers(), ilObjectGUI\prepareOutput(), and ILIAS\Repository\refinery().

                                    : 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 === 'view') {
                    $cmd = 'editSettings';
                }

                if ($this->badge_request->getBadgeIdFromUrl()) {
                    $this->ctrl->setParameter($this, 'tid', $this->badge_request->getBadgeIdFromUrl());
                }

                $table_action = $this->http->wrapper()->query()->retrieve(
                    'tid_table_action',
                    $this->refinery->byTrying([
                        $this->refinery->kindlyTo()->string(),
                        $this->refinery->always('')
                    ])
                );

                $render_default = true;
                if ($table_action === 'badge_type_activate') {
                    $this->activateTypes();
                } elseif ($table_action === 'badge_type_deactivate') {
                    $this->deactivateTypes();
                } elseif ($table_action === 'badge_image_template_editImageTemplate') {
                    $this->editImageTemplate();
                    $render_default = false;
                } elseif ($table_action === 'obj_badge_user') {
                    $this->editImageTemplate();
                    $render_default = false;
                } elseif ($table_action === 'obj_badge_activate') {
                    $this->activateObjectBadges();
                    $render_default = false;
                } elseif ($table_action === 'obj_badge_deactivate') {
                    $this->deactivateObjectBadges();
                    $render_default = false;
                } elseif ($table_action === 'obj_badge_show_users') {
                    $this->listObjectBadgeUsers();
                    $render_default = false;
                } elseif ($table_action === 'badge_image_template_delete') {
                    $this->confirmDeleteImageTemplates();
                    $render_default = false;
                } elseif ($table_action === 'obj_badge_delete') {
                    $this->confirmDeleteObjectBadges();
                    $render_default = false;
                }

                if ($render_default) {
                    $this->$cmd();
                    break;
                }
        }
    }

Here is the call graph for this function:

getAdminTabs()

ilObjBadgeAdministrationGUI::getAdminTabs

(

)

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

References $rbacsystem, ilRbacSystem\checkAccess(), ILIAS\Repository\ctrl(), ilBadgeHandler\getInstance(), and ILIAS\Repository\lng().

                                  : void
    {
        $rbacsystem = $this->rbacsystem;

        if ($rbacsystem->checkAccess('visible,read', $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                'settings',
                $this->lng->txt('settings'),
                $this->ctrl->getLinkTarget($this, 'editSettings')
            );

            if (ilBadgeHandler::getInstance()->isActive()) {
                $this->tabs_gui->addTab(
                    'types',
                    $this->lng->txt('badge_types'),
                    $this->ctrl->getLinkTarget($this, 'listTypes')
                );

                $this->tabs_gui->addTab(
                    'imgtmpl',
                    $this->lng->txt('badge_image_templates'),
                    $this->ctrl->getLinkTarget($this, 'listImageTemplates')
                );

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

        if ($rbacsystem->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                'perm_settings',
                $this->lng->txt('perm_settings'),
                $this->ctrl->getLinkTargetByClass('ilpermissiongui', 'perm')
            );
        }
    }

Here is the call graph for this function:

getObjectBadgesFromMultiAction()

ilObjBadgeAdministrationGUI::getObjectBadgesFromMultiAction ( )

protected

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

References ilObjectGUI\$access, ilObjectGUI\$ctrl, and ilCtrl\redirect().

Referenced by toggleObjectBadges().

                                                       : array
    {
        $ilAccess = $this->access;
        $ilCtrl = $this->ctrl;

        $badge_ids = $this->badge_request->getMultiActionBadgeIdsFromUrl();
        if (!$badge_ids ||
            !$ilAccess->checkAccess('write', '', $this->object->getRefId())) {
            $ilCtrl->redirect($this, 'listObjectBadges');
        }

        return $badge_ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initFormSettings()

ilObjBadgeAdministrationGUI::initFormSettings ( )

protected

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

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

Referenced by editSettings(), and saveSettings().

                                         : ilPropertyFormGUI
    {
        $ilAccess = $this->access;

        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('badge_settings'));

        if ($ilAccess->checkAccess('write', '', $this->object->getRefId())) {
            $form->addCommandButton('saveSettings', $this->lng->txt('save'));
            $form->addCommandButton('editSettings', $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initImageTemplateForm()

ilObjBadgeAdministrationGUI::initImageTemplateForm ( string  $a_mode )

protected

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

References ilObjectGUI\$ctrl, ilObjectGUI\$id, ilObjectGUI\$lng, ilObjectGUI\$type, ilBadgeHandler\getInstance(), ilFormPropertyGUI\setRequired(), ilFileInputGUI\setSuffixes(), and ilLanguage\txt().

Referenced by addImageTemplate(), editImageTemplate(), saveImageTemplate(), and updateImageTemplate().

     : ilPropertyFormGUI {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this, 'saveBadge'));
        $form->setTitle($lng->txt('badge_image_template_form'));

        $title = new ilTextInputGUI($lng->txt('title'), 'title');
        $title->setMaxLength(255);
        $title->setRequired(true);
        $form->addItem($title);

        $img = new ilImageFileInputGUI($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($lng->txt('badge_template_types'), 'tmode');
        $types_mode->setRequired(true);
        $types_mode->setValue('all');
        $form->addItem($types_mode);

        $type_all = new ilRadioOption($lng->txt('badge_template_types_all'), 'all');
        $types_mode->addOption($type_all);

        $type_spec = new ilRadioOption($lng->txt('badge_template_types_specific'), 'spec');
        $types_mode->addOption($type_spec);

        $types = new ilCheckboxGroupInputGUI($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('saveImageTemplate', $lng->txt('save'));
        } else {
            $form->addCommandButton('updateImageTemplate', $lng->txt('save'));
        }
        $form->addCommandButton('listImageTemplates', $lng->txt('cancel'));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listImageTemplates()

ilObjBadgeAdministrationGUI::listImageTemplates ( )

protected

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

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

                                           : void
    {
        $lng = $this->lng;
        $ilToolbar = $this->toolbar;
        $ilCtrl = $this->ctrl;

        $this->assertActive();
        $this->tabs_gui->setTabActive('imgtmpl');

        if ($this->checkPermissionBool('write')) {
            $ilToolbar->addButton(
                $lng->txt('badge_add_template'),
                $ilCtrl->getLinkTarget($this, 'addImageTemplate')
            );
        }

        $template_table = new ilBadgeImageTemplateTableGUI($this->access->checkAccess("write", "", $this->object->getRefId()));
        $template_table->renderTable();
    }

Here is the call graph for this function:

listObjectBadges()

ilObjBadgeAdministrationGUI::listObjectBadges ( )

protected

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

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

Referenced by applylistObjectBadgeUsers(), applyObjectFilter(), resetlistObjectBadgeUsers(), and resetObjectFilter().

                                         : void
    {
        $this->assertActive();
        $this->tabs_gui->setTabActive('obj_badges');

        $tbl = new ilObjectBadgeTableGUI($this, $this->access->checkAccess("write", "", $this->object->getRefId()));
        $tbl->renderTable();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listObjectBadgeUsers()

ilObjBadgeAdministrationGUI::listObjectBadgeUsers ( )

protected

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

References assertActive(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), null, and ILIAS\Badge\ilBadgeUserTableGUI\renderTable().

Referenced by executeCommand().

                                             : 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, 'listObjectBadges');
        }

        $this->assertActive();

        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $this->lng->txt('back'),
            $this->ctrl->getLinkTarget($this, 'listObjectBadges')
        );

        $this->ctrl->saveParameter($this, 'pid');

        $tbl = new ilBadgeUserTableGUI(null, null, $parent_obj_id, $this->badge_request->getBadgeId());
        $tbl->renderTable();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listTypes()

ilObjBadgeAdministrationGUI::listTypes ( )

protected

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

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

                                  : void
    {
        $ilAccess = $this->access;

        $this->assertActive();
        $this->tabs_gui->setTabActive('types');

        $tpl = new ilBadgeTypesTableGUI($this->access->checkAccess("write", "", $this->object->getRefId()));
        $tpl->renderTable();
    }

Here is the call graph for this function:

resetlistObjectBadgeUsers()

ilObjBadgeAdministrationGUI::resetlistObjectBadgeUsers ( )

protected

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

References listObjectBadges().

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

Here is the call graph for this function:

resetObjectFilter()

ilObjBadgeAdministrationGUI::resetObjectFilter ( )

protected

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

References listObjectBadges().

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

Here is the call graph for this function:

saveImageTemplate()

ilObjBadgeAdministrationGUI::saveImageTemplate ( )

protected

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

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, addImageTemplate(), ilObjectGUI\checkPermission(), initImageTemplateForm(), and ilLanguage\txt().

                                          : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $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('success', $lng->txt('settings_saved'), true);
            $ilCtrl->redirect($this, 'listImageTemplates');
        }

        $form->setValuesByPost();
        $this->addImageTemplate($form);
    }

Here is the call graph for this function:

saveSettings()

ilObjBadgeAdministrationGUI::saveSettings ( )

protected

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

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

                                     : void
    {
        $ilCtrl = $this->ctrl;

        $this->checkPermission('write');

        $form = $this->initFormSettings();
        if ($form->checkInput()) {
            $handler = ilBadgeHandler::getInstance();
            $handler->setActive((bool) $form->getInput('act'));

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
            $ilCtrl->redirect($this, 'editSettings');
        }

        $form->setValuesByPost();
        $this->editSettings($form);
    }

Here is the call graph for this function:

setImageTemplateFormValues()

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

protected

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

References ilBadgeImageTemplate\getImage(), ilBadgeImageTemplate\getImageFromResourceId(), ilBadgeImageTemplate\getImagePath(), ilBadgeImageTemplate\getImageRid(), ilPropertyFormGUI\getItemByPostVar(), ilBadgeImageTemplate\getTitle(), ilBadgeImageTemplate\getTypes(), and null.

Referenced by editImageTemplate(), and updateImageTemplate().

     : 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');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

toggleObjectBadges()

ilObjBadgeAdministrationGUI::toggleObjectBadges ( bool  $a_status )

protected

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

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, getObjectBadgesFromMultiAction(), ilBadge\getObjectInstances(), and ilLanguage\txt().

Referenced by activateObjectBadges(), and deactivateObjectBadges().

                                                         : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $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();
            }
        } else {
            foreach ($badge_ids as $badge_id) {
                $badge = new ilBadge($badge_id);
                $badge->setActive($a_status);
                $badge->update();
            }
        }


        $this->tpl->setOnScreenMessage('success', $lng->txt('settings_saved'), true);
        $ilCtrl->redirect($this, 'listObjectBadges');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateImageTemplate()

ilObjBadgeAdministrationGUI::updateImageTemplate ( )

protected

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

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjectGUI\checkPermission(), editImageTemplate(), initImageTemplateForm(), null, setImageTemplateFormValues(), and ilLanguage\txt().

                                            : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $this->checkPermission('write');

        $tmpl_id = $this->badge_request->getTemplateId();
        if (!$tmpl_id) {
            $ilCtrl->redirect($this, 'listImageTemplates');
        }

        $ilCtrl->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('success', $lng->txt('settings_saved'), true);
            $ilCtrl->redirect($this, 'listImageTemplates');
        }

        $this->setImageTemplateFormValues($form, $tmpl);
        $form->setValuesByPost();
        $this->editImageTemplate($form);
    }

Here is the call graph for this function:

Field Documentation

$badge_request

ilBadgeGUIRequest ilObjBadgeAdministrationGUI::$badge_request

private

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

$http

Services ilObjBadgeAdministrationGUI::$http

private

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

$rbacsystem

ilRbacSystem ilObjBadgeAdministrationGUI::$rbacsystem

private

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

Referenced by getAdminTabs().

$resource_storage

ILIAS ResourceStorage Services ilObjBadgeAdministrationGUI::$resource_storage

private

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

$tabs

ilTabsGUI ilObjBadgeAdministrationGUI::$tabs

private

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

Referenced by confirmDeleteImageTemplates(), and confirmDeleteObjectBadges().

TABLE_ALL_OBJECTS_ACTION

const ilObjBadgeAdministrationGUI::TABLE_ALL_OBJECTS_ACTION = 'ALL_OBJECTS'

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

---

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

• components/ILIAS/Badge/classes/class.ilObjBadgeAdministrationGUI.php