TYPO3\CMS\Core\LinkHandling\LinkService Class Reference

Inheritance diagram for TYPO3\CMS\Core\LinkHandling\LinkService:

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

Public Attributes
const	TYPE_PAGE = 'page'
const	TYPE_INPAGE = 'inpage'
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 34 of file LinkService.php.

Constructor & Destructor Documentation

__construct()

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

(

)

LinkService constructor initializes the registered handlers.

Definition at line 55 of file LinkService.php.

References $GLOBALS.

Member Function Documentation

asString()

TYPO3\CMS\Core\LinkHandling\LinkService::asString

(

array

$parameters

)

Returns a string interpretation of the link target, something like

• ‪t3://page?uid=23&my=value::cool
• ‪https://www.typo3.org/
• ‪t3://file?uid=13
• ‪t3://folder?storage=2&identifier=/my/folder/
• ‪mac@s.nosp@m.afe..nosp@m.com

Parameters

array

$parameters

Exceptions

Exception

Definition at line 185 of file LinkService.php.

resolve()

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"

Exceptions

UnknownLinkHandlerException

Definition at line 88 of file LinkService.php.

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

resolveByStringRepresentation()

TYPO3\CMS\Core\LinkHandling\LinkService::resolveByStringRepresentation

(

string

$urn

)

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

Exceptions

Exception

Definition at line 105 of file LinkService.php.

References TYPO3\CMS\Core\Utility\PathUtility\hasProtocolAndScheme(), 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 50 of file LinkService.php.

TYPE_EMAIL

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

Definition at line 39 of file LinkService.php.

Referenced by TYPO3\CMS\Backend\Form\Element\LinkElement\getLinkExplanation(), TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\mailtoMakelinksDataProvider(), TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkTagSoftReferenceParser\parse(), TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\resolve(), TYPO3\CMS\Core\LinkHandling\LinkService\resolveByStringRepresentation(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LinkServiceTest\resolveParametersForNonFilesDataProvider(), and TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkSoftReferenceParser\setTypoLinkPartsElement().

TYPE_FILE

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

Definition at line 41 of file LinkService.php.

Referenced by TYPO3\CMS\Frontend\Typolink\LegacyLinkBuilder\build(), TYPO3\CMS\Linkvalidator\EventListener\CheckBrokenRteLinkEventListener\checkFileLink(), TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\getFileOrFolderObjectFromMixedIdentifier(), TYPO3\CMS\Backend\Form\Element\LinkElement\getLinkExplanation(), TYPO3\CMS\Redirects\Tests\Unit\Service\RedirectServiceTest\getTargetUrlReturnsUrlForTypeFile(), TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkSoftReferenceParser\getTypoLinkParts(), TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkTagSoftReferenceParser\parse(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LegacyLinkNotationConverterTest\resolveFileReferencesToSplitParameters(), TYPO3\CMS\Redirects\Service\RedirectService\resolveLinkDetailsFromLinkTarget(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LegacyLinkNotationConverterTest\resolveParametersForFilesDataProvider(), TYPO3\CMS\Backend\Controller\LinkController\resourceAction(), TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkSoftReferenceParser\setTypoLinkPartsElement(), and TYPO3\CMS\Core\Tests\Unit\LinkHandling\LegacyLinkNotationConverterTest\splitParametersToUnifiedIdentifierForFiles().

TYPE_FOLDER

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

Definition at line 42 of file LinkService.php.

Referenced by TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\getFileOrFolderObjectFromMixedIdentifier(), TYPO3\CMS\Backend\Form\Element\LinkElement\getLinkExplanation(), TYPO3\CMS\Redirects\Tests\Unit\Service\RedirectServiceTest\getTargetUrlReturnsUrlForTypeFolder(), TYPO3\CMS\Filelist\LinkHandler\FolderLinkHandler\render(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LegacyLinkNotationConverterTest\resolveFileReferencesToSplitParameters(), TYPO3\CMS\Redirects\Service\RedirectService\resolveLinkDetailsFromLinkTarget(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LegacyLinkNotationConverterTest\resolveParametersForFilesDataProvider(), TYPO3\CMS\Backend\Controller\LinkController\resourceAction(), TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkSoftReferenceParser\setTypoLinkPartsElement(), and TYPO3\CMS\Core\Tests\Unit\LinkHandling\LegacyLinkNotationConverterTest\splitParametersToUnifiedIdentifierForFiles().

TYPE_INPAGE

const TYPO3\CMS\Core\LinkHandling\LinkService::TYPE_INPAGE = 'inpage'

Definition at line 37 of file LinkService.php.

Referenced by TYPO3\CMS\Frontend\Typolink\LinkFactory\resolveLinkDetails().

TYPE_PAGE

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

Definition at line 36 of file LinkService.php.

Referenced by TYPO3\CMS\Frontend\Typolink\PageLinkBuilder\build(), TYPO3\CMS\Linkvalidator\EventListener\CheckBrokenRteLinkEventListener\checkPageLink(), TYPO3\CMS\Backend\LinkHandler\PageLinkHandler\getBodyTagAttributes(), TYPO3\CMS\Backend\Form\Element\LinkElement\getLinkExplanation(), TYPO3\CMS\Backend\LinkHandler\PageLinkHandler\getRecordsOnExpandedPage(), TYPO3\CMS\Redirects\Tests\Unit\Service\RedirectServiceTest\getTargetUrlRespectsAdditionalParametersFromTypolink(), TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkSoftReferenceParser\getTypoLinkParts(), TYPO3\CMS\Redirects\Tests\Functional\Service\RedirectServiceTest\linkForRedirectToAccessRestrictedPageIsBuild(), TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkTagSoftReferenceParser\parse(), TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\resolvePageRelatedParameters(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LegacyLinkNotationConverterTest\resolveParametersForNonFilesDataProvider(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LinkServiceTest\resolveParametersForNonFilesDataProvider(), TYPO3\CMS\Redirects\Service\RedirectService\resolveSite(), and TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkSoftReferenceParser\setTypoLinkPartsElement().

TYPE_RECORD

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

Definition at line 43 of file LinkService.php.

Referenced by TYPO3\CMS\Backend\Form\Element\LinkElement\getLinkExplanation(), TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkSoftReferenceParser\getTypoLinkParts(), TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\resolve(), TYPO3\CMS\Core\Tests\Unit\LinkHandling\LegacyLinkNotationConverterTest\resolveParametersForNonFilesDataProvider(), and TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkSoftReferenceParser\setTypoLinkPartsElement().

TYPE_TELEPHONE

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

Definition at line 40 of file LinkService.php.

Referenced by TYPO3\CMS\Backend\Form\Element\LinkElement\getLinkExplanation(), TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkTagSoftReferenceParser\parse(), TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\resolve(), TYPO3\CMS\Core\LinkHandling\LinkService\resolveByStringRepresentation(), and TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkSoftReferenceParser\setTypoLinkPartsElement().

TYPE_UNKNOWN

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

Definition at line 44 of file LinkService.php.

Referenced by TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\getFileOrFolderObjectFromMixedIdentifier(), TYPO3\CMS\Backend\Form\Element\LinkElement\getLinkExplanation(), TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkSoftReferenceParser\getTypoLinkParts(), TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\resolve(), and TYPO3\CMS\Redirects\Service\RedirectService\resolveLinkDetailsFromLinkTarget().

TYPE_URL

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

Definition at line 38 of file LinkService.php.

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\_parseFuncReturnsCorrectHtmlDataProvider(), TYPO3\CMS\Frontend\Typolink\ExternalUrlLinkBuilder\build(), TYPO3\CMS\Frontend\Typolink\LegacyLinkBuilder\build(), TYPO3\CMS\Linkvalidator\EventListener\CheckBrokenRteLinkEventListener\checkExternalLink(), TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\getFileOrFolderObjectFromMixedIdentifier(), TYPO3\CMS\Backend\Form\Element\LinkElement\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\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\httpMakelinksDataProvider(), TYPO3\CMS\Core\DataHandling\SoftReference\TypolinkTagSoftReferenceParser\parse(), 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\DataHandling\SoftReference\TypolinkSoftReferenceParser\setTypoLinkPartsElement().