ilBadgeRenderer Class Reference

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

Collaboration diagram for ilBadgeRenderer:

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

Protected Attributes
ilLanguage	$lng
ILIAS UI Factory	$factory
ILIAS UI Renderer	$renderer
ilBadgeAssignment	$assignment = null
ilBadge	$badge = null

Detailed Description

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

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

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

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, and ILIAS\Repository\lng().

      {
        global $DIC;

        $this->lng = $DIC->language();
        $this->factory = $DIC->ui()->factory();
        $this->renderer = $DIC->ui()->renderer();
        if ($a_assignment) {
            $this->assignment = $a_assignment;
            $this->badge = new ilBadge($this->assignment->getBadgeId());
        } else {
            $this->badge = $a_badge;
        }
    }

Here is the call graph for this function:

Member Function Documentation

getHTML()

ilBadgeRenderer::getHTML

(

)

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

References renderModalContent(), and ilWACSignedPath\signFile().

                             : string
    {
        $components = array();

        $modal = $this->factory->modal()->roundtrip(
            $this->badge->getTitle(),
            $this->factory->legacy($this->renderModalContent())
        )->withCancelButtonLabel("ok");
        $components[] = $modal;

        $image_path = ilWACSignedPath::signFile($this->badge->getImagePath());
        $image = $this->factory->image()->responsive($image_path, $this->badge->getTitle())
            ->withAction($modal->getShowSignal());
        $components[] = $image;

        return $this->renderer->render($components);
    }

Here is the call graph for this function:

renderModalContent()

ilBadgeRenderer::renderModalContent

(

)

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

References $lng, ilObject\_getAllReferences(), ilObject\_getIcon(), ilLink\_getLink(), ilDatePresentation\formatDate(), IL_CAL_UNIX, ilLanguage\loadLanguageModule(), ilWACSignedPath\signFile(), and ilLanguage\txt().

Referenced by getHTML().

                                        : string
    {
        $lng = $this->lng;
        $lng->loadLanguageModule("badge");

        $modal_content = array();

        $image = $this->factory->image()->responsive(ilWACSignedPath::signFile($this->badge->getImagePath()), $this->badge->getImage());
        $modal_content[] = $image;

        $badge_information = [
            $lng->txt("description") => $this->badge->getDescription(),
            $lng->txt("badge_criteria") => $this->badge->getCriteria(),
        ];

        if ($this->assignment) {
            $badge_information[$lng->txt("badge_issued_on")] = ilDatePresentation::formatDate(
                new ilDateTime($this->assignment->getTimestamp(), IL_CAL_UNIX)
            );
        }

        if ($this->badge->getParentId()) {
            $parent = $this->badge->getParentMeta();
            if ($parent["type"] !== "bdga") {
                $parent_icon = $this->factory->symbol()->icon()->custom(
                    ilObject::_getIcon((int) $parent["id"], "big", $parent["type"]),
                    $lng->txt("obj_" . $parent["type"])
                )->withSize("medium");

                $label = $parent['title'];
                $ref = current(ilObject::_getAllReferences($parent['id']));
                if ($ref) {
                    $label = $this->factory->link()->standard($label, ilLink::_getLink($ref, $parent['type']));
                    $label = $this->renderer->render($label);
                }
                $badge_information[$lng->txt('object')] = $this->renderer->render($parent_icon) . $label;
            }
        }

        if ($this->badge->getValid()) {
            $badge_information[$lng->txt("badge_valid")] = $this->badge->getValid();
        }

        $list = $this->factory->listing()->descriptive($badge_information);
        $modal_content[] = $list;

        return $this->renderer->render($modal_content);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$assignment

ilBadgeAssignment ilBadgeRenderer::$assignment = null

protected

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

$badge

ilBadge ilBadgeRenderer::$badge = null

protected

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

$factory

ILIAS UI Factory ilBadgeRenderer::$factory

protected

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

$lng

ilLanguage ilBadgeRenderer::$lng

protected

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

Referenced by renderModalContent().

$renderer

ILIAS UI Renderer ilBadgeRenderer::$renderer

protected

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

---

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

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