ilBadgeManagementGUI Class Reference

Collaboration diagram for ilBadgeManagementGUI:

Public Member Functions
	__construct ($a_parent_ref_id, $a_parent_obj_id=null, $a_parent_obj_type=null)
	Construct. More...
	executeCommand ()

Data Fields
const	CLIPBOARD_ID = "bdgclpbrd"

Protected Member Functions
	setTabs ($a_active)
	hasWrite ()
	listBadges ()
	applyBadgeFilter ()
	resetBadgeFilter ()
	addBadge (ilPropertyFormGUI $a_form=null)
	initBadgeForm ($a_mode, ilBadgeType $a_type, $a_type_unique_id)
	saveBadge ()
	editBadge (ilPropertyFormGUI $a_form=null)
	setBadgeFormValues (ilPropertyFormGUI $a_form, ilBadge $a_badge, ilBadgeType $a_type)
	updateBadge ()
	confirmDeleteBadges ()
	deleteBadges ()
	getBadgesFromMultiAction ()
	copyBadges ()
	clearClipboard ()
	getValidBadgesFromClipboard ()
	pasteBadges ()
	toggleBadges ($a_status)
	activateBadges ()
	deactivateBadges ()
	listUsers ()
	applyListUsers ()
	resetListUsers ()
	awardBadgeUserSelection ()
	applyAwardBadgeUserSelection ()
	resetAwardBadgeUserSelection ()
	assignBadge ()
	confirmDeassignBadge ()
	deassignBadge ()

Protected Attributes
	$parent_ref_id
	$parent_obj_id
	$parent_obj_type

Detailed Description

Definition at line 14 of file class.ilBadgeManagementGUI.php.

Constructor & Destructor Documentation

__construct()

ilBadgeManagementGUI::__construct	(		$a_parent_ref_id,
			$a_parent_obj_id = null,
			$a_parent_obj_type = null
	)

Construct.

Parameters

int	$a_parent_ref_id
int	$a_parent_obj_id
string	$a_parent_obj_type

Returns

self

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

References $lng, ilObject\_lookupObjId(), ilObject\_lookupType(), and ilBadgeHandler\getInstance().

        {
                global $lng;
                
                $this->parent_ref_id = $a_parent_ref_id;
                $this->parent_obj_id = $a_parent_obj_id
                        ? $a_parent_obj_id
                        : ilObject::_lookupObjId($a_parent_ref_id);
                $this->parent_obj_type = $a_parent_obj_type 
                        ? $a_parent_obj_type
                        : ilObject::_lookupType($this->parent_obj_id);

                if(!ilBadgeHandler::getInstance()->isObjectActive($this->parent_obj_id))
                {
                        throw new ilException("inactive object");
                }
                
                $lng->loadLanguageModule("badge");
        }

Here is the call graph for this function:

Member Function Documentation

activateBadges()

ilBadgeManagementGUI::activateBadges ( )

protected

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

References toggleBadges().

        {
                $this->toggleBadges(true);
        }

Here is the call graph for this function:

addBadge()

ilBadgeManagementGUI::addBadge ( ilPropertyFormGUI  $a_form = null )

protected

Definition at line 226 of file class.ilBadgeManagementGUI.php.

References $ilCtrl, $tpl, ilBadgeHandler\getInstance(), hasWrite(), and initBadgeForm().

Referenced by saveBadge().

        {                               
                global $ilCtrl, $tpl;
                
                $type_id = $_REQUEST["type"];
                if(!$type_id || 
                        !$this->hasWrite())
                {
                        $ilCtrl->redirect($this, "listBadges");
                }
                
                $ilCtrl->setParameter($this, "type", $type_id);
                
                $handler = ilBadgeHandler::getInstance();
                $type = $handler->getTypeInstanceByUniqueId($type_id);          
                if(!$type)
                {
                        $ilCtrl->redirect($this, "listBadges");
                }
                
                if(!$a_form)
                {
                        $a_form = $this->initBadgeForm("create", $type, $type_id);
                }
                
                $tpl->setContent($a_form->getHTML());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

applyAwardBadgeUserSelection()

ilBadgeManagementGUI::applyAwardBadgeUserSelection ( )

protected

Definition at line 755 of file class.ilBadgeManagementGUI.php.

References $tbl, and awardBadgeUserSelection().

        {
                include_once "Services/Badge/classes/class.ilBadgeUserTableGUI.php";
                $tbl = new ilBadgeUserTableGUI($this, "awardBadgeUserSelection", $this->parent_ref_id);
                $tbl->resetOffset();
                $tbl->writeFilterToSession();
                $this->awardBadgeUserSelection();
        }

Here is the call graph for this function:

applyBadgeFilter()

ilBadgeManagementGUI::applyBadgeFilter ( )

protected

Definition at line 203 of file class.ilBadgeManagementGUI.php.

References $tbl, hasWrite(), and listBadges().

        {
                include_once "Services/Badge/classes/class.ilBadgeTableGUI.php";
                $tbl = new ilBadgeTableGUI($this, "listBadges", $this->parent_obj_id, $this->hasWrite());
                $tbl->resetOffset();
                $tbl->writeFilterToSession();
                $this->listBadges();
        }

Here is the call graph for this function:

applyListUsers()

ilBadgeManagementGUI::applyListUsers ( )

protected

Definition at line 699 of file class.ilBadgeManagementGUI.php.

References $tbl, and listUsers().

        {
                include_once "Services/Badge/classes/class.ilBadgeUserTableGUI.php";
                $tbl = new ilBadgeUserTableGUI($this, "listUsers", $this->parent_ref_id);
                $tbl->resetOffset();
                $tbl->writeFilterToSession();
                $this->listUsers();
        }

Here is the call graph for this function:

assignBadge()

ilBadgeManagementGUI::assignBadge ( )

protected

Definition at line 773 of file class.ilBadgeManagementGUI.php.

References $_POST, $ilCtrl, $ilUser, $lng, array, ilBadgeAssignment\exists(), ilBadgeHandler\getInstance(), hasWrite(), and ilUtil\sendSuccess().

        {
                global $ilCtrl, $ilUser, $lng;
                
                $user_ids = $_POST["id"];
                $badge_id = $_REQUEST["bid"];
                if(!$user_ids ||
                        !$badge_id ||
                        !$this->hasWrite())
                {
                        $ilCtrl->redirect($this, "listUsers");
                }
                
                include_once "Services/Badge/classes/class.ilBadgeAssignment.php";
                $new_badges = array();
                foreach($user_ids as $user_id)
                {
                        if(!ilBadgeAssignment::exists($badge_id, $user_id))
                        {
                                $ass = new ilBadgeAssignment($badge_id, $user_id);
                                $ass->setAwardedBy($ilUser->getId());
                                $ass->store();  
                                
                                $new_badges[$user_id][] = $badge_id;
                        }
                }
                
                ilBadgeHandler::getInstance()->sendNotification($new_badges, $this->parent_ref_id);
                
                ilUtil::sendSuccess($lng->txt("settings_saved"), true);
                $ilCtrl->redirect($this, "listUsers");
        }       

Here is the call graph for this function:

awardBadgeUserSelection()

ilBadgeManagementGUI::awardBadgeUserSelection ( )

protected

Definition at line 717 of file class.ilBadgeManagementGUI.php.

References $ilCtrl, $lng, $tbl, $tpl, ilBadgeHandler\getInstance(), and hasWrite().

Referenced by applyAwardBadgeUserSelection(), and resetAwardBadgeUserSelection().

        {
                global $ilCtrl, $tpl, $ilTabs, $lng;
                
                $bid = (int)$_REQUEST["bid"];
                if(!$bid || 
                        !$this->hasWrite())
                {
                        $ilCtrl->redirect($this, "listUsers");
                }
                
                $manual = array_keys(ilBadgeHandler::getInstance()->getAvailableManualBadges($this->parent_obj_id, $this->parent_obj_type));
                if(!in_array($bid, $manual))
                {
                        $ilCtrl->redirect($this, "listUsers");
                }
                
                $back_target = "listUsers";
                if($_REQUEST["tgt"] == "bdgl")
                {
                        $ilCtrl->saveParameter($this, "tgt");
                        $back_target = "listBadges";
                }
                
                $ilTabs->clearTargets();
                $ilTabs->setBackTarget($lng->txt("back"),
                        $ilCtrl->getLinkTarget($this, $back_target));
                
                $ilCtrl->setParameter($this, "bid", $bid);
                
                include_once "./Services/Badge/classes/class.ilBadge.php";
                $badge = new ilBadge($bid);
                
                include_once "Services/Badge/classes/class.ilBadgeUserTableGUI.php";
                $tbl = new ilBadgeUserTableGUI($this, "awardBadgeUserSelection", $this->parent_ref_id, $badge);
                $tpl->setContent($tbl->getHTML());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

clearClipboard()

ilBadgeManagementGUI::clearClipboard ( )

protected

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

References $_SESSION, and $ilCtrl.

        {
                global $ilCtrl;
                
                unset($_SESSION[self::CLIPBOARD_ID]);
                $ilCtrl->redirect($this, "listBadges");
        }

confirmDeassignBadge()

ilBadgeManagementGUI::confirmDeassignBadge ( )

protected

Definition at line 806 of file class.ilBadgeManagementGUI.php.

References $_POST, $ilCtrl, $lng, $tpl, ilBadgeAssignment\getAssignedUsers(), ilUserUtil\getNamePresentation(), and hasWrite().

        {
                global $ilCtrl, $lng, $tpl, $ilTabs;    
                                                
                $user_ids = $_POST["id"];
                $badge_id = $_REQUEST["bid"];
                if(!$user_ids ||
                        !$badge_id ||
                        !$this->hasWrite())
                {
                        $ilCtrl->redirect($this, "listUsers");
                }
                                
                $ilTabs->clearTargets();
                $ilTabs->setBackTarget($lng->txt("back"),
                        $ilCtrl->getLinkTarget($this, "listUsers"));            
                
                include_once "Services/Badge/classes/class.ilBadge.php";        
                $badge = new ilBadge($badge_id);
                
                $ilCtrl->setParameter($this, "bid", $badge->getId());
                
                include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
                $confirmation_gui = new ilConfirmationGUI();
                $confirmation_gui->setFormAction($ilCtrl->getFormAction($this));
                $confirmation_gui->setHeaderText(sprintf($lng->txt("badge_assignment_deletion_confirmation"), $badge->getTitle()));
                $confirmation_gui->setCancel($lng->txt("cancel"), "listUsers");
                $confirmation_gui->setConfirm($lng->txt("delete"), "deassignBadge");
                        
                include_once "Services/Badge/classes/class.ilBadgeAssignment.php";
                $assigned_users = ilBadgeAssignment::getAssignedUsers($badge->getId()); 
                
                include_once "Services/User/classes/class.ilUserUtil.php";
                foreach($user_ids as $user_id)
                {
                        if(in_array($user_id, $assigned_users))
                        {                               
                                $confirmation_gui->addItem(
                                        "id[]", 
                                        $user_id, 
                                        ilUserUtil::getNamePresentation($user_id, false, false, "", true)
                                );
                        }
                }

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

Here is the call graph for this function:

confirmDeleteBadges()

ilBadgeManagementGUI::confirmDeleteBadges ( )

protected

Definition at line 517 of file class.ilBadgeManagementGUI.php.

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

        {
                global $ilCtrl, $lng, $tpl, $ilTabs;    
                                                                
                $badge_ids = $this->getBadgesFromMultiAction();
                                
                $ilTabs->clearTargets();
                $ilTabs->setBackTarget($lng->txt("back"),
                        $ilCtrl->getLinkTarget($this, "listBadges"));           
                
                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"), "listBadges");
                $confirmation_gui->setConfirm($lng->txt("delete"), "deleteBadges");
                        
                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);
                        $confirmation_gui->addItem("id[]", $badge_id, $badge->getTitle().
                                " (".sizeof(ilBadgeAssignment::getInstancesByBadgeId($badge_id)).")");                  
                }

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

Here is the call graph for this function:

copyBadges()

ilBadgeManagementGUI::copyBadges ( )

protected

Definition at line 582 of file class.ilBadgeManagementGUI.php.

References $_SESSION, $ilCtrl, array, and getBadgesFromMultiAction().

        {
                global $ilCtrl;
                
                $badge_ids = $this->getBadgesFromMultiAction();         

                $_SESSION[self::CLIPBOARD_ID] = array_unique(
                        array_merge((array)$_SESSION[self::CLIPBOARD_ID], $badge_ids)
                );              
                
                $ilCtrl->redirect($this, "listBadges");
        }       

Here is the call graph for this function:

deactivateBadges()

ilBadgeManagementGUI::deactivateBadges ( )

protected

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

References toggleBadges().

        {
                $this->toggleBadges(false);
        }

Here is the call graph for this function:

deassignBadge()

ilBadgeManagementGUI::deassignBadge ( )

protected

Definition at line 854 of file class.ilBadgeManagementGUI.php.

References $_POST, $ilCtrl, $lng, hasWrite(), and ilUtil\sendSuccess().

        {
                global $ilCtrl, $lng;
                
                $user_ids = $_POST["id"];
                $badge_id = $_REQUEST["bid"];
                if(!$user_ids ||
                        !$badge_id ||
                        !$this->hasWrite())
                {
                        $ilCtrl->redirect($this, "listUsers");
                }
                
                include_once "Services/Badge/classes/class.ilBadgeAssignment.php";
                foreach($user_ids as $user_id)
                {
                        $ass = new ilBadgeAssignment($badge_id, $user_id);
                        $ass->delete();
                }
                
                ilUtil::sendSuccess($lng->txt("settings_saved"), true);
                $ilCtrl->redirect($this, "listUsers");          
        }       

Here is the call graph for this function:

deleteBadges()

ilBadgeManagementGUI::deleteBadges ( )

protected

Definition at line 546 of file class.ilBadgeManagementGUI.php.

References $ilCtrl, $lng, getBadgesFromMultiAction(), and ilUtil\sendSuccess().

        {
                global $ilCtrl, $lng;
                
                $badge_ids = $this->getBadgesFromMultiAction();
                
                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, "listBadges");         
        }       

Here is the call graph for this function:

editBadge()

ilBadgeManagementGUI::editBadge ( ilPropertyFormGUI  $a_form = null )

protected

Definition at line 417 of file class.ilBadgeManagementGUI.php.

References $ilCtrl, $lng, $tpl, ilBadgeHandler\getInstance(), hasWrite(), initBadgeForm(), ilUtil\sendInfo(), and setBadgeFormValues().

Referenced by updateBadge().

        {                               
                global $ilCtrl, $tpl, $lng;
                
                $badge_id = $_REQUEST["bid"];
                if(!$badge_id || 
                        !$this->hasWrite())
                {
                        $ilCtrl->redirect($this, "listBadges");
                }
                
                $ilCtrl->setParameter($this, "bid", $badge_id);
                
                include_once "./Services/Badge/classes/class.ilBadge.php";
                $badge = new ilBadge($badge_id);
                
                $static_cnt = ilBadgeHandler::getInstance()->countStaticBadgeInstances($badge);
                if($static_cnt)
                {
                        ilUtil::sendInfo(sprintf($lng->txt("badge_edit_with_published"), $static_cnt));
                }
                
                if(!$a_form)
                {                       
                        $type = $badge->getTypeInstance();
                        $a_form = $this->initBadgeForm("edit", $type, $badge->getTypeId());                     
                        $this->setBadgeFormValues($a_form, $badge, $type);
                }
                
                $tpl->setContent($a_form->getHTML());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilBadgeManagementGUI::executeCommand

(

)

Definition at line 50 of file class.ilBadgeManagementGUI.php.

References $cmd, $ilCtrl, $lng, ilBadgeHandler\getInstance(), and initBadgeForm().

        {
                global $ilCtrl, $ilTabs, $lng;
                
                $next_class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd("listBadges");

                switch($next_class)
                {                                       
                        case "ilpropertyformgui":
                                // ajax - update
                                if((int)$_REQUEST["bid"])
                                {
                                        include_once "./Services/Badge/classes/class.ilBadge.php";
                                        $badge = new ilBadge((int)$_REQUEST["bid"]);
                                        $type = $badge->getTypeInstance();                      
                                        $form = $this->initBadgeForm("edit", $type, $badge->getTypeId());
                                }
                                // ajax- create
                                else
                                {
                                        $type_id = $_REQUEST["type"];                   
                                        $ilCtrl->setParameter($this, "type", $type_id);         
                                        $handler = ilBadgeHandler::getInstance();
                                        $type = $handler->getTypeInstanceByUniqueId($type_id);  
                                        $form = $this->initBadgeForm("create", $type, $type_id);
                                }                                                       
                                $ilCtrl->forwardCommand($form); 
                                break;
                                
                        /*
                        case "illplistofsettingsgui":                           
                                $id = $_GET["lpid"];
                                if($id)
                                {
                                        $ilCtrl->saveParameter($this, "bid");
                                        $ilCtrl->saveParameter($this, "lpid");                                  
                                        
                                        $ilTabs->clearTargets();
                                        $ilTabs->setBackTarget(
                                                $lng->txt("back"), 
                                                $ilCtrl->getLinkTarget($this, "editBadge")
                                        );
                                        include_once './Services/Tracking/classes/class.ilLearningProgressGUI.php';
                                        include_once "Services/Tracking/classes/repository_statistics/class.ilLPListOfSettingsGUI.php";
                                        $lpgui = new ilLPListOfSettingsGUI(ilLearningProgressGUI::LP_CONTEXT_REPOSITORY, $id);
                                        $ilCtrl->forwardCommand($lpgui);                        
                                        break;
                                }
                        */
                                
                        default:        
                                $this->$cmd();
                                break;
                }
                
                return true;
        }

Here is the call graph for this function:

getBadgesFromMultiAction()

ilBadgeManagementGUI::getBadgesFromMultiAction ( )

protected

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

References $ilCtrl, and hasWrite().

Referenced by confirmDeleteBadges(), copyBadges(), deleteBadges(), and toggleBadges().

        {
                global $ilCtrl;
                
                $badge_ids = $_REQUEST["id"];
                if(!$badge_ids ||
                        !$this->hasWrite())
                {
                        $ilCtrl->redirect($this, "listBadges");
                }
                
                return $badge_ids;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getValidBadgesFromClipboard()

ilBadgeManagementGUI::getValidBadgesFromClipboard ( )

protected

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

References $_SESSION, $res, array, and ilBadgeHandler\getInstance().

Referenced by listBadges(), and pasteBadges().

        {
                $res = array();
                
                $valid_types = array_keys(ilBadgeHandler::getInstance()->getAvailableTypesForObjType($this->parent_obj_type));
                        
                include_once "Services/Badge/classes/class.ilBadge.php";
                foreach($_SESSION[self::CLIPBOARD_ID] as $badge_id)
                {
                        $badge = new ilBadge($badge_id);
                        if(in_array($badge->getTypeId(), $valid_types))
                        {
                                $res[] = $badge;
                        }
                }
                
                return $res;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

hasWrite()

ilBadgeManagementGUI::hasWrite ( )

protected

Definition at line 124 of file class.ilBadgeManagementGUI.php.

Referenced by addBadge(), applyBadgeFilter(), assignBadge(), awardBadgeUserSelection(), confirmDeassignBadge(), deassignBadge(), editBadge(), getBadgesFromMultiAction(), listBadges(), listUsers(), pasteBadges(), resetBadgeFilter(), saveBadge(), and updateBadge().

        {
                global $ilAccess;
                return $ilAccess->checkAccess("write", "", $this->parent_ref_id);
        }

Here is the caller graph for this function:

initBadgeForm()

ilBadgeManagementGUI::initBadgeForm (   $a_mode, ilBadgeType  $a_type,   $a_type_unique_id  )

protected

Definition at line 254 of file class.ilBadgeManagementGUI.php.

References $ilCtrl, $lng, $options, $title, $valid, array, ilBadgeType\getCaption(), ilBadgeType\getConfigGUIInstance(), ilBadgeImageTemplate\getInstancesByType(), ilFormPropertyGUI\setRequired(), and ilFileInputGUI\setSuffixes().

Referenced by addBadge(), editBadge(), executeCommand(), saveBadge(), and updateBadge().

        {
                global $lng, $ilCtrl;
                
                include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
                $form = new ilPropertyFormGUI();
                $form->setFormAction($ilCtrl->getFormAction($this, "saveBadge"));
                $form->setTitle($lng->txt("badge_badge").' "'.$a_type->getCaption().'"');
                
                $active = new ilCheckboxInputGUI($lng->txt("active"), "act");
                $form->addItem($active);
                
                $title = new ilTextInputGUI($lng->txt("title"), "title");
                $title->setRequired(true);
                $form->addItem($title);
                
                $desc = new ilTextAreaInputGUI($lng->txt("description"), "desc");
                $desc->setRequired(true);
                $form->addItem($desc);
                
                $crit = new ilTextAreaInputGUI($lng->txt("badge_criteria"), "crit");
                $crit->setRequired(true);
                $form->addItem($crit);
                
                if($a_mode == "create")
                {
                        // upload
        
                        $img_mode = new ilRadioGroupInputGUI($lng->txt("image"), "img_mode");                   
                        $img_mode->setRequired(true);
                        $form->addItem($img_mode);                      
        
                        $img_mode_tmpl = new ilRadioOption($lng->txt("badge_image_from_template"), "tmpl");
                        $img_mode->addOption($img_mode_tmpl);

                        $img_mode_up = new ilRadioOption($lng->txt("badge_image_from_upload"), "up");
                        $img_mode->addOption($img_mode_up);
                        
                        $img_upload = new ilImageFileInputGUI($lng->txt("file"), "img");                        
                        $img_upload->setRequired(true);
                        $img_upload->setSuffixes(array("png", "svg"));
                        $img_mode_up->addSubItem($img_upload);

                        // templates
                        
                        include_once "Services/Badge/classes/class.ilBadgeImageTemplate.php";
                        $valid_templates = ilBadgeImageTemplate::getInstancesByType($a_type_unique_id);                 
                        if(sizeof($valid_templates))
                        {
                                $options = array();             
                                $options[""] = $lng->txt("please_select");                                              
                                foreach($valid_templates as $tmpl)
                                {
                                        $options[$tmpl->getId()] = $tmpl->getTitle();
                                }

                                $tmpl = new ilSelectInputGUI($lng->txt("badge_image_template_form"), "tmpl");
                                $tmpl->setRequired(true);
                                $tmpl->setOptions($options);
                                $img_mode_tmpl->addSubItem($tmpl);
                        }
                        else
                        {
                                // no templates, activate upload
                                $img_mode_tmpl->setDisabled(true);
                                $img_mode->setValue("up");
                        }
                }
                else
                {
                        $img_upload = new ilImageFileInputGUI($lng->txt("image"), "img");
                        $img_upload->setSuffixes(array("png", "svg"));
                        $img_upload->setALlowDeletion(false);
                        $form->addItem($img_upload);
                }
                
                $valid = new ilTextInputGUI($lng->txt("badge_valid"), "valid");         
                $form->addItem($valid);
                
                $custom = $a_type->getConfigGUIInstance();
                if($custom &&
                        $custom instanceof ilBadgeTypeGUI)
                {
                        $custom->initConfigForm($form, $this->parent_ref_id);
                }
                
                // :TODO: valid date/period             
                
                if($a_mode == "create")
                {
                        $form->addCommandButton("saveBadge", $lng->txt("save"));
                }
                else
                {
                        $form->addCommandButton("updateBadge", $lng->txt("save"));
                }
                $form->addCommandButton("listBadges", $lng->txt("cancel"));
                
                return $form;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

listBadges()

ilBadgeManagementGUI::listBadges ( )

protected

Definition at line 130 of file class.ilBadgeManagementGUI.php.

References $_SESSION, $ilCtrl, $lng, $options, $tbl, $tpl, ilTooltipGUI\addTooltip(), array, ilBadge\getExtendedTypeCaption(), ilBadgeHandler\getInstance(), getValidBadgesFromClipboard(), hasWrite(), ilUtil\sendInfo(), ilSelectInputGUI\setOptions(), and setTabs().

Referenced by applyBadgeFilter(), and resetBadgeFilter().

        {
                global $ilToolbar, $lng, $ilCtrl, $tpl;
                
                $this->setTabs("badges");
                
                if($this->hasWrite())
                {
                        $handler = ilBadgeHandler::getInstance();                               
                        $valid_types = $handler->getAvailableTypesForObjType($this->parent_obj_type);
                        if($valid_types)
                        {
                                include_once "Services/Badge/classes/class.ilBadge.php";
                                $options = array();
                                foreach($valid_types as $id => $type)
                                {
                                        $options[$id] = ($this->parent_obj_type != "bdga")
                                                ? ilBadge::getExtendedTypeCaption($type)
                                                : $type->getCaption();
                                }
                                asort($options);
                                
                                include_once "Services/Form/classes/class.ilSelectInputGUI.php";
                                $drop = new ilSelectInputGUI($lng->txt("type"), "type");
                                $drop->setOptions($options);
                                $ilToolbar->addInputItem($drop, true);
                                
                                $ilToolbar->setFormAction($ilCtrl->getFormAction($this, "addBadge"));
                                $ilToolbar->addFormButton($lng->txt("create"), "addBadge");
                        }
                        else
                        {
                                ilUtil::sendInfo($lng->txt("badge_no_valid_types_for_obj"));
                        }
                        
                        if(is_array($_SESSION[self::CLIPBOARD_ID]))
                        {
                                if($valid_types)
                                {
                                        $ilToolbar->addSeparator();
                                }
                                                        
                                $tt = array();
                                foreach($this->getValidBadgesFromClipboard() as $badge)
                                {
                                        $tt[] = $badge->getTitle();
                                }                                
                                $ttid = "bdgpst";
                                include_once "Services/UIComponent/Tooltip/classes/class.ilTooltipGUI.php";
                                ilTooltipGUI::addTooltip(
                                        $ttid, 
                                        implode("<br />", $tt),
                                        "",
                                        "bottom center", 
                                        "top center",
                                        false
                                );
                                 
                                $lng->loadLanguageModule("content");
                                $ilToolbar->addButton($lng->txt("cont_paste_from_clipboard").
                                                " (".sizeof($tt).")", 
                                        $ilCtrl->getLinkTarget($this, "pasteBadges"), 
                                        "", "", "", $ttid);
                                $ilToolbar->addButton($lng->txt("clear_clipboard"), 
                                        $ilCtrl->getLinkTarget($this, "clearClipboard"));
                         }
                }
                
                include_once "Services/Badge/classes/class.ilBadgeTableGUI.php";
                $tbl = new ilBadgeTableGUI($this, "listBadges", $this->parent_obj_id, $this->hasWrite());
                $tpl->setContent($tbl->getHTML());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

listUsers()

ilBadgeManagementGUI::listUsers ( )

protected

Definition at line 673 of file class.ilBadgeManagementGUI.php.

References $ilCtrl, $lng, $tbl, $tpl, ilBadgeHandler\getInstance(), hasWrite(), ilSelectInputGUI\setOptions(), and setTabs().

Referenced by applyListUsers(), and resetListUsers().

        {
                global $lng, $ilCtrl, $ilToolbar, $tpl;
                
                $this->setTabs("users");
                
                if($this->hasWrite())
                {
                        $manual = ilBadgeHandler::getInstance()->getAvailableManualBadges($this->parent_obj_id, $this->parent_obj_type);
                        if(sizeof($manual))
                        {                                                       
                                include_once "Services/Form/classes/class.ilSelectInputGUI.php";
                                $drop = new ilSelectInputGUI($lng->txt("badge_badge"), "bid");
                                $drop->setOptions($manual);
                                $ilToolbar->addInputItem($drop, true);

                                $ilToolbar->setFormAction($ilCtrl->getFormAction($this, "awardBadgeUserSelection"));
                                $ilToolbar->addFormButton($lng->txt("badge_award_badge"), "awardBadgeUserSelection");
                        }
                }
                
                include_once "Services/Badge/classes/class.ilBadgeUserTableGUI.php";
                $tbl = new ilBadgeUserTableGUI($this, "listUsers", $this->parent_ref_id);
                $tpl->setContent($tbl->getHTML());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

pasteBadges()

ilBadgeManagementGUI::pasteBadges ( )

protected

Definition at line 622 of file class.ilBadgeManagementGUI.php.

References $_SESSION, $ilCtrl, getValidBadgesFromClipboard(), and hasWrite().

        {
                global $ilCtrl;
                
                if(!$this->hasWrite() ||
                        !is_array($_SESSION[self::CLIPBOARD_ID]))
                {
                        $ilCtrl->redirect($this, "listBadges");
                }
                
                foreach($this->getValidBadgesFromClipboard() as $badge)
                {
                        $badge->copy($this->parent_obj_id);                     
                }
                
                $ilCtrl->redirect($this, "listBadges");
        }

Here is the call graph for this function:

resetAwardBadgeUserSelection()

ilBadgeManagementGUI::resetAwardBadgeUserSelection ( )

protected

Definition at line 764 of file class.ilBadgeManagementGUI.php.

References $tbl, and awardBadgeUserSelection().

        {
                include_once "Services/Badge/classes/class.ilBadgeUserTableGUI.php";
                $tbl = new ilBadgeUserTableGUI($this, "awardBadgeUserSelection", $this->parent_ref_id);
                $tbl->resetOffset();
                $tbl->resetFilter();
                $this->awardBadgeUserSelection();
        }

Here is the call graph for this function:

resetBadgeFilter()

ilBadgeManagementGUI::resetBadgeFilter ( )

protected

Definition at line 212 of file class.ilBadgeManagementGUI.php.

References $tbl, hasWrite(), and listBadges().

        {
                include_once "Services/Badge/classes/class.ilBadgeTableGUI.php";
                $tbl = new ilBadgeTableGUI($this, "listBadges", $this->parent_obj_id, $this->hasWrite());
                $tbl->resetOffset();
                $tbl->resetFilter();
                $this->listBadges();
        }

Here is the call graph for this function:

resetListUsers()

ilBadgeManagementGUI::resetListUsers ( )

protected

Definition at line 708 of file class.ilBadgeManagementGUI.php.

References $tbl, and listUsers().

        {
                include_once "Services/Badge/classes/class.ilBadgeUserTableGUI.php";
                $tbl = new ilBadgeUserTableGUI($this, "listUsers", $this->parent_ref_id);
                $tbl->resetOffset();
                $tbl->resetFilter();
                $this->listUsers();
        }

Here is the call graph for this function:

saveBadge()

ilBadgeManagementGUI::saveBadge ( )

protected

Definition at line 355 of file class.ilBadgeManagementGUI.php.

References $ilCtrl, $lng, addBadge(), ilBadgeHandler\getInstance(), hasWrite(), initBadgeForm(), and ilUtil\sendSuccess().

        {
                global $ilCtrl, $lng;
                
                $type_id = $_REQUEST["type"];
                if(!$type_id || 
                        !$this->hasWrite())
                {
                        $ilCtrl->redirect($this, "listBadges");
                }
                
                $ilCtrl->setParameter($this, "type", $type_id);
                
                $handler = ilBadgeHandler::getInstance();
                $type = $handler->getTypeInstanceByUniqueId($type_id);          
                if(!$type)
                {
                        $ilCtrl->redirect($this, "listBadges");
                }
                
                $form = $this->initBadgeForm("create", $type, $type_id);
                $custom = $type->getConfigGUIInstance();

                if($form->checkInput() &&
                        (!$custom || $custom->validateForm($form)))
                {
                        include_once "Services/Badge/classes/class.ilBadge.php";
                        $badge = new ilBadge();
                        $badge->setParentId($this->parent_obj_id); // :TODO: ref_id?
                        $badge->setTypeId($type_id);
                        $badge->setActive($form->getInput("act"));
                        $badge->setTitle($form->getInput("title"));
                        $badge->setDescription($form->getInput("desc"));
                        $badge->setCriteria($form->getInput("crit"));
                        $badge->setValid($form->getInput("valid"));

                        if($custom &&
                                $custom instanceof ilBadgeTypeGUI)
                        {
                                $badge->setConfiguration($custom->getConfigFromForm($form));
                        }
                                                
                        $badge->create();
                        
                        if($form->getInput("img_mode") == "up")
                        {
                                $badge->uploadImage($_FILES["img"]);
                        }
                        else
                        {
                                $tmpl = new ilBadgeImageTemplate($form->getInput("tmpl"));
                                $badge->importImage($tmpl->getImage(), $tmpl->getImagePath());
                        }
                                        
                        ilUtil::sendSuccess($lng->txt("settings_saved"), true);
                        $ilCtrl->redirect($this, "listBadges");
                }
                
                $form->setValuesByPost();
                $this->addBadge($form);
        }

Here is the call graph for this function:

setBadgeFormValues()

ilBadgeManagementGUI::setBadgeFormValues ( ilPropertyFormGUI  $a_form, ilBadge  $a_badge, ilBadgeType  $a_type  )

protected

Definition at line 449 of file class.ilBadgeManagementGUI.php.

References ilBadgeType\getConfigGUIInstance(), ilBadge\getConfiguration(), ilBadge\getCriteria(), ilBadge\getDescription(), ilBadge\getImage(), ilBadge\getImagePath(), ilPropertyFormGUI\getItemByPostVar(), ilBadge\getTitle(), ilBadge\getValid(), and ilBadge\isActive().

Referenced by editBadge().

        {
                $a_form->getItemByPostVar("act")->setChecked($a_badge->isActive());
                $a_form->getItemByPostVar("title")->setValue($a_badge->getTitle());
                $a_form->getItemByPostVar("desc")->setValue($a_badge->getDescription());
                $a_form->getItemByPostVar("crit")->setValue($a_badge->getCriteria());
                $a_form->getItemByPostVar("img")->setValue($a_badge->getImage());
                $a_form->getItemByPostVar("img")->setImage($a_badge->getImagePath());
                $a_form->getItemByPostVar("valid")->setValue($a_badge->getValid());
                
                $custom = $a_type->getConfigGUIInstance();
                if($custom &&
                        $custom instanceof ilBadgeTypeGUI)
                {
                        $custom->importConfigToForm($a_form, $a_badge->getConfiguration());
                }               
        }

Here is the call graph for this function:

Here is the caller graph for this function:

setTabs()

ilBadgeManagementGUI::setTabs (   $a_active )

protected

Definition at line 109 of file class.ilBadgeManagementGUI.php.

References $ilCtrl, and $lng.

Referenced by listBadges(), and listUsers().

        {
                global $ilTabs, $lng, $ilCtrl;
                
                $ilTabs->addSubTab("badges", 
                        $lng->txt("obj_bdga"),
                        $ilCtrl->getLinkTarget($this, "listBadges"));
                                
                $ilTabs->addSubTab("users", 
                        $lng->txt("users"),
                        $ilCtrl->getLinkTarget($this, "listUsers"));
                
                $ilTabs->activateSubTab($a_active);
        }

Here is the caller graph for this function:

toggleBadges()

ilBadgeManagementGUI::toggleBadges (   $a_status )

protected

Definition at line 640 of file class.ilBadgeManagementGUI.php.

References $ilCtrl, $lng, getBadgesFromMultiAction(), and ilUtil\sendSuccess().

Referenced by activateBadges(), and deactivateBadges().

        {
                global $ilCtrl, $lng;
                
                $badge_ids = $this->getBadgesFromMultiAction();
                
                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, "listBadges");         
        }       

Here is the call graph for this function:

Here is the caller graph for this function:

updateBadge()

ilBadgeManagementGUI::updateBadge ( )

protected

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

References $ilCtrl, $lng, editBadge(), hasWrite(), initBadgeForm(), ilUtil\sendFailure(), and ilUtil\sendSuccess().

        {
                global $ilCtrl, $lng;
                
                $badge_id = $_REQUEST["bid"];
                if(!$badge_id || 
                        !$this->hasWrite())
                {
                        $ilCtrl->redirect($this, "listBadges");
                }
                
                $ilCtrl->setParameter($this, "bid", $badge_id);
                
                include_once "./Services/Badge/classes/class.ilBadge.php";
                $badge = new ilBadge($badge_id);
                $type = $badge->getTypeInstance();
                $custom = $type->getConfigGUIInstance();
                if($custom &&
                        !($custom instanceof ilBadgeTypeGUI))
                {
                        $custom = null;
                }
                $form = $this->initBadgeForm("update", $type, $badge->getTypeId());             
                if($form->checkInput() &&
                        (!$custom || $custom->validateForm($form)))
                {                       
                        $badge->setActive($form->getInput("act"));
                        $badge->setTitle($form->getInput("title"));
                        $badge->setDescription($form->getInput("desc"));
                        $badge->setCriteria($form->getInput("crit"));
                        $badge->setValid($form->getInput("valid"));
                                                                
                        if($custom)
                        {
                                $badge->setConfiguration($custom->getConfigFromForm($form));
                        }
                                                
                        $badge->update();
                        
                        $badge->uploadImage($_FILES["img"]);
                        
                        ilUtil::sendSuccess($lng->txt("settings_saved"), true);
                        $ilCtrl->redirect($this, "listBadges");
                }
                
                ilUtil::sendFailure($lng->txt("form_input_not_valid"));
                $form->setValuesByPost();
                $this->editBadge($form);
        }

Here is the call graph for this function:

Field Documentation

$parent_obj_id

ilBadgeManagementGUI::$parent_obj_id

protected

Definition at line 17 of file class.ilBadgeManagementGUI.php.

$parent_obj_type

ilBadgeManagementGUI::$parent_obj_type

protected

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

$parent_ref_id

ilBadgeManagementGUI::$parent_ref_id

protected

Definition at line 16 of file class.ilBadgeManagementGUI.php.

CLIPBOARD_ID

const ilBadgeManagementGUI::CLIPBOARD_ID = "bdgclpbrd"

Definition at line 20 of file class.ilBadgeManagementGUI.php.

---

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

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