ILIAS\MetaData\Copyright\Renderer Class Reference

Inheritance diagram for ILIAS\MetaData\Copyright\Renderer:

Collaboration diagram for ILIAS\MetaData\Copyright\Renderer:

Public Member Functions
	__construct (Factory $factory)
	toUIComponents (CopyrightDataInterface $copyright)
Public Member Functions inherited from ILIAS\MetaData\Copyright\RendererInterface
	toUIComponents (CopyrightData $copyright)
	Returns a string in a legacy UI component if only a string can be returned. More...

Protected Member Functions
	buildIcon (CopyrightDataInterface $copyright)
	buildLink (CopyrightDataInterface $copyright)
	customIcon (string $src, string $alt)
	standardLink (string $label, string $action)
	textInLegacy (string $text)

Protected Attributes
Factory	$factory

Detailed Description

Definition at line 28 of file Renderer.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Copyright\Renderer::__construct

(

Factory

$factory

)

Definition at line 32 of file Renderer.php.

References ILIAS\MetaData\Copyright\Renderer\$factory.

      {
        $this->factory = $factory;
    }

Member Function Documentation

buildIcon()

ILIAS\MetaData\Copyright\Renderer::buildIcon ( CopyrightDataInterface  $copyright )

protected

Definition at line 58 of file Renderer.php.

References ILIAS\MetaData\Copyright\CopyrightDataInterface\altText(), ILIAS\MetaData\Copyright\Renderer\customIcon(), and ILIAS\MetaData\Copyright\CopyrightDataInterface\imageLink().

Referenced by ILIAS\MetaData\Copyright\Renderer\toUIComponents().

                                                                   : ?Icon
    {
        if (!$copyright->imageLink()) {
            return null;
        }
        return $this->customIcon(
            (string) $copyright->imageLink(),
            $copyright->altText()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildLink()

ILIAS\MetaData\Copyright\Renderer::buildLink ( CopyrightDataInterface  $copyright )

protected

Definition at line 69 of file Renderer.php.

References ILIAS\MetaData\Copyright\CopyrightDataInterface\fullName(), ILIAS\MetaData\Copyright\CopyrightDataInterface\link(), and ILIAS\MetaData\Copyright\Renderer\standardLink().

Referenced by ILIAS\MetaData\Copyright\Renderer\toUIComponents().

                                                                   : ?Link
    {
        if (!$copyright->link()) {
            return null;
        }
        return $this->standardLink(
            $copyright->fullName() !== '' ? $copyright->fullName() : (string) $copyright->link(),
            (string) $copyright->link()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

customIcon()

ILIAS\MetaData\Copyright\Renderer::customIcon ( string  $src, string  $alt  )

protected

Definition at line 80 of file Renderer.php.

References ILIAS\UI\Component\Symbol\Icon\Icon\MEDIUM.

Referenced by ILIAS\MetaData\Copyright\Renderer\buildIcon().

                                                           : Icon
    {
        return $this->factory->symbol()->icon()->custom($src, $alt, Icon::MEDIUM);
    }

Here is the caller graph for this function:

standardLink()

ILIAS\MetaData\Copyright\Renderer::standardLink ( string  $label, string  $action  )

protected

Definition at line 85 of file Renderer.php.

Referenced by ILIAS\MetaData\Copyright\Renderer\buildLink().

                                                                  : Link
    {
        return $this->factory->link()->standard($label, $action);
    }

Here is the caller graph for this function:

textInLegacy()

ILIAS\MetaData\Copyright\Renderer::textInLegacy ( string  $text )

protected

Definition at line 90 of file Renderer.php.

Referenced by ILIAS\MetaData\Copyright\Renderer\toUIComponents().

                                                 : Legacy
    {
        return $this->factory->legacy($text);
    }

Here is the caller graph for this function:

toUIComponents()

ILIAS\MetaData\Copyright\Renderer::toUIComponents

(

CopyrightDataInterface

$copyright

)

Returns

Icon[]|Link[]|Legacy[]

Definition at line 41 of file Renderer.php.

References $res, ILIAS\MetaData\Copyright\Renderer\buildIcon(), ILIAS\MetaData\Copyright\Renderer\buildLink(), ILIAS\MetaData\Copyright\CopyrightDataInterface\fullName(), and ILIAS\MetaData\Copyright\Renderer\textInLegacy().

                                                                     : array
    {
        $res = [];
        $has_link = false;
        if (!is_null($image = $this->buildIcon($copyright))) {
            $res[] = $image;
        }
        if (!is_null($link = $this->buildLink($copyright))) {
            $res[] = $link;
            $has_link = true;
        }
        if ($copyright->fullName() && !$has_link) {
            $res[] = $this->textInLegacy($copyright->fullName());
        }
        return $res;
    }

Here is the call graph for this function:

Field Documentation

$factory

Factory ILIAS\MetaData\Copyright\Renderer::$factory

protected

Definition at line 30 of file Renderer.php.

Referenced by ILIAS\MetaData\Copyright\Renderer\__construct().

---

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

• Services/MetaData/classes/Copyright/Renderer.php