Commit 590440d8 authored by Sybille Peters's avatar Sybille Peters 🙋 Committed by Daniel Goerz
Browse files

[DOCS] Remove Developer page from Linkvalidator docs

The Developer page explained how link handling is done
in the RTE. This is not specific to linkvalidator and
may change in the future.

Understanding how the existing events work can be
better done by looking in the core.

Resolves: #92720
Releases: master
Change-Id: I88bdf27c2045c29c0f93bcc3f394cb21471e0b73
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/66274


Tested-by: default avatarTYPO3com <noreply@typo3.com>
Tested-by: Björn Jacob's avatarBjörn Jacob <bjoern.jacob@tritum.de>
Tested-by: Oliver Bartsch's avatarOliver Bartsch <bo@cedev.de>
Tested-by: default avatarJosef Glatz <josefglatz@gmail.com>
Tested-by: Daniel Goerz's avatarDaniel Goerz <daniel.goerz@posteo.de>
Reviewed-by: Björn Jacob's avatarBjörn Jacob <bjoern.jacob@tritum.de>
Reviewed-by: Oliver Klee's avatarOliver Klee <typo3-coding@oliverklee.de>
Reviewed-by: Oliver Bartsch's avatarOliver Bartsch <bo@cedev.de>
Reviewed-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: default avatarJosef Glatz <josefglatz@gmail.com>
Reviewed-by: Daniel Goerz's avatarDaniel Goerz <daniel.goerz@posteo.de>
parent b3b4fd86
.. include:: ../Includes.txt
.. _development:
Development / Background Information
------------------------------------
In this chapter, we want to provide a bit of information on how the linkvalidator works internally.
The procedure for marking the broken links in the RTE is as follow:
#. RTE content is fetched from the database.
Before it is displayed in the edit form, RTE transformations are performed.
#. The transformation function parses the text and detects links.
#. For each link, a PSR-14 event (:php:`TYPO3\CMS\Core\Html\Event\BrokenLinkAnalysisEvent`) is dispatched.
#. If a listener is attached, it may set the link as broken and will set the link as "checked".
#. If a link is detected as broken, RTE will mark it as broken.
Take a look at the :file:`Services.yaml` where the listeners for that event are registered:
.. code-block:: yaml
TYPO3\CMS\Linkvalidator\EventListener\CheckBrokenRteLinkEventListener:
tags:
- name: event.listener
identifier: 'rte-check-link-external'
event: TYPO3\CMS\Core\Html\Event\BrokenLinkAnalysisEvent
method: 'checkExternalLink'
- name: event.listener
identifier: 'rte-check-link-to-page'
event: TYPO3\CMS\Core\Html\Event\BrokenLinkAnalysisEvent
method: 'checkPageLink'
- name: event.listener
identifier: 'rte-check-link-to-file'
event: TYPO3\CMS\Core\Html\Event\BrokenLinkAnalysisEvent
method: 'checkFileLink'
File, Page and External Links are checked via these EventListeners.
......@@ -55,6 +55,5 @@ available from `typo3.org <https://typo3.org/>`_
Administration/Index
Configuration/Index
LargeSites/Index
Development/Index
Targets
Supports Markdown
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