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)

	toImageOnly (CopyrightDataInterface $copyright)

	toLinkOnly (CopyrightDataInterface $copyright)
	Returns a string as a disabled link, if only a string can be returned, or null if the copyright is image only. More...

	toString (CopyrightDataInterface $copyright)

	toUIComponents (CopyrightDataInterface $copyright)
	Returns a string in a legacy UI component if only a string can be returned. More...

	toImageOnly (CopyrightDataInterface $copyright)

	toLinkOnly (CopyrightDataInterface $copyright)
	Returns a string as a disabled link, if only a string can be returned, or null if the copyright is image only. More...

	toString (CopyrightDataInterface $copyright)

Protected Member Functions
	buildIcon (CopyrightDataInterface $copyright)

	buildIconFromLink (CopyrightDataInterface $copyright)

	buildIconFromFile (CopyrightDataInterface $copyright)

	buildFallBackIcon (CopyrightDataInterface $copyright)

	getFallBackSrc ()

	buildLink (CopyrightDataInterface $copyright, bool $allow_empty_link)

	customIcon (string $src, string $alt)

	standardLink (string $label, string $action, ?Relationship $relationship, bool $disabled)

	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.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ buildFallBackIcon()

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

protected

Definition at line 128 of file Renderer.php.

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

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

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

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

                                                                   : ?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);
        }
    }

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(), and ILIAS\MetaData\Copyright\CopyrightDataInterface\isImageLink().

Referenced by ILIAS\MetaData\Copyright\Renderer\toImageOnly(), and ILIAS\MetaData\Copyright\Renderer\toUIComponents().

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

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

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

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

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildLink()

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

protected

Definition at line 141 of file Renderer.php.

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

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

Referenced by ILIAS\MetaData\Copyright\Renderer\toLinkOnly(), and ILIAS\MetaData\Copyright\Renderer\toUIComponents().

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

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

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().

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

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

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

Here is the caller graph for this function:

◆ getSourceFromIRSS()

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

protected

Definition at line 183 of file Renderer.php.

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

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

Here is the caller graph for this function:

◆ standardLink()

ILIAS\MetaData\Copyright\Renderer::standardLink	(	string	$label,
		string	$action,
		?Relationship	$relationship,
		bool	$disabled
	)

protected

Definition at line 162 of file Renderer.php.

     : Link {
        $link = $this->factory->link()->standard($label, $action);
        if ($relationship !== null) {
            $link = $link->withAdditionalRelationshipToReferencedResource($relationship);
        }
        if ($disabled) {
            $link = $link->withDisabled();
        }
        return $link;
    }

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

Here is the caller graph for this function:

◆ textInLegacy()

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

protected

Definition at line 178 of file Renderer.php.

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

References factory().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toImageOnly()

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

Implements ILIAS\MetaData\Copyright\RendererInterface.

Definition at line 65 of file Renderer.php.

                                                                  : ?Icon
    {
        return $this->buildIcon($copyright);
    }

References ILIAS\MetaData\Copyright\Renderer\buildIcon().

Here is the call graph for this function:

◆ toLinkOnly()

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

Returns a string as a disabled link, if only a string can be returned, or null if the copyright is image only.

Implements ILIAS\MetaData\Copyright\RendererInterface.

Definition at line 70 of file Renderer.php.

                                                                 : ?Link
    {
        return $this->buildLink($copyright, true);
    }

References ILIAS\MetaData\Copyright\Renderer\buildLink().

Here is the call graph for this function:

◆ toString()

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

Implements ILIAS\MetaData\Copyright\RendererInterface.

Definition at line 75 of file Renderer.php.

                                                               : string
    {
        $full_name = $copyright->fullName();
        $link = $copyright->link();
 
        $res = [];
        if ($full_name !== '') {
            $res[] = $full_name;
        }
        if ($link !== null) {
            $res[] = (string) $link;
        }
 
        return implode(' ', $res);
    }

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

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.

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

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildFallBackIcon()

◆ buildIcon()

◆ buildIconFromFile()

◆ buildIconFromLink()

◆ buildLink()

◆ customIcon()

◆ getFallBackSrc()

◆ getSourceFromIRSS()

◆ standardLink()

◆ textInLegacy()

◆ toImageOnly()

◆ toLinkOnly()

◆ toString()

◆ toUIComponents()

Field Documentation

◆ $factory

◆ $irss

◆ FALLBACK_IMG