‪TYPO3CMS  10.4
Public Member Functions | Public Attributes | Protected Attributes | List of all members
TYPO3\CMS\Core\LinkHandling\LinkService Class Reference
Inheritance diagram for TYPO3\CMS\Core\LinkHandling\LinkService:
TYPO3\CMS\Core\SingletonInterface

Public Member Functions

 __construct ()
 
array resolve (string $linkParameter)
 
array resolveByStringRepresentation (string $urn)
 
string asString (array $parameters)
 

Public Attributes

const TYPE_PAGE = 'page'
 
const TYPE_URL = 'url'
 
const TYPE_EMAIL = 'email'
 
const TYPE_TELEPHONE = 'telephone'
 
const TYPE_FILE = 'file'
 
const TYPE_FOLDER = 'folder'
 
const TYPE_RECORD = 'record'
 
const TYPE_UNKNOWN = 'unknown'
 

Protected Attributes

LinkHandlingInterface[] $handlers
 

Detailed Description

Class LinkService, responsible to find what kind of resource (type) is used to link to (email, external url, file, page etc) with the possibility to get a system-wide understandable "urn" to identify what type it actually is, based on the scheme or prefix.

Definition at line 32 of file LinkService.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\LinkHandling\LinkService::__construct ( )

LinkService constructor initializes the registered handlers.

Definition at line 52 of file LinkService.php.

References $GLOBALS.

Member Function Documentation

◆ asString()

string TYPO3\CMS\Core\LinkHandling\LinkService::asString ( array  $parameters)

Returns a string interpretation of the link target, something like

Parameters
array$parameters
Returns
‪string
Exceptions
Exception

Definition at line 161 of file LinkService.php.

◆ resolve()

array TYPO3\CMS\Core\LinkHandling\LinkService::resolve ( string  $linkParameter)

Part of the typolink construction functionality, called by typoLink() Used to resolve "legacy"-based typolinks and URNs.

Tries to get the type of the link from the link parameter could be

  • ‪"mailto" an email address
  • ‪"url" external URL
  • ‪"file" a local file (checked AFTER getPublicUrl() is called)
  • ‪"page" a page (integer)

Does NOT check if the page exists or the file exists.

Parameters
string$linkParameter‪could be "fileadmin/myfile.jpg", "info@typo3.org", "13" or "http://www.typo3.org"
Returns
‪array

Definition at line 79 of file LinkService.php.

References TYPO3\CMS\Core\LinkHandling\LinkService\resolveByStringRepresentation().

◆ resolveByStringRepresentation()

array TYPO3\CMS\Core\LinkHandling\LinkService::resolveByStringRepresentation ( string  $urn)

Returns an array with data interpretation of the link target, something like t3://page?uid=23.

Parameters
string$urn
Returns
‪array
Exceptions
Exception

Definition at line 98 of file LinkService.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\StringUtility\beginsWith(), TYPO3\CMS\Core\LinkHandling\LinkService\TYPE_EMAIL, TYPO3\CMS\Core\LinkHandling\LinkService\TYPE_TELEPHONE, and TYPO3\CMS\Core\LinkHandling\LinkService\TYPE_URL.

Referenced by TYPO3\CMS\Core\LinkHandling\LinkService\resolve().

Member Data Documentation

◆ $handlers

LinkHandlingInterface [] TYPO3\CMS\Core\LinkHandling\LinkService::$handlers
protected

All registered LinkHandlers

Definition at line 47 of file LinkService.php.

◆ TYPE_EMAIL

const TYPO3\CMS\Core\LinkHandling\LinkService::TYPE_EMAIL = 'email'

Definition at line 36 of file LinkService.php.

Referenced by TYPO3\CMS\Core\Database\SoftReferenceIndex\findRef_typolink_tag(), TYPO3\CMS\Backend\Form\Element\InputLinkElement\getLinkExplanation(), TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\resolve(), TYPO3\CMS\Core\LinkHandling\LinkService\resolveByStringRepresentation(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LinkServiceTest\resolveParametersForNonFilesDataProvider(), and TYPO3\CMS\Core\Database\SoftReferenceIndex\setTypoLinkPartsElement().

◆ TYPE_FILE

const TYPO3\CMS\Core\LinkHandling\LinkService::TYPE_FILE = 'file'

Definition at line 38 of file LinkService.php.

Referenced by TYPO3\CMS\Frontend\Typolink\LegacyLinkBuilder\build(), TYPO3\CMS\Linkvalidator\EventListener\CheckBrokenRteLinkEventListener\checkFileLink(), TYPO3\CMS\Core\Database\SoftReferenceIndex\findRef_typolink_tag(), TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\getBodyTagAttributes(), TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\getFileOrFolderObjectFromMixedIdentifier(), TYPO3\CMS\Backend\Form\Element\InputLinkElement\getLinkExplanation(), TYPO3\CMS\Redirects\Tests\Unit\Service\RedirectServiceTest\getTargetUrlReturnsUrlForTypeFile(), TYPO3\CMS\Core\Database\SoftReferenceIndex\getTypoLinkParts(), TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\renderItem(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LegacyLinkNotationConverterTest\resolveFileReferencesToSplitParameters(), TYPO3\CMS\Redirects\Service\RedirectService\resolveLinkDetailsFromLinkTarget(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LegacyLinkNotationConverterTest\resolveParametersForFilesDataProvider(), TYPO3\CMS\Core\Database\SoftReferenceIndex\setTypoLinkPartsElement(), and TYPO3\CMS\Core\Tests\Unit\LinkHandling\LegacyLinkNotationConverterTest\splitParametersToUnifiedIdentifierForFiles().

◆ TYPE_FOLDER

const TYPO3\CMS\Core\LinkHandling\LinkService::TYPE_FOLDER = 'folder'

Definition at line 39 of file LinkService.php.

Referenced by TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\expandFolder(), TYPO3\CMS\Recordlist\LinkHandler\FolderLinkHandler\getBodyTagAttributes(), TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\getFileOrFolderObjectFromMixedIdentifier(), TYPO3\CMS\Backend\Form\Element\InputLinkElement\getLinkExplanation(), TYPO3\CMS\Redirects\Tests\Unit\Service\RedirectServiceTest\getTargetUrlReturnsUrlForTypeFolder(), TYPO3\CMS\Recordlist\LinkHandler\FolderLinkHandler\renderItem(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LegacyLinkNotationConverterTest\resolveFileReferencesToSplitParameters(), TYPO3\CMS\Redirects\Service\RedirectService\resolveLinkDetailsFromLinkTarget(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LegacyLinkNotationConverterTest\resolveParametersForFilesDataProvider(), TYPO3\CMS\Core\Database\SoftReferenceIndex\setTypoLinkPartsElement(), and TYPO3\CMS\Core\Tests\Unit\LinkHandling\LegacyLinkNotationConverterTest\splitParametersToUnifiedIdentifierForFiles().

◆ TYPE_PAGE

const TYPO3\CMS\Core\LinkHandling\LinkService::TYPE_PAGE = 'page'

Definition at line 34 of file LinkService.php.

Referenced by TYPO3\CMS\Linkvalidator\EventListener\CheckBrokenRteLinkEventListener\checkPageLink(), TYPO3\CMS\Core\Database\SoftReferenceIndex\findRef_typolink_tag(), TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler\getBodyTagAttributes(), TYPO3\CMS\Backend\Form\Element\InputLinkElement\getLinkExplanation(), TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler\getRecordsOnExpandedPage(), TYPO3\CMS\Redirects\Tests\Unit\Service\RedirectServiceTest\getTargetUrlRespectsAdditionalParametersFromTypolink(), TYPO3\CMS\Core\Database\SoftReferenceIndex\getTypoLinkParts(), TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\resolvePageRelatedParameters(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LinkServiceTest\resolveParametersForNonFilesDataProvider(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LegacyLinkNotationConverterTest\resolveParametersForNonFilesDataProvider(), TYPO3\CMS\Core\Database\SoftReferenceIndex\setTypoLinkPartsElement(), and TYPO3\CMS\Backend\Tree\View\ElementBrowserPageTreeView\wrapTitle().

◆ TYPE_RECORD

const TYPO3\CMS\Core\LinkHandling\LinkService::TYPE_RECORD = 'record'

Definition at line 40 of file LinkService.php.

Referenced by TYPO3\CMS\Backend\Form\Element\InputLinkElement\getLinkExplanation(), TYPO3\CMS\Core\Database\SoftReferenceIndex\getTypoLinkParts(), TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\resolve(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LegacyLinkNotationConverterTest\resolveParametersForNonFilesDataProvider(), and TYPO3\CMS\Core\Database\SoftReferenceIndex\setTypoLinkPartsElement().

◆ TYPE_TELEPHONE

const TYPO3\CMS\Core\LinkHandling\LinkService::TYPE_TELEPHONE = 'telephone'

Definition at line 37 of file LinkService.php.

Referenced by TYPO3\CMS\Core\Database\SoftReferenceIndex\findRef_typolink_tag(), TYPO3\CMS\Backend\Form\Element\InputLinkElement\getLinkExplanation(), TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\resolve(), TYPO3\CMS\Core\LinkHandling\LinkService\resolveByStringRepresentation(), and TYPO3\CMS\Core\Database\SoftReferenceIndex\setTypoLinkPartsElement().

◆ TYPE_UNKNOWN

const TYPO3\CMS\Core\LinkHandling\LinkService::TYPE_UNKNOWN = 'unknown'

Definition at line 41 of file LinkService.php.

Referenced by TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\getFileOrFolderObjectFromMixedIdentifier(), TYPO3\CMS\Backend\Form\Element\InputLinkElement\getLinkExplanation(), TYPO3\CMS\Core\Database\SoftReferenceIndex\getTypoLinkParts(), and TYPO3\CMS\Redirects\Service\RedirectService\resolveLinkDetailsFromLinkTarget().

◆ TYPE_URL

const TYPO3\CMS\Core\LinkHandling\LinkService::TYPE_URL = 'url'

Definition at line 35 of file LinkService.php.

Referenced by TYPO3\CMS\Frontend\Typolink\LegacyLinkBuilder\build(), TYPO3\CMS\Linkvalidator\EventListener\CheckBrokenRteLinkEventListener\checkExternalLink(), TYPO3\CMS\Core\Database\SoftReferenceIndex\findRef_typolink_tag(), TYPO3\CMS\Backend\Form\Element\InputLinkElement\getLinkExplanation(), TYPO3\CMS\Redirects\Tests\Unit\Service\RedirectServiceTest\getTargetUrlAddsExistingQueryParams(), TYPO3\CMS\Redirects\Tests\Unit\Service\RedirectServiceTest\getTargetUrlReplaceRegExpCaptureGroup(), TYPO3\CMS\Redirects\Tests\Unit\Service\RedirectServiceTest\getTargetUrlRespectsForceHttps(), TYPO3\CMS\Redirects\Tests\Unit\Service\RedirectServiceTest\getTargetUrlReturnsUrlForTypeUrl(), TYPO3\CMS\Redirects\Tests\Unit\Service\RedirectServiceTest\getTargetUrlWithQueryAndSlashReplaceRegExpCaptureGroup(), TYPO3\CMS\Redirects\Tests\Unit\Service\RedirectServiceTest\getTargetUrlWithQueryReplaceRegExpCaptureGroup(), TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\resolve(), TYPO3\CMS\Core\LinkHandling\LinkService\resolveByStringRepresentation(), TYPO3\CMS\Redirects\Service\RedirectService\resolveLinkDetailsFromLinkTarget(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LinkServiceTest\resolveParametersForNonFilesDataProvider(), and TYPO3\CMS\Core\Database\SoftReferenceIndex\setTypoLinkPartsElement().