ILIAS  trunk Revision v11.0_alpha-2645-g16283d3b3f8
ILIAS\UI\Component\Link\Link Interface Reference

Link base interface. More...

+ Inheritance diagram for ILIAS\UI\Component\Link\Link:
+ Collaboration diagram for ILIAS\UI\Component\Link\Link:

Public Member Functions

 getAction ()
 Get the action url of a link. More...
 
 withOpenInNewViewport (bool $open_in_new_viewport)
 Set if link should be opened in new viewport. More...
 
 getOpenInNewViewport ()
 
 withLanguageOfReferencedContent (LanguageTag $language)
 The hreflang attribute indicates the language of content targeted by links. More...
 
 getLanguageOfReferencedResource ()
 See comment in withLanguageOfReferencedContent. More...
 
 withAdditionalRelationshipToReferencedResource (Relationship $type)
 Relationships between the current and the referenced page are added as a rel attribute. More...
 
 getRelationshipsToReferencedResource ()
 
 withDisabled (bool $disabled=true)
 disables the Link More...
 
- Public Member Functions inherited from ILIAS\UI\Component\Component
 getCanonicalName ()
 Get the canonical name of the component. More...
 
 reduceWith (\Closure $fn)
 The scheme starts at the leaves of the structure and applies the function to each leave and moves up the tree recursively. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\HasContentLanguage
 withContentLanguage (LanguageTag $language)
 If the link text also is not translated (e.g., because it is a formal title that should be kept in the original language), you should add the language attributes to the anchor element. More...
 
 getContentLanguage ()
 See comment in withContentLanguage. More...
 
- Public Member Functions inherited from ILIAS\UI\Component\HasHelpTopics
 withHelpTopics (Topic ... $topics)
 Let this component have the given topics. More...
 
 withAdditionalHelpTopics (Topic ... $topics)
 Let this component also have the given topics. More...
 
 getHelpTopics ()
 
- Public Member Functions inherited from ILIAS\UI\Component\JavaScriptBindable
 withOnLoadCode (Closure $binder)
 
 withAdditionalOnLoadCode (Closure $binder)
 Add some onload-code to the component instead of replacing the existing one. More...
 
 getOnLoadCode ()
 Get the currently bound on load code. More...
 

Detailed Description

Link base interface.

Definition at line 32 of file Link.php.

Member Function Documentation

◆ getAction()

ILIAS\UI\Component\Link\Link::getAction ( )

Get the action url of a link.

◆ getLanguageOfReferencedResource()

ILIAS\UI\Component\Link\Link::getLanguageOfReferencedResource ( )

See comment in withLanguageOfReferencedContent.

◆ getOpenInNewViewport()

ILIAS\UI\Component\Link\Link::getOpenInNewViewport ( )

◆ getRelationshipsToReferencedResource()

ILIAS\UI\Component\Link\Link::getRelationshipsToReferencedResource ( )
Returns
IsRelationship[]

◆ withAdditionalRelationshipToReferencedResource()

ILIAS\UI\Component\Link\Link::withAdditionalRelationshipToReferencedResource ( Relationship  $type)

Relationships between the current and the referenced page are added as a rel attribute.

◆ withDisabled()

ILIAS\UI\Component\Link\Link::withDisabled ( bool  $disabled = true)

disables the Link

◆ withLanguageOfReferencedContent()

ILIAS\UI\Component\Link\Link::withLanguageOfReferencedContent ( LanguageTag  $language)

The hreflang attribute indicates the language of content targeted by links.

It is helpful though not required to add this information to links for which the target will not be translated in this process. If the link text also is not translated (e.g., because it is a formal title that should be kept in the original language), you should also add the language attributes to the anchor element.

◆ withOpenInNewViewport()

ILIAS\UI\Component\Link\Link::withOpenInNewViewport ( bool  $open_in_new_viewport)

Set if link should be opened in new viewport.


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