ilObjBadgeAdministrationGUI Class Reference

Badge Administration Settings. More...

Inheritance diagram for ilObjBadgeAdministrationGUI:

Collaboration diagram for ilObjBadgeAdministrationGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	executeCommand ()
	getAdminTabs ()
Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	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 public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	list childs of current object More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...

Protected Member Functions
	assertActive ()
	editSettings ($a_form=null)
	saveSettings ()
	initFormSettings ()
	listTypes ()
	activateTypes ()
	deactivateTypes ()
	listImageTemplates ()
	addImageTemplate (ilPropertyFormGUI $a_form=null)
	initImageTemplateForm ($a_mode)
	saveImageTemplate ()
	editImageTemplate (ilPropertyFormGUI $a_form=null)
	setImageTemplateFormValues (ilPropertyFormGUI $a_form, ilBadgeImageTemplate $a_tmpl)
	updateImageTemplate ()
	confirmDeleteImageTemplates ()
	deleteImageTemplates ()
	listObjectBadges ()
	applyObjectFilter ()
	resetObjectFilter ()
	listObjectBadgeUsers ()
	applyUserFilter ()
	resetUserFilter ()
	getObjectBadgesFromMultiAction ()
	toggleObjectBadges ($a_status)
	activateObjectBadges ()
	deactivateObjectBadges ()
	confirmDeleteObjectBadges ()
	deleteObjectBadges ()
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	showMountWebfolderIcon ()
	setTabs ()
	set admin tabs public More...
	setAdminTabs ()
	set admin tabs public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...
	redirectToRefId ($a_ref_id, $a_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 $_GET["ref_id"] value More...
	fillCloneTemplate ($a_tpl_varname, $a_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...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Attributes
	$rbacsystem
	$access
	$toolbar
	$tabs
Protected Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...
Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Detailed Description

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

Version

$Id:$

ilObjBadgeAdministrationGUI: ilPermissionGUI, ilBadgeManagementGUI ilObjBadgeAdministrationGUI: ilAdministrationGUI

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

Constructor & Destructor Documentation

__construct()

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

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

References $DIC.

    {
        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->lng->loadLanguageModule("badge");
    }

Member Function Documentation

activateObjectBadges()

ilObjBadgeAdministrationGUI::activateObjectBadges ( )

protected

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

References toggleObjectBadges().

    {
        $this->toggleObjectBadges(true);
    }

Here is the call graph for this function:

activateTypes()

ilObjBadgeAdministrationGUI::activateTypes ( )

protected

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

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

    {
        $lng = $this->lng;
        
        $this->assertActive();
        
        $ids = $_POST["id"];
        if ($this->checkPermissionBool("write") && is_array($ids) && count($ids) > 0) {
            $handler = ilBadgeHandler::getInstance();
            $inactive = array();
            foreach ($handler->getInactiveTypes() as $type) {
                if (!in_array($type, $ids)) {
                    $inactive[] = $type;
                }
            }
            $handler->setInactiveTypes($inactive);
            
            ilUtil::sendSuccess($lng->txt("settings_saved"), true);
        }
        $this->ctrl->redirect($this, "listTypes");
    }

Here is the call graph for this function:

addImageTemplate()

ilObjBadgeAdministrationGUI::addImageTemplate ( ilPropertyFormGUI  $a_form = null )

protected

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

References ilObjectGUI\$tpl, assertActive(), ilObjectGUI\checkPermission(), and initImageTemplateForm().

Referenced by saveImageTemplate().

    {
        $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:

applyObjectFilter()

ilObjBadgeAdministrationGUI::applyObjectFilter ( )

protected

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

References $access, $tbl, and listObjectBadges().

    {
        $ilAccess = $this->access;
        
        include_once "Services/Badge/classes/class.ilObjectBadgeTableGUI.php";
        $tbl = new ilObjectBadgeTableGUI(
            $this,
            "listObjectBadges",
            $ilAccess->checkAccess("write", "", $this->object->getRefId())
        );
        $tbl->resetOffset();
        $tbl->writeFilterToSession();
        $this->listObjectBadges();
    }

Here is the call graph for this function:

applyUserFilter()

ilObjBadgeAdministrationGUI::applyUserFilter ( )

protected

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

References $tbl, and listObjectBadgeUsers().

    {
        include_once "Services/Badge/classes/class.ilBadgeUserTableGUI.php";
        $tbl = new ilBadgeUserTableGUI($this, "listUsers", null, null, $parent_obj_id, (int) $_REQUEST["bid"]);
        $tbl->resetOffset();
        $tbl->writeFilterToSession();
        $this->listObjectBadgeUsers();
    }

Here is the call graph for this function:

assertActive()

ilObjBadgeAdministrationGUI::assertActive ( )

protected

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

References ilBadgeHandler\getInstance().

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

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

References ilObjectGUI\$ctrl, $ilCtrl, ilObjectGUI\$lng, $tabs, ilObjectGUI\$tpl, and ilObjectGUI\checkPermission().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        
        $this->checkPermission("write");
        
        $tmpl_ids = $_REQUEST["id"];
        if (!$tmpl_ids) {
            $ilCtrl->redirect($this, "listImageTemplates");
        }
                
        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $lng->txt("back"),
            $ilCtrl->getLinkTarget($this, "listImageTemplates")
        );
        
        include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
        $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");
        
        include_once("./Services/Badge/classes/class.ilBadgeImageTemplate.php");
        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:

confirmDeleteObjectBadges()

ilObjBadgeAdministrationGUI::confirmDeleteObjectBadges ( )

protected

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

References $container, ilObjectGUI\$ctrl, $ilCtrl, ilObjectGUI\$lng, $tabs, ilObjectGUI\$tpl, ilBadgeAssignment\getInstancesByBadgeId(), and getObjectBadgesFromMultiAction().

    {
        $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")
        );
        
        include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
        $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");
            
        include_once "Services/Badge/classes/class.ilBadge.php";
        include_once "Services/Badge/classes/class.ilBadgeAssignment.php";
        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 ((bool) $parent["deleted"]) {
                $container .= ' <span class="il_ItemAlertProperty">' . $lng->txt("deleted") . '</span>';
            }
            
            $confirmation_gui->addItem(
                "id[]",
                $badge_id,
                $container . " - " .
                $badge->getTitle() .
                " (" . sizeof(ilBadgeAssignment::getInstancesByBadgeId($badge_id)) . ")"
            );
        }

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

Here is the call graph for this function:

deactivateObjectBadges()

ilObjBadgeAdministrationGUI::deactivateObjectBadges ( )

protected

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

References toggleObjectBadges().

    {
        $this->toggleObjectBadges(false);
    }

Here is the call graph for this function:

deactivateTypes()

ilObjBadgeAdministrationGUI::deactivateTypes ( )

protected

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

References $_POST, $handler, ilObjectGUI\$lng, assertActive(), ilObjectGUI\checkPermissionBool(), and ilBadgeHandler\getInstance().

    {
        $lng = $this->lng;
        
        $this->assertActive();
        
        $ids = $_POST["id"];
        if ($this->checkPermissionBool("write") && is_array($ids) && count($ids) > 0) {
            $handler = ilBadgeHandler::getInstance();
            $inactive = array_merge($handler->getInactiveTypes(), $ids);
            $handler->setInactiveTypes($inactive);
            
            ilUtil::sendSuccess($lng->txt("settings_saved"), true);
        }
        $this->ctrl->redirect($this, "listTypes");
    }

Here is the call graph for this function:

deleteImageTemplates()

ilObjBadgeAdministrationGUI::deleteImageTemplates ( )

protected

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

References ilObjectGUI\$ctrl, $ilCtrl, ilObjectGUI\$lng, and ilObjectGUI\checkPermission().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $this->checkPermission("write");
        
        $tmpl_ids = $_REQUEST["id"];
        if ($tmpl_ids) {
            include_once("./Services/Badge/classes/class.ilBadgeImageTemplate.php");
            foreach ($tmpl_ids as $tmpl_id) {
                $tmpl = new ilBadgeImageTemplate($tmpl_id);
                $tmpl->delete();
            }
        
            ilUtil::sendSuccess($lng->txt("settings_saved"), true);
        }
        
        $ilCtrl->redirect($this, "listImageTemplates");
    }

Here is the call graph for this function:

deleteObjectBadges()

ilObjBadgeAdministrationGUI::deleteObjectBadges ( )

protected

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

References ilObjectGUI\$ctrl, $ilCtrl, ilObjectGUI\$lng, and getObjectBadgesFromMultiAction().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $badge_ids = $this->getObjectBadgesFromMultiAction();
        
        include_once "Services/Badge/classes/class.ilBadge.php";
        foreach ($badge_ids as $badge_id) {
            $badge = new ilBadge($badge_id);
            $badge->delete();
        }
        
        ilUtil::sendSuccess($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 424 of file class.ilObjBadgeAdministrationGUI.php.

References ilObjectGUI\$ctrl, $ilCtrl, ilObjectGUI\$tpl, assertActive(), ilObjectGUI\checkPermission(), initImageTemplateForm(), and setImageTemplateFormValues().

Referenced by updateImageTemplate().

    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        
        $this->checkPermission("write");
        
        $this->assertActive();
        $this->tabs_gui->setTabActive("imgtmpl");
                
        $tmpl_id = $_REQUEST["tid"];
        if (!$tmpl_id) {
            $ilCtrl->redirect($this, "listImageTemplates");
        }
        
        $ilCtrl->setParameter($this, "tid", $tmpl_id);
        
        include_once "Services/Badge/classes/class.ilBadgeImageTemplate.php";
        $tmpl = new ilBadgeImageTemplate($tmpl_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 (   $a_form = null )

protected

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

References initFormSettings().

Referenced by saveSettings().

    {
        $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 57 of file class.ilObjBadgeAdministrationGUI.php.

References assertActive(), and ilObjectGUI\prepareOutput().

    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        $this->prepareOutput();

        switch ($next_class) {
            case 'ilpermissiongui':
                $this->tabs_gui->setTabActive('perm_settings');
                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
            
            case 'ilbadgemanagementgui':
                $this->assertActive();
                $this->tabs_gui->setTabActive('activity');
                include_once "Services/Badge/classes/class.ilBadgeManagementGUI.php";
                $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;
        }
        return true;
    }

Here is the call graph for this function:

getAdminTabs()

ilObjBadgeAdministrationGUI::getAdminTabs

(

)

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

References $rbacsystem, and ilBadgeHandler\getInstance().

    {
        $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 664 of file class.ilObjBadgeAdministrationGUI.php.

References $access, ilObjectGUI\$ctrl, and $ilCtrl.

Referenced by confirmDeleteObjectBadges(), deleteObjectBadges(), and toggleObjectBadges().

    {
        $ilAccess = $this->access;
        $ilCtrl = $this->ctrl;
        
        $badge_ids = $_REQUEST["id"];
        if (!$badge_ids ||
            !$ilAccess->checkAccess("write", "", $this->object->getRefId())) {
            $ilCtrl->redirect($this, "listObjectBadges");
        }
        
        return $badge_ids;
    }

Here is the caller graph for this function:

initFormSettings()

ilObjBadgeAdministrationGUI::initFormSettings ( )

protected

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

References $access, $form, $handler, ilBadgeHandler\getInstance(), and ilFormPropertyGUI\setInfo().

Referenced by editSettings(), and saveSettings().

    {
        $ilAccess = $this->access;
        
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $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);

        /* see bug #0020124
        $obi = new ilCheckboxInputGUI($this->lng->txt("badge_obi_activate"), "obi");
        $obi->setInfo($this->lng->txt("badge_obi_activate_info"));
        $form->addItem($obi);

            $obi_org = new ilTextInputGUI($this->lng->txt("badge_obi_organisation"), "obi_org");
            $obi_org->setRequired(true);
            $obi_org->setInfo($this->lng->txt("badge_obi_organisation_info"));
            $obi->addSubItem($obi_org);

            $obi_contact = new ilEmailInputGUI($this->lng->txt("badge_obi_contact"), "obi_cont");
            $obi_contact->setRequired(true);
            $obi_contact->setInfo($this->lng->txt("badge_obi_contact_info"));
            $obi->addSubItem($obi_contact);

            $obi_salt = new ilTextInputGUI($this->lng->txt("badge_obi_salt"), "obi_salt");
            $obi_salt->setRequired(true);
            $obi_salt->setInfo($this->lng->txt("badge_obi_salt_info"));
            $obi->addSubItem($obi_salt);
        */

        $handler = ilBadgeHandler::getInstance();
        $act->setChecked($handler->isActive());

        /* see bug 0020124
        $obi->setChecked($handler->isObiActive());
        $obi_org->setValue($handler->getObiOrganistation());
        $obi_contact->setValue($handler->getObiContact());
        $obi_salt->setValue($handler->getObiSalt());
        */
        
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initImageTemplateForm()

ilObjBadgeAdministrationGUI::initImageTemplateForm (   $a_mode )

protected

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

References ilObjectGUI\$ctrl, $form, $id, $ilCtrl, $img, ilObjectGUI\$lng, $title, $type, ilBadgeHandler\getInstance(), and ilFormPropertyGUI\setRequired().

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

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
        $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->setALlowDeletion(false);
        $form->addItem($img);
        
        $types_mode = new ilRadioGroupInputGUI($lng->txt("badge_template_types"), "tmode");
        $types_mode->setRequired(true);
        $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() 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 307 of file class.ilObjBadgeAdministrationGUI.php.

References $access, ilObjectGUI\$ctrl, $ilCtrl, ilObjectGUI\$lng, $tbl, $toolbar, assertActive(), and ilObjectGUI\checkPermissionBool().

    {
        $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")
            );
        }
        
        include_once "Services/Badge/classes/class.ilBadgeImageTemplateTableGUI.php";
        $tbl = new ilBadgeImageTemplateTableGUI(
            $this,
            "listImageTemplates",
            $ilAccess->checkAccess("write", "", $this->object->getRefId())
        );
        $this->tpl->setContent($tbl->getHTML());
    }

Here is the call graph for this function:

listObjectBadges()

ilObjBadgeAdministrationGUI::listObjectBadges ( )

protected

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

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

Referenced by applyObjectFilter(), and resetObjectFilter().

    {
        $ilAccess = $this->access;
        $tpl = $this->tpl;
        
        $this->assertActive();
        $this->tabs_gui->setTabActive("obj_badges");
        
        include_once("./Services/Badge/classes/class.ilObjectBadgeTableGUI.php");
        $tbl = new ilObjectBadgeTableGUI(
            $this,
            "listObjectBadges",
            $ilAccess->checkAccess("write", "", $this->object->getRefId())
        );
        $tpl->setContent($tbl->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listObjectBadgeUsers()

ilObjBadgeAdministrationGUI::listObjectBadgeUsers ( )

protected

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

References ilObjectGUI\$ctrl, $ilCtrl, ilObjectGUI\$lng, $tbl, ilObjectGUI\$tpl, and assertActive().

Referenced by applyUserFilter(), and resetUserFilter().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;
        
        $parent_obj_id = $_REQUEST["pid"];
        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");
        
        include_once "Services/Badge/classes/class.ilBadgeUserTableGUI.php";
        $tbl = new ilBadgeUserTableGUI($this, "listUsers", null, null, $parent_obj_id, (int) $_REQUEST["bid"]);
        $tpl->setContent($tbl->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listTypes()

ilObjBadgeAdministrationGUI::listTypes ( )

protected

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

References $access, $tbl, and assertActive().

    {
        $ilAccess = $this->access;
        
        $this->assertActive();
        $this->tabs_gui->setTabActive("types");
        
        include_once "Services/Badge/classes/class.ilBadgeTypesTableGUI.php";
        $tbl = new ilBadgeTypesTableGUI(
            $this,
            "listTypes",
            $ilAccess->checkAccess("write", "", $this->object->getRefId())
        );
        $this->tpl->setContent($tbl->getHTML());
    }

Here is the call graph for this function:

resetObjectFilter()

ilObjBadgeAdministrationGUI::resetObjectFilter ( )

protected

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

References $access, $tbl, and listObjectBadges().

    {
        $ilAccess = $this->access;
        
        include_once "Services/Badge/classes/class.ilObjectBadgeTableGUI.php";
        $tbl = new ilObjectBadgeTableGUI(
            $this,
            "listObjectBadges",
            $ilAccess->checkAccess("write", "", $this->object->getRefId())
        );
        $tbl->resetOffset();
        $tbl->resetFilter();
        $this->listObjectBadges();
    }

Here is the call graph for this function:

resetUserFilter()

ilObjBadgeAdministrationGUI::resetUserFilter ( )

protected

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

References $tbl, and listObjectBadgeUsers().

    {
        include_once "Services/Badge/classes/class.ilBadgeUserTableGUI.php";
        $tbl = new ilBadgeUserTableGUI($this, "listUsers", null, null, $parent_obj_id, (int) $_REQUEST["bid"]);
        $tbl->resetOffset();
        $tbl->resetFilter();
        $this->listObjectBadgeUsers();
    }

Here is the call graph for this function:

saveImageTemplate()

ilObjBadgeAdministrationGUI::saveImageTemplate ( )

protected

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

References ilObjectGUI\$ctrl, $form, $ilCtrl, ilObjectGUI\$lng, addImageTemplate(), ilObjectGUI\checkPermission(), and initImageTemplateForm().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $this->checkPermission("write");
        
        $form = $this->initImageTemplateForm("create");
        if ($form->checkInput()) {
            include_once "Services/Badge/classes/class.ilBadgeImageTemplate.php";
            $tmpl = new ilBadgeImageTemplate();
            $tmpl->setTitle($form->getInput("title"));
            $tmpl->setTypes($form->getInput("type"));
            $tmpl->create();
            
            $tmpl->uploadImage($_FILES["img"]);
            
            ilUtil::sendSuccess($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 161 of file class.ilObjBadgeAdministrationGUI.php.

References ilObjectGUI\$ctrl, $form, $handler, $ilCtrl, ilObjectGUI\checkPermission(), editSettings(), ilBadgeHandler\getInstance(), and initFormSettings().

    {
        $ilCtrl = $this->ctrl;
        
        $this->checkPermission("write");
        
        $form = $this->initFormSettings();
        if ($form->checkInput()) {
            $obi = (bool) $form->getInput("act")
                ? (bool) $form->getInput("obi")
                : null;
        
            $handler = ilBadgeHandler::getInstance();
            $handler->setActive((bool) $form->getInput("act"));
            $handler->setObiActive($obi);
            $handler->setObiOrganisation(trim($form->getInput("obi_org")));
            $handler->setObiContact(trim($form->getInput("obi_cont")));
            $handler->setObiSalt(trim($form->getInput("obi_salt")));
            
            $handler->rebuildIssuerStaticUrl();
            
            ilUtil::sendSuccess($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 452 of file class.ilObjBadgeAdministrationGUI.php.

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

Referenced by editImageTemplate(), and updateImageTemplate().

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

Here is the call graph for this function:

Here is the caller graph for this function:

toggleObjectBadges()

ilObjBadgeAdministrationGUI::toggleObjectBadges (   $a_status )

protected

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

References ilObjectGUI\$ctrl, $ilCtrl, ilObjectGUI\$lng, and getObjectBadgesFromMultiAction().

Referenced by activateObjectBadges(), and deactivateObjectBadges().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $badge_ids = $this->getObjectBadgesFromMultiAction();
        
        include_once "Services/Badge/classes/class.ilBadge.php";
        foreach ($badge_ids as $badge_id) {
            $badge = new ilBadge($badge_id);
            $badge->setActive($a_status);
            $badge->update();
        }
        
        ilUtil::sendSuccess($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 466 of file class.ilObjBadgeAdministrationGUI.php.

References ilObjectGUI\$ctrl, $form, $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\checkPermission(), editImageTemplate(), initImageTemplateForm(), and setImageTemplateFormValues().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $this->checkPermission("write");
        
        $tmpl_id = $_REQUEST["tid"];
        if (!$tmpl_id) {
            $ilCtrl->redirect($this, "listImageTemplates");
        }
        
        $ilCtrl->setParameter($this, "tid", $tmpl_id);
        
        include_once "Services/Badge/classes/class.ilBadgeImageTemplate.php";
        $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"]);
        
            ilUtil::sendSuccess($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

$access

ilObjBadgeAdministrationGUI::$access

protected

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

Referenced by applyObjectFilter(), getObjectBadgesFromMultiAction(), initFormSettings(), listImageTemplates(), listObjectBadges(), listTypes(), and resetObjectFilter().

$rbacsystem

ilObjBadgeAdministrationGUI::$rbacsystem

protected

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

Referenced by getAdminTabs().

$tabs

ilObjBadgeAdministrationGUI::$tabs

protected

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

Referenced by confirmDeleteImageTemplates(), and confirmDeleteObjectBadges().

$toolbar

ilObjBadgeAdministrationGUI::$toolbar

protected

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

Referenced by listImageTemplates().

---

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

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