Skip to content
Snippets Groups Projects
Commit 4f7c4d1c authored by Benni Mack's avatar Benni Mack Committed by Oliver Bartsch
Browse files

[!!!][FEATURE] Introduce dedicated class to create typolinks with unified Event

This change moves all "typolink" functionality
from cObj->typolink into a custom "LinkFactory"
class which then calls custom LinkBuilders (as before)
to do their work.

The main benefit is separation of concerns, thinning
out functionality from the monster ContentObjectRenderer
functionality.

Instead of the global hook
$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['typoLink_PostProc']
a new PSR-14 Event "AfterLinkIsGeneratedEvent" is introduced,
which in turn uses the LinkResult to operate on.

This new Event also makes the hook
$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['urlProcessing']['urlProcessors']
obsolete, which was used for non-page links + URLs. As
all functionality for frontend links are now running
through this event, which contains all information.

In addition, typolink.userFunc now receives
a LinkResult object instead of a <a> string with arguments,
and needs to return a LinkResult object again.

Also, the ATagParams hook vanished as well, since the
new Event can be used easily (and in a much better way!)

Both parts are breaking, all other parts are expected
to work as before.

A new HtmlLinkResult is added, which allows for building
a HSC'ed <a> tag properly in typolink().

Architectural Details:

* LinkFactory (new class) is now handling the "typolink" logic
  for creating any kind of links or URLs (page/mails/files).
  For the actual logic of e.g, pages the "PageLinkBuilder" is used
  in this place.
* Internally, LinkFactory follows the same generation as
  cObj->typolink() before, but uses methods to make the code
  more readable.
* In the end, LinkFactory will return a "LinkResultInterface"
  which contains everything to build a <a> tag, however it
  cannot return a "UriInterface" from PSR-7, as a
  link to mailto: is not a URL, thus, not supported by PSR-7.
* The main "cObj->typolink()" method then takes the LinkResultInterface
  and wraps it into a HtmlLinkResult which does a htmlspecialchars()
  around all the attributes and the $linkText. So this is still
  the way to go to use from a public API point of view.
* As typolink() heavily depends on stdWrap() and thus on cObject
  this information needs to be injected properly of course, and
  has the hard dependency when creating links in the Frontend.
* new methods $cObj->createUrl() and $cObj->createLink() are added
  to make use of the LinkInterface functionality programmatically,
  so people can choose to get a hsc'ed result via typolink(),
  or typolink_URL(), or a pure data via createUrl() and createLink().

Next steps / further patches:
* Deprecate "lastTypoLink_LD" etc.
* Move LinkResultFactory into LinkFactory with ClassAlias
* Maybe add another method to just generate an URL to the LinkFactory
* Create JsonLinkResult object and clean up original LinkResult object

Resolves: #96641
Resolves: #92029
Releases: main
Change-Id: Ic9ce01153a0cfdcbacb15e1e3f3e382f95400192
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/72999


Tested-by: default avatarcore-ci <typo3@b13.com>
Tested-by: default avatarOliver Hader <oliver.hader@typo3.org>
Tested-by: default avatarStefan Bürk <stefan@buerk.tech>
Tested-by: default avatarOliver Bartsch <bo@cedev.de>
Reviewed-by: default avatarOliver Hader <oliver.hader@typo3.org>
Reviewed-by: default avatarStefan Bürk <stefan@buerk.tech>
Reviewed-by: default avatarOliver Bartsch <bo@cedev.de>
parent de24cfbe
Branches
Tags
No related merge requests found
Showing
with 432 additions and 402 deletions
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment