ILIAS\Badge\BadgeParent Class Reference

Collaboration diagram for ILIAS\Badge\BadgeParent:

Public Member Functions
	__construct (private readonly Container $container, $icon=[ilObject::class, '_getIcon'], $references_of=[ilObject::class, '_getAllReferences'], $link_to=[ilLink::class, '_getLink'])
	asComponent (ilBadge $badge)
	asProperty (ilBadge $badge)

Private Member Functions
	metaData (ilBadge $badge)

Private Attributes
readonly Closure	$icon
readonly Closure	$references_of
readonly Closure	$link_to

Detailed Description

Definition at line 30 of file BadgeParent.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Badge\BadgeParent::__construct	(	private readonly Container	$container,
			$icon = [ilObject::class,
		'_getIcon']	,
			$references_of = [ilObject::class,
		'_getAllReferences']	,
			$link_to = [ilLink::class,
		'_getLink']
	)

Parameters

Closure(int,string,string)	string $icon
Closure(int)	int[] $references_of
Closure(int)	string $link_to

Definition at line 44 of file BadgeParent.php.

      {
        $this->icon = Closure::fromCallable($icon);
        $this->references_of = Closure::fromCallable($references_of);
        $this->link_to = Closure::fromCallable($link_to);
    }

Member Function Documentation

asComponent()

ILIAS\Badge\BadgeParent::asComponent

(

ilBadge

$badge

)

Definition at line 55 of file BadgeParent.php.

References ILIAS\Badge\BadgeParent\metaData(), and null.

                                               : ?Component
    {
        $meta_data = $this->metaData($badge);
        if (null === $meta_data) {
            return null;
        }

        $parent_icon = $this->container->ui()->factory()->symbol()->icon()->custom(
            ($this->icon)($meta_data['id'], 'big', $meta_data['type']),
            $this->container->language()->txt('obj_' . $meta_data['type']),
            'medium'
        );

        $parent_ref_id = current(($this->references_of)($meta_data['id']));
        if ($parent_ref_id && $this->container->access()->checkAccess('read', '', $parent_ref_id)) {
            $parent_link = $this->container->ui()
                                           ->factory()
                                           ->link()
                                           ->standard($meta_data['title'], ($this->link_to)($parent_ref_id));
        } else {
            $parent_link = $this->container->ui()->factory()->legacy()->content($meta_data['title']);
        }

        return $this->container->ui()->factory()->listing()->descriptive([
            $this->container->language()->txt('object') => $this->container->ui()->factory()->legacy()->content(
                $this->container->ui()->renderer()->render([$parent_icon, $parent_link])
            )
        ]);
    }

Here is the call graph for this function:

asProperty()

ILIAS\Badge\BadgeParent::asProperty

(

ilBadge

$badge

)

Definition at line 85 of file BadgeParent.php.

References ILIAS\Badge\BadgeParent\$icon, ILIAS\Badge\BadgeParent\metaData(), and null.

                                              : ?string
    {
        $meta_data = $this->metaData($badge);
        if (null === $meta_data) {
            return null;
        }

        $icon = [$this->container->ui()->factory()->symbol()->icon(), 'custom'];

        return implode(' ', [
            $this->container->ui()->renderer()->render($icon(($this->icon)($meta_data['id'], 'small', $meta_data['type']), $meta_data['title'])),
            $meta_data['title'],
        ]);
    }

Here is the call graph for this function:

metaData()

ILIAS\Badge\BadgeParent::metaData ( ilBadge  $badge )

private

Definition at line 100 of file BadgeParent.php.

References ilBadge\getParentId(), ilBadge\getParentMeta(), and null.

Referenced by ILIAS\Badge\BadgeParent\asComponent(), and ILIAS\Badge\BadgeParent\asProperty().

                                             : ?array
    {
        if (!$badge->getParentId()) {
            return null;
        }
        $parent = $badge->getParentMeta();
        if ($parent['type'] === 'bdga') {
            return null;
        }

        return $parent;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$icon

readonly Closure ILIAS\Badge\BadgeParent::$icon

private

Definition at line 33 of file BadgeParent.php.

Referenced by ILIAS\Badge\BadgeParent\asProperty().

$link_to

readonly Closure ILIAS\Badge\BadgeParent::$link_to

private

Definition at line 37 of file BadgeParent.php.

$references_of

readonly Closure ILIAS\Badge\BadgeParent::$references_of

private

Definition at line 35 of file BadgeParent.php.

---

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

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