ilBadgeRenderer Class Reference

Collaboration diagram for ilBadgeRenderer:

Public Member Functions
	__construct (ilBadgeAssignment $a_assignment=null, ilBadge $a_badge=null)
	getHTML ()
	getHref ()
	renderModal ()

Static Public Member Functions
static	initFromId ($a_id)

Protected Member Functions
	getBadgeHash ()

Protected Attributes
	$tpl
	$ctrl
	$lng
	$assignment
	$badge

Static Protected Attributes
static	$init

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilBadgeRenderer::__construct	(	ilBadgeAssignment	$a_assignment = null,
		ilBadge	$a_badge = null
	)

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

References $DIC.

    {
        global $DIC;

        $this->tpl = $DIC["tpl"];
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        if ($a_assignment) {
            $this->assignment = $a_assignment;
            $this->badge = new ilBadge($this->assignment->getBadgeId());
        } else {
            $this->badge = $a_badge;
        }
    }

Member Function Documentation

getBadgeHash()

ilBadgeRenderer::getBadgeHash ( )

protected

Definition at line 140 of file class.ilBadgeRenderer.php.

Referenced by getHref(), getHTML(), and renderModal().

    {
        return md5("bdg-" .
            ($this->assignment
                ? $this->assignment->getUserId()
                : "") . "-" .
            $this->badge->getId());
    }

Here is the caller graph for this function:

getHref()

ilBadgeRenderer::getHref

(

)

Definition at line 110 of file class.ilBadgeRenderer.php.

References $ctrl, $ilCtrl, $tpl, $url, and getBadgeHash().

    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        
        if (!self::$init) {
            self::$init = true;
            
            $url = $ilCtrl->getLinkTargetByClass(
                "ilBadgeHandlerGUI",
                "render",
                "",
                true,
                false
            );
            
            $tpl->addJavaScript("Services/Badge/js/ilBadgeRenderer.js");
            $tpl->addOnLoadCode('il.BadgeRenderer.init("' . $url . '");');
        }
                
        $hash = $this->getBadgeHash();
        
        return "#\" data-id=\"badge_" .
            ($this->assignment
                ? $this->assignment->getUserId()
                : "") . "_" .
            $this->badge->getId() . "_" .
            $hash;
    }

Here is the call graph for this function:

getHTML()

ilBadgeRenderer::getHTML

(

)

Definition at line 76 of file class.ilBadgeRenderer.php.

References $ctrl, $ilCtrl, $tpl, $url, and getBadgeHash().

    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
        
        if (!self::$init) {
            self::$init = true;
            
            $url = $ilCtrl->getLinkTargetByClass(
                "ilBadgeHandlerGUI",
                "render",
                "",
                true,
                false
            );
            
            $tpl->addJavaScript("Services/Badge/js/ilBadgeRenderer.js");
            $tpl->addOnLoadCode('il.BadgeRenderer.init("' . $url . '");');
        }
                
        $hash = $this->getBadgeHash();

        $btpl = new ilTemplate("tpl.badge_renderer.html", true, true, "Services/Badge");
        $btpl->setVariable("BADGE_IMG", $this->badge->getImagePath());
        $btpl->setVariable("BADGE_TXT", $this->badge->getTitle());
        $btpl->setVariable("BADGE_ID", "badge_" .
            ($this->assignment
                ? $this->assignment->getUserId()
                : "") . "_" .
            $this->badge->getId() . "_" .
            $hash);
        return $btpl->get();
    }

Here is the call graph for this function:

initFromId()

static ilBadgeRenderer::initFromId (   $a_id )

static

Definition at line 51 of file class.ilBadgeRenderer.php.

References $_GET, $assignment, $badge, and $id.

Referenced by ilBadgeHandlerGUI\render().

    {
        $id = explode("_", $_GET["id"]);
        if (sizeof($id) == 3) {
            $user_id = $id[0];
            $badge_id = $id[1];
            $hash = $id[2];
            
            if ($user_id) {
                include_once "Services/Badge/classes/class.ilBadgeAssignment.php";
                $assignment = new ilBadgeAssignment($badge_id, $user_id);
                if ($assignment->getTimestamp()) {
                    $obj = new self($assignment);
                }
            } else {
                include_once "Services/Badge/classes/class.ilBadge.php";
                $badge = new ilBadge($badge_id);
                $obj = new self(null, $badge);
            }
            if ($hash == $obj->getBadgeHash()) {
                return $obj;
            }
        }
    }

Here is the caller graph for this function:

renderModal()

ilBadgeRenderer::renderModal

(

)

Definition at line 149 of file class.ilBadgeRenderer.php.

References $lng, $tpl, ilObject\_getIcon(), ilDatePresentation\formatDate(), getBadgeHash(), ilModalGUI\getInstance(), IL_CAL_UNIX, and ilModalGUI\TYPE_SMALL.

    {
        $lng = $this->lng;
        
        include_once "Services/UIComponent/Modal/classes/class.ilModalGUI.php";
        
        // only needed for modal-js-calls
        // ilModalGUI::initJS();
        
        $modal = ilModalGUI::getInstance();
        $modal->setId("badge_modal_" . $this->getBadgeHash());
        $modal->setType(ilModalGUI::TYPE_SMALL);
        $modal->setHeading($this->badge->getTitle());
        
        $lng->loadLanguageModule("badge");
        
        $tpl = new ilTemplate("tpl.badge_modal.html", true, true, "Services/Badge");
        
        $tpl->setVariable("IMG_SRC", $this->badge->getImagePath());
        $tpl->setVariable("IMG_TXT", $this->badge->getImage());
        
        $tpl->setVariable("TXT_DESC", $lng->txt("description"));
        $tpl->setVariable("DESC", nl2br($this->badge->getDescription()));
        
        $tpl->setVariable("TXT_CRITERIA", $lng->txt("badge_criteria"));
        $tpl->setVariable("CRITERIA", nl2br($this->badge->getCriteria()));
        
        if ($this->assignment) {
            $tpl->setVariable("TXT_TSTAMP", $lng->txt("badge_issued_on"));
            $tpl->setVariable(
                "TSTAMP",
                ilDatePresentation::formatDate(new ilDateTime($this->assignment->getTimestamp(), IL_CAL_UNIX))
            );
        }

        if ($this->badge->getParentId()) {
            $parent = $this->badge->getParentMeta();
            if ($parent["type"] != "bdga") {
                $tpl->setVariable("TXT_PARENT", $lng->txt("object"));
                $tpl->setVariable("PARENT", $parent["title"]);
                $tpl->setVariable("PARENT_TYPE", $lng->txt("obj_" . $parent["type"]));
                $tpl->setVariable(
                    "PARENT_ICON",
                    ilObject::_getIcon($parent["id"], "big", $parent["type"])
                );
            }
        }
        
        if ($this->badge->getValid()) {
            $tpl->setVariable("TXT_VALID", $lng->txt("badge_valid"));
            $tpl->setVariable("VALID", $this->badge->getValid());
        }
        
        $modal->setBody($tpl->get());
        
        return $modal->getHTML();
    }

Here is the call graph for this function:

Field Documentation

$assignment

ilBadgeRenderer::$assignment

protected

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

Referenced by initFromId().

$badge

ilBadgeRenderer::$badge

protected

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

Referenced by initFromId().

$ctrl

ilBadgeRenderer::$ctrl

protected

Definition at line 24 of file class.ilBadgeRenderer.php.

Referenced by getHref(), and getHTML().

$init

ilBadgeRenderer::$init

staticprotected

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

$lng

ilBadgeRenderer::$lng

protected

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

Referenced by renderModal().

$tpl

ilBadgeRenderer::$tpl

protected

Definition at line 19 of file class.ilBadgeRenderer.php.

Referenced by getHref(), getHTML(), and renderModal().

---

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

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