ILIAS\MetaData\Services\CopyrightHelper\Copyright Class Reference

Inheritance diagram for ILIAS\MetaData\Services\CopyrightHelper\Copyright:

Collaboration diagram for ILIAS\MetaData\Services\CopyrightHelper\Copyright:

Public Member Functions
	__construct (RendererInterface $renderer, IdentifierHandler $identifier_handler, EntryInterface $entry)
	isDefault ()
	isOutdated ()
	identifier ()
	title ()
	description ()
	presentAsUIComponents ()
	presentAsImageOnly ()
	If the copyright does not have an image, null is returned. More...
	presentAsLinkOnly ()
	If the copyright has no link, its full name is returned as a disabled link. More...
	presentAsString ()
	The copyright without image in a reduced presentation, for displaying copyright where no UI components can be used (e.g. More...
	isDefault ()
	isOutdated ()
	identifier ()
	title ()
	description ()
	presentAsUIComponents ()
	The copyright as UI Components, as it should be presented in the UI almost everywhere. More...
	presentAsImageOnly ()
	The copyright just as its image, for use e.g. More...
	presentAsLinkOnly ()
	The copyright just as a link, for use e.g. More...
	presentAsString ()
	The copyright without image in a reduced presentation, for displaying copyright where no UI components can be used (e.g. More...

Protected Attributes
RendererInterface	$renderer
IdentifierHandler	$identifier_handler
EntryInterface	$entry

Detailed Description

Definition at line 30 of file Copyright.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Services\CopyrightHelper\Copyright::__construct	(	RendererInterface	$renderer,
		IdentifierHandler	$identifier_handler,
		EntryInterface	$entry
	)

Definition at line 37 of file Copyright.php.

      {
        $this->renderer = $renderer;
        $this->identifier_handler = $identifier_handler;
 
        $this->entry = $entry;
    }

References ILIAS\MetaData\Services\CopyrightHelper\Copyright\$entry, ILIAS\MetaData\Services\CopyrightHelper\Copyright\$identifier_handler, ILIAS\MetaData\Services\CopyrightHelper\Copyright\$renderer, and renderer().

Here is the call graph for this function:

Member Function Documentation

description()

ILIAS\MetaData\Services\CopyrightHelper\Copyright::description

(

)

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface.

Definition at line 68 of file Copyright.php.

                                 : string
    {
        return $this->entry->description();
    }

identifier()

ILIAS\MetaData\Services\CopyrightHelper\Copyright::identifier

(

)

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface.

Definition at line 58 of file Copyright.php.

                                : string
    {
        return $this->identifier_handler->buildIdentifierFromEntryID($this->entry->id());
    }

isDefault()

ILIAS\MetaData\Services\CopyrightHelper\Copyright::isDefault

(

)

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface.

Definition at line 48 of file Copyright.php.

                               : bool
    {
        return $this->entry->isDefault();
    }

isOutdated()

ILIAS\MetaData\Services\CopyrightHelper\Copyright::isOutdated

(

)

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface.

Definition at line 53 of file Copyright.php.

                                : bool
    {
        return $this->entry->isOutdated();
    }

presentAsImageOnly()

ILIAS\MetaData\Services\CopyrightHelper\Copyright::presentAsImageOnly

(

)

If the copyright does not have an image, null is returned.

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface.

Definition at line 84 of file Copyright.php.

                                        : ?Icon
    {
        return $this->renderer->toImageOnly($this->entry->copyrightData());
    }

References renderer().

Here is the call graph for this function:

presentAsLinkOnly()

ILIAS\MetaData\Services\CopyrightHelper\Copyright::presentAsLinkOnly

(

)

If the copyright has no link, its full name is returned as a disabled link.

If it also does not have a full name, null is returned.

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface.

Definition at line 93 of file Copyright.php.

                                       : ?Link
    {
        return $this->renderer->toLinkOnly($this->entry->copyrightData());
    }

References renderer().

Here is the call graph for this function:

presentAsString()

ILIAS\MetaData\Services\CopyrightHelper\Copyright::presentAsString

(

)

The copyright without image in a reduced presentation, for displaying copyright where no UI components can be used (e.g.

exports of tables).

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface.

Definition at line 98 of file Copyright.php.

                                     : string
    {
        return $this->renderer->toString($this->entry->copyrightData());
    }

References renderer().

Here is the call graph for this function:

presentAsUIComponents()

ILIAS\MetaData\Services\CopyrightHelper\Copyright::presentAsUIComponents

(

)

Returns

Icon[]|Link[]|Content[]

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface.

Definition at line 76 of file Copyright.php.

                                           : array
    {
        return $this->renderer->toUIComponents($this->entry->copyrightData());
    }

References renderer().

Here is the call graph for this function:

title()

ILIAS\MetaData\Services\CopyrightHelper\Copyright::title

(

)

Implements ILIAS\MetaData\Services\CopyrightHelper\CopyrightInterface.

Definition at line 63 of file Copyright.php.

                           : string
    {
        return $this->entry->title();
    }

Field Documentation

$entry

EntryInterface ILIAS\MetaData\Services\CopyrightHelper\Copyright::$entry

protected

Definition at line 35 of file Copyright.php.

Referenced by ILIAS\MetaData\Services\CopyrightHelper\Copyright\__construct().

$identifier_handler

IdentifierHandler ILIAS\MetaData\Services\CopyrightHelper\Copyright::$identifier_handler

protected

Definition at line 33 of file Copyright.php.

Referenced by ILIAS\MetaData\Services\CopyrightHelper\Copyright\__construct().

$renderer

RendererInterface ILIAS\MetaData\Services\CopyrightHelper\Copyright::$renderer

protected

Definition at line 32 of file Copyright.php.

Referenced by ILIAS\MetaData\Services\CopyrightHelper\Copyright\__construct().

---

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

• components/ILIAS/MetaData/classes/Services/CopyrightHelper/Copyright.php