ILIAS\Badge\ModalBuilder Class Reference

Collaboration diagram for ILIAS\Badge\ModalBuilder:

Public Member Functions
	__construct (?ilBadgeAssignment $assignment=null)
	constructModal (?Image $badge_image, string $badge_title, array $badge_properties=[])
	renderModal (Modal $modal)
	renderShyButton (string $label, Modal $modal)

Private Member Functions
	translateKeysWithValidDataAttribute (array $properties)

Private Attributes
Factory	$ui_factory
Renderer	$ui_renderer
ilLanguage	$lng
ilBadgeAssignment	$assignment = null

Detailed Description

Definition at line 33 of file ModalBuilder.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Badge\ModalBuilder::__construct

(

?ilBadgeAssignment

$assignment = null

)

Definition at line 40 of file ModalBuilder.php.

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

    {
        global $DIC;

        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('badge');

        if ($assignment) {
            $this->assignment = $assignment;
        }
    }

Here is the call graph for this function:

Member Function Documentation

constructModal()

ILIAS\Badge\ModalBuilder::constructModal	(	?Image	$badge_image,
		string	$badge_title,
		array	$badge_properties = []
	)

Parameters

array<string,string>

$badge_properties

Definition at line 57 of file ModalBuilder.php.

References ilDatePresentation\formatDate(), IL_CAL_UNIX, null, and ILIAS\Badge\ModalBuilder\translateKeysWithValidDataAttribute().

Referenced by ILIAS\Badge\ilBadgeTableGUI\enrichRecord(), and ILIAS\Badge\ilObjectBadgeTableGUI\enrichRecord().

     : Modal {
        if ($badge_image !== null) {
            $modal_content[] = $badge_image;
        }

        if ($this->assignment) {
            $badge_properties['badge_issued_on'] = ilDatePresentation::formatDate(
                new ilDateTime($this->assignment->getTimestamp(), IL_CAL_UNIX)
            );
        }

        $badge_properties = $this->translateKeysWithValidDataAttribute($badge_properties);

        $modal_content[] = $this->ui_factory->item()
                ->standard($badge_title)
                ->withDescription('')
                ->withProperties($badge_properties);

        $card = $this->ui_factory->card()
            ->standard($badge_title)
            ->withHiddenSections($modal_content);

        return $this->ui_factory->modal()->lightbox(
            $this->ui_factory->modal()->lightboxCardPage($card)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderModal()

ILIAS\Badge\ModalBuilder::renderModal

(

Modal

$modal

)

Definition at line 88 of file ModalBuilder.php.

Referenced by ILIAS\Badge\ilBadgeTableGUI\enrichRecord(), and ILIAS\Badge\ilObjectBadgeTableGUI\enrichRecord().

                                             : string
    {
        return $this->ui_renderer->render($modal);
    }

Here is the caller graph for this function:

renderShyButton()

ILIAS\Badge\ModalBuilder::renderShyButton	(	string	$label,
		Modal	$modal
	)

Definition at line 93 of file ModalBuilder.php.

Referenced by ILIAS\Badge\ilBadgeTableGUI\enrichRecord(), and ILIAS\Badge\ilObjectBadgeTableGUI\enrichRecord().

                                                                : string
    {
        return $this->ui_renderer->render($this->ui_factory->button()->shy($label, $modal->getShowSignal()));
    }

Here is the caller graph for this function:

translateKeysWithValidDataAttribute()

ILIAS\Badge\ModalBuilder::translateKeysWithValidDataAttribute ( array  $properties )

private

Parameters

array<string,string>

$properties

Returns

array<string, string>

Definition at line 102 of file ModalBuilder.php.

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

Referenced by ILIAS\Badge\ModalBuilder\constructModal().

                                                                           : array
    {
        $translations = [];

        if (\count($properties) > 0) {
            foreach ($properties as $lang_var => $data) {
                if ($data !== '') {
                    $translations[$this->lng->txt($lang_var)] = $data;
                }
            }
        }
        return $translations;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$assignment

ilBadgeAssignment ILIAS\Badge\ModalBuilder::$assignment = null

private

Definition at line 38 of file ModalBuilder.php.

Referenced by ILIAS\Badge\ModalBuilder\__construct().

$lng

ilLanguage ILIAS\Badge\ModalBuilder::$lng

private

Definition at line 37 of file ModalBuilder.php.

$ui_factory

Factory ILIAS\Badge\ModalBuilder::$ui_factory

private

Definition at line 35 of file ModalBuilder.php.

$ui_renderer

Renderer ILIAS\Badge\ModalBuilder::$ui_renderer

private

Definition at line 36 of file ModalBuilder.php.

---

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

• components/ILIAS/Badge/classes/ModalBuilder.php