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, IRSS $irss)
	toUIComponents (CopyrightDataInterface $copyright)
	toString (CopyrightDataInterface $copyright)

Protected Member Functions
	buildIcon (CopyrightDataInterface $copyright)
	buildIconFromLink (CopyrightDataInterface $copyright)
	buildIconFromFile (CopyrightDataInterface $copyright)
	buildFallBackIcon (CopyrightDataInterface $copyright)
	getFallBackSrc ()
	buildLink (CopyrightDataInterface $copyright)
	customIcon (string $src, string $alt)
	standardLink (string $label, string $action)
	textInLegacy (string $text)
	getSourceFromIRSS (string $string_id)

Protected Attributes
const string	FALLBACK_IMG = 'copyrights\all_rights_reserved.svg'
Factory	$factory
IRSS	$irss

Detailed Description

Definition at line 30 of file Renderer.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Copyright\Renderer::__construct	(	Factory	$factory,
		IRSS	$irss
	)

Definition at line 37 of file Renderer.php.

References ILIAS\MetaData\Copyright\Renderer\$factory, ILIAS\MetaData\Copyright\Renderer\$irss, and factory().

      {
        $this->factory = $factory;
        $this->irss = $irss;
    }

Here is the call graph for this function:

Member Function Documentation

buildFallBackIcon()

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

protected

Definition at line 118 of file Renderer.php.

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

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

                                                                           : ?Icon
    {
        return $this->customIcon(
            $this->getFallBackSrc(),
            $copyright->altText()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildIcon()

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

protected

Definition at line 81 of file Renderer.php.

References ILIAS\MetaData\Copyright\Renderer\buildFallBackIcon(), ILIAS\MetaData\Copyright\Renderer\buildIconFromFile(), ILIAS\MetaData\Copyright\Renderer\buildIconFromLink(), ILIAS\MetaData\Copyright\CopyrightDataInterface\fallBackToDefaultImage(), ILIAS\MetaData\Copyright\CopyrightDataInterface\hasImage(), ILIAS\MetaData\Copyright\CopyrightDataInterface\isImageLink(), and null.

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

                                                                   : ?Icon
    {
        if (!$copyright->hasImage()) {
            if ($copyright->fallBackToDefaultImage()) {
                return $this->buildFallBackIcon($copyright);
            }
            return null;
        }
        if ($copyright->isImageLink()) {
            return $this->buildIconFromLink($copyright);
        } else {
            return $this->buildIconFromFile($copyright);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildIconFromFile()

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

protected

Definition at line 104 of file Renderer.php.

References ILIAS\MetaData\Copyright\CopyrightDataInterface\altText(), ILIAS\MetaData\Copyright\Renderer\customIcon(), ILIAS\MetaData\Copyright\Renderer\getSourceFromIRSS(), ILIAS\MetaData\Copyright\CopyrightDataInterface\imageFile(), and null.

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

                                                                           : ?Icon
    {
        if ($from_irss = $this->getSourceFromIRSS($copyright->imageFile())) {
            $src = $from_irss;
        } else {
            return null;
        }

        return $this->customIcon(
            $src,
            $copyright->altText()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildIconFromLink()

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

protected

Definition at line 96 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\buildIcon().

                                                                           : Icon
    {
        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 131 of file Renderer.php.

References ILIAS\MetaData\Copyright\CopyrightDataInterface\fullName(), ILIAS\MetaData\Copyright\CopyrightDataInterface\link(), null, 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()
        )->withAdditionalRelationshipToReferencedResource(Relationship::LICENSE);
    }

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 142 of file Renderer.php.

References factory(), and ILIAS\UI\Component\Symbol\Icon\Icon\MEDIUM.

Referenced by ILIAS\MetaData\Copyright\Renderer\buildFallBackIcon(), ILIAS\MetaData\Copyright\Renderer\buildIconFromFile(), and ILIAS\MetaData\Copyright\Renderer\buildIconFromLink().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getFallBackSrc()

ILIAS\MetaData\Copyright\Renderer::getFallBackSrc ( )

protected

Definition at line 126 of file Renderer.php.

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

                                       : string
    {
        return \ilUtil::getImagePath(self::FALLBACK_IMG);
    }

Here is the caller graph for this function:

getSourceFromIRSS()

ILIAS\MetaData\Copyright\Renderer::getSourceFromIRSS ( string  $string_id )

protected

Definition at line 157 of file Renderer.php.

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

                                                           : string
    {
        if ($identifier = $this->irss->manage()->find($string_id)) {
            return $this->irss->consume()->src($identifier)->getSrc();
        }
        return '';
    }

Here is the caller graph for this function:

standardLink()

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

protected

Definition at line 147 of file Renderer.php.

References factory().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

textInLegacy()

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

protected

Definition at line 152 of file Renderer.php.

References factory().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

toString()

ILIAS\MetaData\Copyright\Renderer::toString

(

CopyrightDataInterface

$copyright

)

Implements ILIAS\MetaData\Copyright\RendererInterface.

Definition at line 65 of file Renderer.php.

References $res, ILIAS\MetaData\Copyright\CopyrightDataInterface\fullName(), ILIAS\MetaData\Copyright\CopyrightDataInterface\link(), and null.

                                                               : string
    {
        $full_name = $copyright->fullName();
        $link = $copyright->link();

        $res = [];
        if ($full_name !== '') {
            $res[] = $full_name;
        }
        if ($link !== null) {
            $res[] = (string) $link;
        }

        return implode(' ', $res);
    }

Here is the call graph for this function:

toUIComponents()

ILIAS\MetaData\Copyright\Renderer::toUIComponents

(

CopyrightDataInterface

$copyright

)

Returns

Icon[]|Link[]|Content[]

Implements ILIAS\MetaData\Copyright\RendererInterface.

Definition at line 48 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 34 of file Renderer.php.

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

$irss

IRSS ILIAS\MetaData\Copyright\Renderer::$irss

protected

Definition at line 35 of file Renderer.php.

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

FALLBACK_IMG

const string ILIAS\MetaData\Copyright\Renderer::FALLBACK_IMG = 'copyrights\all_rights_reserved.svg'

protected

Definition at line 32 of file Renderer.php.

---

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

• components/ILIAS/MetaData/classes/Copyright/Renderer.php