ilBadgeProfileGUI Class Reference

Collaboration diagram for ilBadgeProfileGUI:

Public Member Functions
	executeCommand ()

Data Fields
const	BACKPACK_EMAIL = "badge_mozilla_bp"

Protected Member Functions
	setTabs ()
	getSubTabs ($a_active)
	listBadges ()
	manageBadges ()
	applyFilter ()
	resetFilter ()
	getMultiSelection ()
	activate ()
	deactivate ()
	addToBackpackMulti ()
	setBackpackSubTabs ()
	listBackpackGroups ()
	prepareBadge ($a_badge_id)
	addToBackpack ()
	getBackpackMail ()
	initSettingsForm ()
	editSettings (ilPropertyFormGUI $a_form=null)
	saveSettings ()

Detailed Description

Definition at line 13 of file class.ilBadgeProfileGUI.php.

Member Function Documentation

activate()

ilBadgeProfileGUI::activate ( )

protected

Definition at line 194 of file class.ilBadgeProfileGUI.php.

        {               
                global $lng, $ilCtrl;
                
                foreach($this->getMultiSelection() as $ass)
                {
                        // already active?
                        if(!$ass->getPosition())
                        {
                                $ass->setPosition(999);
                                $ass->store();
                        }                                                                       
                }
                
                ilUtil::sendSuccess($lng->txt("settings_saved"), true);
                $ilCtrl->redirect($this, "manageBadges");
        }

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

Here is the call graph for this function:

addToBackpack()

ilBadgeProfileGUI::addToBackpack ( )

protected

Definition at line 367 of file class.ilBadgeProfileGUI.php.

        {
                global $ilCtrl;
                
                if(!$ilCtrl->isAsynch() ||
                        !ilBadgeHandler::getInstance()->isObiActive())
                {
                        return false;
                }
                
                $res = new stdClass();
                
                $url = false;
                $badge_id = (int)$_GET["id"];
                if($badge_id)
                {
                        $url = $this->prepareBadge($badge_id);                          
                }
                
                if($url !== false)
                {
                        $res->error = false;
                        $res->url = $url;
                }
                else
                {
                        $res->error = true;
                        $res->message = "missing badge id";
                }
                
                echo json_encode($res);
                exit();                         
        }

References $_GET, $ilCtrl, $res, $url, exit, ilBadgeHandler\getInstance(), and prepareBadge().

Here is the call graph for this function:

addToBackpackMulti()

ilBadgeProfileGUI::addToBackpackMulti ( )

protected

Definition at line 235 of file class.ilBadgeProfileGUI.php.

        {               
                global $tpl, $ilTabs, $ilCtrl, $lng;
                
                $res = array();
                foreach($this->getMultiSelection() as $ass)
                {
                        $url = $this->prepareBadge($ass->getBadgeId());
                        if($url !== false)
                        {
                                $badge = new ilBadge($ass->getBadgeId());
                                $titles[] = $badge->getTitle();
                                $res[] = $url;
                        }
                }
                
                // :TODO: use local copy instead?
                $tpl->addJavascript("https://backpack.openbadges.org/issuer.js", false);        
                        
                $tpl->addJavascript("Services/Badge/js/ilBadge.js");    
                $tpl->addOnloadCode("il.Badge.publishMulti(['".implode("','", $res)."']);");            
                
                $ilTabs->clearTargets();
                $ilTabs->setBackTarget($lng->txt("back"),
                        $ilCtrl->getLinkTarget($this, "manageBadges"));
                
                ilUtil::sendInfo(sprintf($lng->txt("badge_add_to_backpack_multi"), implode(", ", $titles)));
        }

References $ilCtrl, $lng, $res, $tpl, $url, getMultiSelection(), prepareBadge(), ilUtil\sendInfo(), and sprintf.

Here is the call graph for this function:

applyFilter()

ilBadgeProfileGUI::applyFilter ( )

protected

Definition at line 144 of file class.ilBadgeProfileGUI.php.

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

References $tbl, and manageBadges().

Here is the call graph for this function:

deactivate()

ilBadgeProfileGUI::deactivate ( )

protected

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

        {               
                global $lng, $ilCtrl;
                
                foreach($this->getMultiSelection() as $ass)
                {
                        // already inactive?
                        if($ass->getPosition())
                        {
                                $ass->setPosition(null);
                                $ass->store();
                        }                                                                       
                }
                
                ilUtil::sendSuccess($lng->txt("settings_saved"), true);
                $ilCtrl->redirect($this, "manageBadges");               
        }

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

Here is the call graph for this function:

editSettings()

ilBadgeProfileGUI::editSettings ( ilPropertyFormGUI  $a_form = null )

protected

Definition at line 438 of file class.ilBadgeProfileGUI.php.

        {
                global $tpl, $ilCtrl, $ilTabs;
                
                if(!ilBadgeHandler::getInstance()->isObiActive())
                {
                        $ilCtrl->redirect($this, "listBadges");
                }               
                
                $this->setBackpackSubTabs();
                $ilTabs->activateSubTab("backpack_settings");
        
                if(!$a_form)
                {
                        $a_form = $this->initSettingsForm();
                }
                
                $tpl->setContent($a_form->getHTML());
        }

References $ilCtrl, $tpl, ilBadgeHandler\getInstance(), initSettingsForm(), and setBackpackSubTabs().

Referenced by saveSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilBadgeProfileGUI::executeCommand

(

)

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

        {
                global $ilCtrl, $lng, $tpl;
                
                $lng->loadLanguageModule("badge");
                
                $tpl->setTitle($lng->txt("obj_bdga"));
                $tpl->setTitleIcon(ilUtil::getImagePath("icon_bdga.svg"));
                                                                
                switch($ilCtrl->getNextClass())
                {                       
                        default:                        
                                $this->setTabs();
                                $cmd = $ilCtrl->getCmd("listBadges");                                                   
                                $this->$cmd();
                                break;
                }
        }

References $cmd, $ilCtrl, $lng, $tpl, ilUtil\getImagePath(), and setTabs().

Here is the call graph for this function:

getBackpackMail()

ilBadgeProfileGUI::getBackpackMail ( )

protected

Definition at line 406 of file class.ilBadgeProfileGUI.php.

        {
                global $ilUser;
                
                $mail = $ilUser->getPref(self::BACKPACK_EMAIL);
                if(!$mail)
                {
                        $mail = $ilUser->getEmail();
                }
                return $mail;
        }

References $ilUser.

Referenced by initSettingsForm(), listBackpackGroups(), and saveSettings().

Here is the caller graph for this function:

getMultiSelection()

ilBadgeProfileGUI::getMultiSelection ( )

protected

Definition at line 162 of file class.ilBadgeProfileGUI.php.

        {
                global $lng, $ilCtrl, $ilUser;
                
                $ids = $_POST["badge_id"];
                if(!$ids && is_numeric($_GET["badge_id"]))
                {
                        $ids = array($_GET["badge_id"]);
                }               
                if(is_array($ids))
                {
                        $res = array();
                        include_once "Services/Badge/classes/class.ilBadge.php";
                        include_once "Services/Badge/classes/class.ilBadgeAssignment.php";
                        foreach($ids as $id)
                        {
                                $ass = new ilBadgeAssignment($id, $ilUser->getId());
                                if($ass->getTimestamp())
                                {
                                        $res[] = $ass;
                                }
                        }
                        
                        return $res;
                }
                else
                {
                        ilUtil::sendFailure($lng->txt("select_one"), true);
                        $ilCtrl->redirect($this, "manageBadges");
                }
        }

References $_GET, $_POST, $ilCtrl, $ilUser, $lng, $res, and ilUtil\sendFailure().

Referenced by activate(), addToBackpackMulti(), and deactivate().

Here is the call graph for this function:

Here is the caller graph for this function:

getSubTabs()

ilBadgeProfileGUI::getSubTabs (   $a_active )

protected

Definition at line 57 of file class.ilBadgeProfileGUI.php.

        {
                global $ilTabs, $lng, $ilCtrl;
 
                if(ilBadgeHandler::getInstance()->isObiActive())
                {
                        $ilTabs->addSubTab("list",
                                $lng->txt("badge_profile_view"),
                                $ilCtrl->getLinkTarget($this, "listBadges"));
                        $ilTabs->addSubTab("manage",
                                $lng->txt("badge_profile_manage"),
                                $ilCtrl->getLinkTarget($this, "manageBadges"));
                        $ilTabs->activateTab("ilias_badges");
                        $ilTabs->activateSubTab($a_active);
                }
                else
                {
                        $ilTabs->addTab("list",
                                $lng->txt("badge_profile_view"),
                                $ilCtrl->getLinkTarget($this, "listBadges"));
                        $ilTabs->addTab("manage",
                                $lng->txt("badge_profile_manage"),
                                $ilCtrl->getLinkTarget($this, "manageBadges"));
                        $ilTabs->activateTab($a_active);
                }
                
        }

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

Referenced by listBadges(), and manageBadges().

Here is the call graph for this function:

Here is the caller graph for this function:

initSettingsForm()

ilBadgeProfileGUI::initSettingsForm ( )

protected

Definition at line 418 of file class.ilBadgeProfileGUI.php.

        {
                global $lng, $ilCtrl;
                
                include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
                $form = new ilPropertyFormGUI();
                $form->setFormAction($ilCtrl->getFormAction($this, "saveSettings"));
                $form->setTitle($lng->txt("settings"));
                
                $email = new ilEMailInputGUI($lng->txt("badge_backpack_email"), "email");
                // $email->setRequired(true);
                $email->setInfo($lng->txt("badge_backpack_email_info"));
                $email->setValue($this->getBackpackMail());
                $form->addItem($email);
                
                $form->addCommandButton("saveSettings", $lng->txt("save"));
                
                return $form;
        }

References $ilCtrl, $lng, and getBackpackMail().

Referenced by editSettings(), and saveSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

listBackpackGroups()

ilBadgeProfileGUI::listBackpackGroups ( )

protected

Definition at line 279 of file class.ilBadgeProfileGUI.php.

        {
                global $lng, $tpl, $ilCtrl, $ilTabs;
                
                if(!ilBadgeHandler::getInstance()->isObiActive())
                {
                        $ilCtrl->redirect($this, "listBadges");
                }               
                                
                $this->setBackpackSubTabs();
                $ilTabs->activateSubTab("backpack_badges");
                
                ilUtil::sendInfo($lng->txt("badge_backpack_gallery_info"));
                                
                include_once "Services/Badge/classes/class.ilBadgeBackpack.php";
                $bp = new ilBadgeBackpack($this->getBackpackMail());
                $bp_groups = $bp->getGroups();
 
                if(!is_array($bp_groups))
                {
                        ilUtil::sendInfo(sprintf($lng->txt("badge_backpack_connect_failed"), $this->getBackpackMail()));
                        return;         
                }               
                else if(!sizeof($bp_groups))
                {
                        ilUtil::sendInfo($lng->txt("badge_backpack_no_groups"));
                        return;
                }
                
                $tmpl = new ilTemplate("tpl.badge_backpack.html", true, true, "Services/Badge");
 
                $tmpl->setVariable("BACKPACK_TITLE", $lng->txt("badge_backpack_list"));
                
                ilDatePresentation::setUseRelativeDates(false);
 
                foreach($bp_groups as $group_id => $group)
                {                       
                        $bp_badges = $bp->getBadges($group_id);
                        if(sizeof($bp_badges))
                        {                                                                                       
                                foreach($bp_badges as $idx => $badge)
                                {
                                        $tmpl->setCurrentBlock("badge_bl");
                                        $tmpl->setVariable("BADGE_TITLE", $badge["title"]);
                                        $tmpl->setVariable("BADGE_DESC", $badge["description"]);
                                        $tmpl->setVariable("BADGE_IMAGE", $badge["image_url"]);
                                        $tmpl->setVariable("BADGE_CRITERIA", $badge["criteria_url"]);
                                        $tmpl->setVariable("BADGE_ISSUER", $badge["issuer_name"]);
                                        $tmpl->setVariable("BADGE_ISSUER_URL", $badge["issuer_url"]);
                                        $tmpl->setVariable("BADGE_DATE", ilDatePresentation::formatDate($badge["issued_on"]));
                                        $tmpl->parseCurrentBlock();                                                                                             
                                }
                        }
 
                        $tmpl->setCurrentBlock("group_bl");
                        $tmpl->setVariable("GROUP_TITLE", $group["title"]);
                        $tmpl->parseCurrentBlock();                     
                }
 
                $tpl->setContent($tmpl->get());         
        }

References $ilCtrl, $lng, $tpl, ilDatePresentation\formatDate(), getBackpackMail(), ilBadgeHandler\getInstance(), ilUtil\sendInfo(), setBackpackSubTabs(), ilDatePresentation\setUseRelativeDates(), and sprintf.

Here is the call graph for this function:

listBadges()

ilBadgeProfileGUI::listBadges ( )

protected

Definition at line 85 of file class.ilBadgeProfileGUI.php.

        {
                global $tpl, $ilUser;
                        
                $this->getSubTabs("list");
                
                $data = array();
                
                // see ilBadgePersonalTableGUI::getItems()
                include_once "Services/Badge/classes/class.ilBadge.php";
                include_once "Services/Badge/classes/class.ilBadgeAssignment.php";
                include_once "Services/Badge/classes/class.ilBadgeRenderer.php";
                foreach(ilBadgeAssignment::getInstancesByUserId($ilUser->getId()) as $ass)
                {
                        $badge = new ilBadge($ass->getBadgeId());
                        
                        $data[] = array(
                                "id" => $badge->getId(),
                                "title" => $badge->getTitle(),
                                "description" => $badge->getDescription(),
                                "image" => $badge->getImagePath(),
                                "issued_on" => $ass->getTimestamp(),
                                "renderer" => new ilBadgeRenderer($ass)
                        );                      
                }       
                
                // :TODO:
                $data = ilUtil::sortArray($data, "issued_on", "desc", true);
                
                $tmpl = new ilTemplate("tpl.badge_backpack.html", true, true, "Services/Badge");
 
                ilDatePresentation::setUseRelativeDates(false);
 
                foreach($data as $badge)
                {                                                                                                                                       
                        $tmpl->setCurrentBlock("badge_bl");
                        $tmpl->setVariable("BADGE_TITLE", $badge["title"]);
                        // $tmpl->setVariable("BADGE_DESC", $badge["description"]); :TODO:
                        $tmpl->setVariable("BADGE_IMAGE", $badge["image"]);
                        $tmpl->setVariable("BADGE_CRITERIA", $badge["renderer"]->getHref());
                        $tmpl->setVariable("BADGE_DATE", ilDatePresentation::formatDate(new ilDateTime($badge["issued_on"], IL_CAL_UNIX)));
                        $tmpl->parseCurrentBlock();                                                                                                                     
                }
 
                $tpl->setContent($tmpl->get());         
        }

References $data, $ilUser, $tpl, ilDatePresentation\formatDate(), ilBadgeAssignment\getInstancesByUserId(), getSubTabs(), IL_CAL_UNIX, ilDatePresentation\setUseRelativeDates(), and ilUtil\sortArray().

Here is the call graph for this function:

manageBadges()

ilBadgeProfileGUI::manageBadges ( )

protected

Definition at line 132 of file class.ilBadgeProfileGUI.php.

        {
                global $tpl;
                        
                $this->getSubTabs("manage");
                
                include_once "Services/Badge/classes/class.ilBadgePersonalTableGUI.php";
                $tbl = new ilBadgePersonalTableGUI($this, "manageBadges");
                
                $tpl->setContent($tbl->getHTML());              
        }

References $tbl, $tpl, and getSubTabs().

Referenced by applyFilter(), and resetFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

prepareBadge()

ilBadgeProfileGUI::prepareBadge (   $a_badge_id )

protected

Definition at line 341 of file class.ilBadgeProfileGUI.php.

        {
                global $ilUser;
                
                // check if current user has given badge
                include_once "Services/Badge/classes/class.ilBadgeAssignment.php";
                $ass = new ilBadgeAssignment($a_badge_id, $ilUser->getId());
                if($ass->getTimestamp())
                {                       
                        $url = null;
                        try 
                        {                                       
                                $url = $ass->getStaticUrl();
                        } 
                        catch (Exception $ex) {
                                
                        }                               
                        if($url)
                        {                               
                                return $url;
                        }                               
                }
                
                return false;           
        }

References $ilUser, and $url.

Referenced by addToBackpack(), and addToBackpackMulti().

Here is the caller graph for this function:

resetFilter()

ilBadgeProfileGUI::resetFilter ( )

protected

Definition at line 153 of file class.ilBadgeProfileGUI.php.

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

References $tbl, and manageBadges().

Here is the call graph for this function:

saveSettings()

ilBadgeProfileGUI::saveSettings ( )

protected

Definition at line 458 of file class.ilBadgeProfileGUI.php.

        {
                global $ilUser, $lng, $ilCtrl;
                
                $form = $this->initSettingsForm();
                if($form->checkInput())
                {
                        $new_email = $form->getInput("email");
                        $old_email = $this->getBackpackMail();
                        
                        ilObjUser::_writePref($ilUser->getId(), self::BACKPACK_EMAIL, $new_email);
                        
                        // if email was changed: delete badge files
                        if($new_email != $old_email)
                        {
                                include_once "Services/Badge/classes/class.ilBadgeAssignment.php";
                                ilBadgeAssignment::clearBadgeCache($ilUser->getId());
                        }
                                        
                        ilUtil::sendSuccess($lng->txt("settings_saved"), true);
                        $ilCtrl->redirect($this, "editSettings");
                }
                
                $form->setValuesByPost();
                $this->editSettings($form);
        }

References $ilCtrl, $ilUser, $lng, ilObjUser\_writePref(), ilBadgeAssignment\clearBadgeCache(), editSettings(), getBackpackMail(), initSettingsForm(), and ilUtil\sendSuccess().

Here is the call graph for this function:

setBackpackSubTabs()

ilBadgeProfileGUI::setBackpackSubTabs ( )

protected

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

        {
                global $ilTabs, $lng, $ilCtrl;
                
                $ilTabs->addSubTab("backpack_badges",
                        $lng->txt("obj_bdga"),
                        $ilCtrl->getLinkTarget($this, "listBackpackGroups"));
                
                $ilTabs->addSubTab("backpack_settings",
                        $lng->txt("settings"),
                        $ilCtrl->getLinkTarget($this, "editSettings"));
                
                $ilTabs->activateTab("backpack_badges");
        }

References $ilCtrl, and $lng.

Referenced by editSettings(), and listBackpackGroups().

Here is the caller graph for this function:

setTabs()

ilBadgeProfileGUI::setTabs ( )

protected

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

        {
                global $ilTabs, $lng, $ilCtrl;
 
                if(ilBadgeHandler::getInstance()->isObiActive())
                {
                        $ilTabs->addTab("ilias_badges",
                                $lng->txt("badge_personal_badges"),
                                $ilCtrl->getLinkTarget($this, "listBadges"));
 
                        $ilTabs->addTab("backpack_badges",
                                $lng->txt("badge_backpack_list"),
                                $ilCtrl->getLinkTarget($this, "listBackpackGroups"));                   
                }
        }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

BACKPACK_EMAIL

const ilBadgeProfileGUI::BACKPACK_EMAIL = "badge_mozilla_bp"

Definition at line 15 of file class.ilBadgeProfileGUI.php.

Referenced by ilBadgeAssignment\prepareJson().

---

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

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