Skip to content
Snippets Groups Projects
Commit 77377519 authored by Sybille Peters's avatar Sybille Peters Committed by Christian Kuhn
Browse files

[DOCS] Fix explanation of searchFields for linkvalidator

The TSconfig configuration option mod.linkvalidator.searchFields
is documented in the documentation.

Previously, it was only possible to check within fields, if at
least one softref was configured. This was changed to include
fields with the type "link" (see LinkAnalyzer class). This change
updates the documentation to reflect that.

Resolves: #103477
Related: #83835
Releases: main, 12.4
Change-Id: I83ceafca206b2b1821e622bc36867eb13a9a5984
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/83584


Tested-by: default avatarChristian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: default avatarOliver Bartsch <bo@cedev.de>
Reviewed-by: default avatarChristian Kuhn <lolli@schwarzbu.ch>
Tested-by: default avatarOliver Bartsch <bo@cedev.de>
Tested-by: default avatarcore-ci <typo3@b13.com>
parent 806a8bc6
Branches
Tags
No related merge requests found
......@@ -311,6 +311,8 @@ class LinkAnalyzer
$valueField = $record[$field];
// Add a softref definition for link fields if the TCA does not specify one already
// todo: check for 'type' => 'file' as well and update in documentation
// e.g. pages.media
if (($conf['type'] ?? '') === 'link' && empty($conf['softref'])) {
$conf['softref'] = 'typolink';
}
......
......@@ -69,20 +69,25 @@ searchFields.[key]
.. warning::
Currently, LinkValidator can only detect links for fields having at
least one :ref:`softref <t3tca:columns-input-properties-softref>` set in their TCA configuration.
Currently, LinkValidator will only detect links for fields if the
TCA configuration meets one of these criteria:
* at least one :ref:`softref <t3tca:columns-input-properties-softref>`
* type is set to :ref:`link <t3tca:columns-link>`
For this reason, it is currently not possible to check for
`pages.media`. This will be fixed in the future.
Examples for working fields:
* `pages.canonical_link`
* `pages.url`
* `pages.canonical_link` (:php:`'type' => 'link'`)
* `pages.url` (:php:`'softref' => 'url'`)
* `sys_file_reference.link` (:php:`'type' => 'link'`)
Example for not working fields:
* `pages.media`
* `pages.media` (:php:`'type' => 'file'`)
Example
::
......
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