ilObjBadgeAdministrationGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. 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...
Public Member Functions inherited from ilObjectGUI
	__construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true)
	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] don't belong to the current 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...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page More...
	createObject ()
	create new object form More...
	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)
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More...
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

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 ()
	listObjectBadges ()
	applyObjectFilter ()
	resetObjectFilter ()
	listObjectBadgeUsers ()
	applylistObjectBadgeUsers ()
	resetlistObjectBadgeUsers ()
	getObjectBadgesFromMultiAction ()
	toggleObjectBadges (bool $a_status)
	activateObjectBadges ()
	deactivateObjectBadges ()
	confirmDeleteObjectBadges ()
	deleteObjectBadges ()
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	assignObject ()
	setTitleAndDescription ()
	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...
	initCreationForms (string $new_type)
	Init creation forms. More...
	getCreationFormsHTML (array $forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm (string $new_type)
	initDidacticTemplate (ilPropertyFormGUI $form)
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	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...
	initImportForm (string $new_type)
	importFileObject (int $parent_id=null)
	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...
	fillCloneTemplate (?string $tpl_name, string $type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. 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...
	showCustomIconsEditing ( $input_colspan=1, ilPropertyFormGUI $form=null, $as_section=true)
	show edit section of custom icons for container More...

Protected Attributes
ilRbacSystem	$rbacsystem
ilBadgeGUIRequest	$badge_request
ilTabsGUI	$tabs
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
Factory	$refinery
ilFavouritesManager	$favourites
ilObjectCustomIconFactory	$custom_icon_factory
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 = ""

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)
Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
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

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Badge Administration Settings.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om @ilCtrl_Calls ilObjBadgeAdministrationGUI: ilPermissionGUI, ilBadgeManagementGUI @ilCtrl_IsCalledBy ilObjBadgeAdministrationGUI: ilAdministrationGUI

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

Constructor & Destructor Documentation

__construct()

ilObjBadgeAdministrationGUI::__construct	(		$data,
		int	$id,
		bool	$call_by_reference = true,
		bool	$prepare_output = true
	)

Parameters

mixed	$data
int	$id
bool	$call_by_reference
bool	$prepare_output

Exceptions

ilCtrlException

Reimplemented from ilObjectGUI.

Definition at line 32 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 ( )

protected

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

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

activateTypes()

ilObjBadgeAdministrationGUI::activateTypes ( )

protected

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

                                      : void
    {
        $lng = $this->lng;
 
        $this->assertActive();
 
        $ids = $this->badge_request->getIds();
        if ($this->checkPermissionBool("write") && count($ids) > 0) {
            $handler = ilBadgeHandler::getInstance();
            $inactive = [];
            foreach ($handler->getInactiveTypes() as $type) {
                if (!in_array($type, $ids)) {
                    $inactive[] = $type;
                }
            }
            $handler->setInactiveTypes($inactive);
 
            $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
        }
        $this->ctrl->redirect($this, "listTypes");
    }

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

Here is the call graph for this function:

addImageTemplate()

ilObjBadgeAdministrationGUI::addImageTemplate ( ilPropertyFormGUI  $a_form = null )

protected

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

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

applylistObjectBadgeUsers()

ilObjBadgeAdministrationGUI::applylistObjectBadgeUsers ( )

protected

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

                                                  : void
    {
        $tbl = new ilBadgeUserTableGUI($this, "listObjectBadgeUsers", 0, null, 0, $this->badge_request->getBadgeId());
        $tbl->resetOffset();
        $tbl->writeFilterToSession();
        $this->listObjectBadgeUsers();
    }

applyObjectFilter()

ilObjBadgeAdministrationGUI::applyObjectFilter ( )

protected

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

                                          : void
    {
        $ilAccess = $this->access;
 
        $tbl = new ilObjectBadgeTableGUI(
            $this,
            "listObjectBadges",
            $ilAccess->checkAccess("write", "", $this->object->getRefId())
        );
        $tbl->resetOffset();
        $tbl->writeFilterToSession();
        $this->listObjectBadges();
    }

assertActive()

ilObjBadgeAdministrationGUI::assertActive ( )

protected

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

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

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

Referenced by activateTypes(), deactivateTypes(), executeCommand(), listImageTemplates(), and listTypes().

Here is the call graph for this function:

Here is the caller graph for this function:

confirmDeleteImageTemplates()

ilObjBadgeAdministrationGUI::confirmDeleteImageTemplates ( )

protected

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

                                                    : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
 
        $this->checkPermission("write");
 
        $tmpl_ids = $this->badge_request->getIds();
        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());
    }

References $lng, and $tpl.

confirmDeleteObjectBadges()

ilObjBadgeAdministrationGUI::confirmDeleteObjectBadges ( )

protected

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

                                                  : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
 
        $badge_ids = $this->getObjectBadgesFromMultiAction();
 
        $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");
 
        foreach ($badge_ids as $badge_id) {
            $badge = new ilBadge($badge_id);
            $parent = $badge->getParentMeta();
 
            // :TODO: container presentation
            $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());
    }

References $container, $lng, $tpl, and ilBadgeAssignment\getInstancesByBadgeId().

Here is the call graph for this function:

deactivateObjectBadges()

ilObjBadgeAdministrationGUI::deactivateObjectBadges ( )

protected

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

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

deactivateTypes()

ilObjBadgeAdministrationGUI::deactivateTypes ( )

protected

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

                                        : void
    {
        $lng = $this->lng;
 
        $this->assertActive();
 
        $ids = $this->badge_request->getIds();
        if ($this->checkPermissionBool("write") && count($ids) > 0) {
            $handler = ilBadgeHandler::getInstance();
            $inactive = array_merge($handler->getInactiveTypes(), $ids);
            $handler->setInactiveTypes($inactive);
 
            $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
        }
        $this->ctrl->redirect($this, "listTypes");
    }

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

Here is the call graph for this function:

deleteImageTemplates()

ilObjBadgeAdministrationGUI::deleteImageTemplates ( )

protected

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

                                             : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $this->checkPermission("write");
 
        $tmpl_ids = $this->badge_request->getIds();
        if ($tmpl_ids) {
            foreach ($tmpl_ids as $tmpl_id) {
                $tmpl = new ilBadgeImageTemplate($tmpl_id);
                $tmpl->delete();
            }
 
            $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
        }
 
        $ilCtrl->redirect($this, "listImageTemplates");
    }

References $lng.

deleteObjectBadges()

ilObjBadgeAdministrationGUI::deleteObjectBadges ( )

protected

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

                                           : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $badge_ids = $this->getObjectBadgesFromMultiAction();
 
        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");
    }

References $lng.

editImageTemplate()

ilObjBadgeAdministrationGUI::editImageTemplate ( ilPropertyFormGUI  $a_form = null )

protected

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

     : void {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
 
        $this->checkPermission("write");
 
        $this->assertActive();
        $this->tabs_gui->setTabActive("imgtmpl");
 
        $tmpl_id = $this->badge_request->getTemplateId();
        if (!$tmpl_id) {
            $ilCtrl->redirect($this, "listImageTemplates");
        }
 
        $ilCtrl->setParameter($this, "tid", $tmpl_id);
 
        $tmpl = new ilBadgeImageTemplate($tmpl_id);
 
        if (!$a_form) {
            $a_form = $this->initImageTemplateForm("edit");
            $this->setImageTemplateFormValues($a_form, $tmpl);
        }
 
        $tpl->setContent($a_form->getHTML());
    }

editSettings()

ilObjBadgeAdministrationGUI::editSettings ( ilPropertyFormGUI  $a_form = null )

protected

Definition at line 148 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 saveSettings().

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 58 of file class.ilObjBadgeAdministrationGUI.php.

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        $this->prepareOutput();
 
        switch ($next_class) {
            case 'ilpermissiongui':
                $this->tabs_gui->setTabActive('perm_settings');
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
 
            case 'ilbadgemanagementgui':
                $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";
                }
 
                $this->$cmd();
                break;
        }
    }

References assertActive(), ILIAS\Repository\ctrl(), 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 89 of file class.ilObjBadgeAdministrationGUI.php.

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

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

Here is the call graph for this function:

getObjectBadgesFromMultiAction()

ilObjBadgeAdministrationGUI::getObjectBadgesFromMultiAction ( )

protected

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

                                                       : array
    {
        $ilAccess = $this->access;
        $ilCtrl = $this->ctrl;
 
        $badge_ids = $this->badge_request->getIds();
        if (!$badge_ids ||
            !$ilAccess->checkAccess("write", "", $this->object->getRefId())) {
            $ilCtrl->redirect($this, "listObjectBadges");
        }
 
        return $badge_ids;
    }

initFormSettings()

ilObjBadgeAdministrationGUI::initFormSettings ( )

protected

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

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

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

Referenced by editSettings(), and saveSettings().

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 308 of file class.ilObjBadgeAdministrationGUI.php.

     : 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->setRequired(true);
        $form->addItem($title);
 
        $img = new ilImageFileInputGUI($lng->txt("image"), "img");
        $img->setSuffixes(array("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;
    }

listImageTemplates()

ilObjBadgeAdministrationGUI::listImageTemplates ( )

protected

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

                                           : void
    {
        $ilAccess = $this->access;
        $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")
            );
        }
 
        $tbl = new ilBadgeImageTemplateTableGUI(
            $this,
            "listImageTemplates",
            $ilAccess->checkAccess("write", "", $this->object->getRefId())
        );
        $this->tpl->setContent($tbl->getHTML());
    }

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

Here is the call graph for this function:

listObjectBadges()

ilObjBadgeAdministrationGUI::listObjectBadges ( )

protected

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

                                         : void
    {
        $ilAccess = $this->access;
        $tpl = $this->tpl;
 
        $this->assertActive();
        $this->tabs_gui->setTabActive("obj_badges");
 
        $tbl = new ilObjectBadgeTableGUI(
            $this,
            "listObjectBadges",
            $ilAccess->checkAccess("write", "", $this->object->getRefId())
        );
        $tpl->setContent($tbl->getHTML());
    }

References $tpl.

listObjectBadgeUsers()

ilObjBadgeAdministrationGUI::listObjectBadgeUsers ( )

protected

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

                                             : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;
 
        $parent_obj_id = $this->badge_request->getParentId();
        if (!$parent_obj_id) {
            $ilCtrl->redirect($this, "listObjectBadges");
        }
 
        $this->assertActive();
 
        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $lng->txt("back"),
            $ilCtrl->getLinkTarget($this, "listObjectBadges")
        );
 
        $ilCtrl->saveParameter($this, "pid");
 
        $tbl = new ilBadgeUserTableGUI($this, "listObjectBadgeUsers", 0, null, $parent_obj_id, $this->badge_request->getBadgeId());
        $tpl->setContent($tbl->getHTML());
    }

References $lng, and $tpl.

listTypes()

ilObjBadgeAdministrationGUI::listTypes ( )

protected

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

                                  : void
    {
        $ilAccess = $this->access;
 
        $this->assertActive();
        $this->tabs_gui->setTabActive("types");
 
        $tbl = new ilBadgeTypesTableGUI(
            $this,
            "listTypes",
            $ilAccess->checkAccess("write", "", $this->object->getRefId())
        );
        $this->tpl->setContent($tbl->getHTML());
    }

References ilObjectGUI\$access, and assertActive().

Here is the call graph for this function:

resetlistObjectBadgeUsers()

ilObjBadgeAdministrationGUI::resetlistObjectBadgeUsers ( )

protected

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

                                                  : void
    {
        $tbl = new ilBadgeUserTableGUI($this, "listObjectBadgeUsers", 0, null, 0, $this->badge_request->getBadgeId());
        $tbl->resetOffset();
        $tbl->resetFilter();
        $this->listObjectBadgeUsers();
    }

resetObjectFilter()

ilObjBadgeAdministrationGUI::resetObjectFilter ( )

protected

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

                                          : void
    {
        $ilAccess = $this->access;
 
        $tbl = new ilObjectBadgeTableGUI(
            $this,
            "listObjectBadges",
            $ilAccess->checkAccess("write", "", $this->object->getRefId())
        );
        $tbl->resetOffset();
        $tbl->resetFilter();
        $this->listObjectBadges();
    }

saveImageTemplate()

ilObjBadgeAdministrationGUI::saveImageTemplate ( )

protected

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

                                          : 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->uploadImage($_FILES["img"]);
 
            $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
            $ilCtrl->redirect($this, "listImageTemplates");
        }
 
        $form->setValuesByPost();
        $this->addImageTemplate($form);
    }

References $lng.

saveSettings()

ilObjBadgeAdministrationGUI::saveSettings ( )

protected

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

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

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

Here is the call graph for this function:

setImageTemplateFormValues()

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

protected

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

     : void {
        $a_form->getItemByPostVar("title")->setValue($a_tmpl->getTitle());
        $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 ilPropertyFormGUI\getItemByPostVar(), and ilBadgeImageTemplate\getTypes().

Here is the call graph for this function:

toggleObjectBadges()

ilObjBadgeAdministrationGUI::toggleObjectBadges ( bool  $a_status )

protected

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

                                                         : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $badge_ids = $this->getObjectBadgesFromMultiAction();
 
        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");
    }

References $lng.

updateImageTemplate()

ilObjBadgeAdministrationGUI::updateImageTemplate ( )

protected

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

                                            : 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->uploadImage($_FILES["img"]);
 
            $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
            $ilCtrl->redirect($this, "listImageTemplates");
        }
 
        $this->setImageTemplateFormValues($form, $tmpl);
        $form->setValuesByPost();
        $this->editImageTemplate($form);
    }

References $lng.

Field Documentation

$badge_request

ilBadgeGUIRequest ilObjBadgeAdministrationGUI::$badge_request

protected

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

$rbacsystem

ilRbacSystem ilObjBadgeAdministrationGUI::$rbacsystem

protected

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

Referenced by getAdminTabs().

$tabs

ilTabsGUI ilObjBadgeAdministrationGUI::$tabs

protected

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

---

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

• Services/Badge/classes/class.ilObjBadgeAdministrationGUI.php