Collaboration diagram for ILIAS\Badge\Tile:

Public Member Functions
	__construct (private readonly Container $container, ?BadgeParent $parent=null, ?Modal $modal=null, $sign_file=[ilWACSignedPath::class, 'signFile'], ?Closure $format_date=null,)

	inDeck (ilBadge $badge, ilBadgeAssignment $assignment, string $gui)

	asTitleWithLeadingImage (ModalContent $content)

	asImage (ModalContent $content, int $size=ilBadgeImage::IMAGE_SIZE_M)

	asTitle (ModalContent $content)

	modalContent (ilBadge $badge)

	modalContentWithAssignment (ilBadge $badge, ilBadgeAssignment $assignment)

	addAssignment (ModalContent $content, ilBadgeAssignment $assignment)

Private Member Functions
	card (ModalContent $content)

	modal (Card $card)

	image (Component $modal, ilBadge $badge, int $size=ilBadgeImage::IMAGE_SIZE_M)

	title (Component $modal, ilBadge $badge)

	txt (string $key)

	tryFormating (string $valid)

	profileButton (ilBadge $badge, ilBadgeAssignment $assignment, string $gui)

Private Attributes
readonly Closure	$sign_file

readonly BadgeParent	$parent

readonly Modal	$modal

readonly Closure	$format_date

readonly ilBadgeImage	$badge_image_service

Detailed Description

Definition at line 34 of file Tile.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Badge\Tile::__construct	(	private readonly Container	$container,
		?BadgeParent	$parent = `null`,
		?Modal	$modal = `null`,
			$sign_file = `[ilWACSignedPath::class`,
		'signFile']	,
		?Closure	$format_date = `null`
	)

Parameters

Closure(string)	string $sign_file
Closure(int)	string $format_date

Definition at line 48 of file Tile.php.

References ILIAS\Badge\Tile\$format_date, ilDatePresentation\formatDate(), IL_CAL_UNIX, and ILIAS\Badge\Tile\modal().

       {
         $this->parent = $parent ?? new BadgeParent($this->container);
         $this->modal = $modal ?? new Modal($this->container);
         $this->sign_file = Closure::fromCallable($sign_file);
         if (!$format_date) {
             class_exists(ilDateTime::class); // Ensure ilDateTime is loaded as IL_CAL_UNIX is defined in ilDateTime.php.
             $format_date = static fn($date, int $format = IL_CAL_UNIX): string => (
                 ilDatePresentation::formatDate(new ilDateTime($date, $format))
             );
         }
         $this->format_date = $format_date;
         $this->badge_image_service = new ilBadgeImage($container->resourceStorage(), $container->upload(), $container->ui()->mainTemplate());
     }

Here is the call graph for this function:

Member Function Documentation

◆ addAssignment()

ILIAS\Badge\Tile::addAssignment	(	ModalContent	$content,
		ilBadgeAssignment	$assignment
	)

Definition at line 180 of file Tile.php.

References ilBadgeAssignment\getTimestamp(), ILIAS\Badge\Tile\txt(), and ILIAS\Badge\ModalContent\withAdditionalProperties().

Referenced by ILIAS\Badge\Tile\modalContentWithAssignment().

                                                                                        : ModalContent
     {
         return $content->withAdditionalProperties([
             $this->txt('badge_issued_on') => ($this->format_date)($assignment->getTimestamp()),
         ]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ asImage()

ILIAS\Badge\Tile::asImage	(	ModalContent	$content,
		int	$size = `ilBadgeImage::IMAGE_SIZE_M`
	)

Returns: list<Component>

Definition at line 107 of file Tile.php.

References ILIAS\Badge\Tile\$modal, ILIAS\Badge\ModalContent\badge(), ILIAS\Badge\Tile\card(), ILIAS\Badge\Tile\image(), and ILIAS\Badge\Tile\modal().

                                                                                         : array
     {
         $modal = $this->modal($this->card($content));
         return [
             $modal,
             $this->image($modal, $content->badge(), $size),
         ];
     }

Here is the call graph for this function:

◆ asTitle()

ILIAS\Badge\Tile::asTitle ( ModalContent $content )

Returns: list<Component>

Definition at line 119 of file Tile.php.

References ILIAS\Badge\Tile\$modal, ILIAS\Badge\ModalContent\badge(), ILIAS\Badge\Tile\card(), ILIAS\Badge\Tile\modal(), and ILIAS\Badge\Tile\title().

                                                   : array
     {
         $modal = $this->modal($this->card($content));
         return [
             $modal,
             $this->title($modal, $content->badge()),
         ];
     }

Here is the call graph for this function:

◆ asTitleWithLeadingImage()

ILIAS\Badge\Tile::asTitleWithLeadingImage ( ModalContent $content )

Returns: list<Component>

Definition at line 94 of file Tile.php.

References ILIAS\Badge\Tile\$modal, ILIAS\Badge\ModalContent\badge(), ILIAS\Badge\Tile\card(), ILIAS\Badge\Tile\image(), ILIAS\Badge\Tile\modal(), and ILIAS\Badge\Tile\title().

                                                                   : array
     {
         $modal = $this->modal($this->card($content));
         return [
             $modal,
             $this->image($modal, $content->badge()),
             $this->title($modal, $content->badge()),
         ];
     }

Here is the call graph for this function:

◆ card()

ILIAS\Badge\Tile::card ( ModalContent $content )

private

Definition at line 128 of file Tile.php.

References ILIAS\Badge\ModalContent\badge(), and ILIAS\Badge\Tile\modal().

Referenced by ILIAS\Badge\Tile\asImage(), ILIAS\Badge\Tile\asTitle(), ILIAS\Badge\Tile\asTitleWithLeadingImage(), and ILIAS\Badge\Tile\inDeck().

                                                 : Component
     {
         return $this->container
             ->ui()
             ->factory()
             ->card()
             ->standard($content->badge()->getTitle())
             ->withHiddenSections($this->modal->components($content));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ image()

ILIAS\Badge\Tile::image	(	Component	$modal,
		ilBadge	$badge,
		int	$size = `ilBadgeImage::IMAGE_SIZE_M`
	)

private

Definition at line 145 of file Tile.php.

References ilBadge\getTitle(), and ILIAS\GlobalScreen\Scope\Footer\Factory\withAction().

Referenced by ILIAS\Badge\Tile\asImage(), ILIAS\Badge\Tile\asTitleWithLeadingImage(), and ILIAS\Badge\Tile\inDeck().

                                                                                                   : Component
     {
         $image_src = $this->badge_image_service->getImageFromBadge($badge, $size);
         return $this->container
             ->ui()
             ->factory()
             ->image()
             ->responsive($image_src, $badge->getTitle())
             ->withAction($modal->getShowSignal());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ inDeck()

ILIAS\Badge\Tile::inDeck	(	ilBadge	$badge,
		ilBadgeAssignment	$assignment,
		string	$gui
	)

Returns: array{modal: Component, card: Component}

Definition at line 71 of file Tile.php.

References ILIAS\Badge\Tile\$modal, ILIAS\Badge\Tile\$parent, ILIAS\Badge\Tile\card(), ILIAS\Badge\Tile\image(), ILIAS\Badge\Tile\modal(), ILIAS\Badge\Tile\modalContentWithAssignment(), and ILIAS\Badge\Tile\profileButton().

                                                                                       : array
     {
         $parent = $this->parent->asComponent($badge);
         $badge_sections = $parent ? [$parent] : [];
         $badge_sections[] = $this->profileButton($badge, $assignment, $gui);
 
         $content = $this->modalContentWithAssignment($badge, $assignment);
         $card = $this->card($content);
         $modal = $this->modal($card);
         $image = $this->image($modal, $badge);
         $card = $card->withSections($badge_sections)
                      ->withImage($image)
                      ->withTitleAction($modal->getShowSignal());
 
         return [
             'card' => $card,
             'modal' => $modal,
         ];
     }

Here is the call graph for this function:

◆ modal()

ILIAS\Badge\Tile::modal ( Card $card )

private

Definition at line 138 of file Tile.php.

Referenced by ILIAS\Badge\Tile\__construct(), ILIAS\Badge\Tile\asImage(), ILIAS\Badge\Tile\asTitle(), ILIAS\Badge\Tile\asTitleWithLeadingImage(), ILIAS\Badge\Tile\card(), and ILIAS\Badge\Tile\inDeck().

                                       : Component
     {
         return $this->container->ui()->factory()->modal()->lightbox(
             $this->container->ui()->factory()->modal()->lightboxCardPage($card)
         );
     }

Here is the caller graph for this function:

◆ modalContent()

ILIAS\Badge\Tile::modalContent ( ilBadge $badge )

Definition at line 165 of file Tile.php.

References ilBadge\getCriteria(), ilBadge\getValid(), null, ILIAS\Badge\Tile\tryFormating(), and ILIAS\Badge\Tile\txt().

Referenced by ILIAS\Badge\Tile\modalContentWithAssignment().

                                                 : ModalContent
     {
         $awarded_by = $this->parent->asProperty($badge);
         return new ModalContent($badge, [
             $this->txt('criteria') => $badge->getCriteria(),
             ...($awarded_by !== null ? [$this->txt('awarded_by') => $awarded_by] : []),
             $this->txt('valid_until') => $this->tryFormating($badge->getValid()),
         ]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ modalContentWithAssignment()

ILIAS\Badge\Tile::modalContentWithAssignment	(	ilBadge	$badge,
		ilBadgeAssignment	$assignment
	)

Definition at line 175 of file Tile.php.

References ILIAS\Badge\Tile\addAssignment(), and ILIAS\Badge\Tile\modalContent().

Referenced by ILIAS\Badge\Tile\inDeck().

                                                                                              : ModalContent
     {
         return $this->addAssignment($this->modalContent($badge), $assignment);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ profileButton()

ILIAS\Badge\Tile::profileButton	(	ilBadge	$badge,
		ilBadgeAssignment	$assignment,
		string	$gui
	)

private

Definition at line 205 of file Tile.php.

References $url, ilBadge\getId(), ilBadgeAssignment\getPosition(), and ILIAS\Badge\Tile\txt().

Referenced by ILIAS\Badge\Tile\inDeck().

                                                                                               : Component
     {
         $active = $assignment->getPosition();
 
         $this->container->ctrl()->setParameterByClass($gui, 'badge_id', $badge->getId());
 
         $url = $this->container->ctrl()->getLinkTargetByClass(
             $gui,
             $active ? 'deactivateInCard' : 'activateInCard'
         );
 
         $this->container->ctrl()->setParameterByClass($gui, 'badge_id', '');
 
         return $this->container->ui()->factory()->button()->standard(
             $this->txt($active ? 'badge_remove_from_profile' : 'badge_add_to_profile'),
             $url
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ title()

ILIAS\Badge\Tile::title	(	Component	$modal,
		ilBadge	$badge
	)

private

Definition at line 156 of file Tile.php.

References ilBadge\getTitle().

Referenced by ILIAS\Badge\Tile\asTitle(), and ILIAS\Badge\Tile\asTitleWithLeadingImage().

                                                             : Component
     {
         return $this->container
             ->ui()
             ->factory()
             ->button()
             ->shy($badge->getTitle(), $modal->getShowSignal());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tryFormating()

ILIAS\Badge\Tile::tryFormating ( string $valid )

private

Definition at line 192 of file Tile.php.

References $valid, IL_CAL_DATE, and ILIAS\Badge\Tile\txt().

Referenced by ILIAS\Badge\Tile\modalContent().

                                                 : string
     {
         if (!$valid) {
             return $this->txt('endless');
         }
 
         try {
             return ($this->format_date)($valid, IL_CAL_DATE);
         } catch (ilDateTimeException) {
             return $valid;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ txt()

ILIAS\Badge\Tile::txt ( string $key )

private

Definition at line 187 of file Tile.php.

Referenced by ILIAS\Badge\Tile\addAssignment(), ILIAS\Badge\Tile\modalContent(), ILIAS\Badge\Tile\profileButton(), and ILIAS\Badge\Tile\tryFormating().

                                      : string
     {
         return $this->container->language()->txt($key);
     }

Here is the caller graph for this function:

Field Documentation

◆ $badge_image_service

readonly ilBadgeImage ILIAS\Badge\Tile::$badge_image_service

private

Definition at line 42 of file Tile.php.

◆ $format_date

readonly Closure ILIAS\Badge\Tile::$format_date

private

Definition at line 41 of file Tile.php.

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

◆ $modal

readonly Modal ILIAS\Badge\Tile::$modal

private

Definition at line 39 of file Tile.php.

Referenced by ILIAS\Badge\Tile\asImage(), ILIAS\Badge\Tile\asTitle(), ILIAS\Badge\Tile\asTitleWithLeadingImage(), and ILIAS\Badge\Tile\inDeck().

◆ $parent

readonly BadgeParent ILIAS\Badge\Tile::$parent

private

Definition at line 38 of file Tile.php.

Referenced by ILIAS\Badge\Tile\inDeck().

◆ $sign_file

readonly Closure ILIAS\Badge\Tile::$sign_file

private

Definition at line 37 of file Tile.php.

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

components/ILIAS/Badge/classes/Tile.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAssignment()

◆ asImage()

◆ asTitle()

◆ asTitleWithLeadingImage()

◆ card()

◆ image()

◆ inDeck()

◆ modal()

◆ modalContent()

◆ modalContentWithAssignment()

◆ profileButton()

◆ title()

◆ tryFormating()

◆ txt()

Field Documentation

◆ $badge_image_service

◆ $format_date

◆ $modal

◆ $parent

◆ $sign_file