.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets
.. php:namespace::  TYPO3\CMS\Linkvalidator\Linktype

.. php:interface:: LinktypeInterface

   This class provides interface implementation.

   .. php:method:: getIdentifier()

      Returns the unique identifier of the linktype

      :returntype: string

   .. php:method:: checkLink(string $url, array $softRefEntry, TYPO3\\CMS\\Linkvalidator\\LinkAnalyzer $reference)

      Checks a given link for validity

      :param string $url: Url to check
      :param array $softRefEntry: The soft reference entry which builds the context of that url
      :param TYPO3\\CMS\\Linkvalidator\\LinkAnalyzer $reference: Parent instance
      :returntype: bool
      :returns: bool TRUE on success or FALSE on error

   .. php:method:: setAdditionalConfig(array $config)

      Function to override config of Linktype. Should be used only
      if necessary. Add additional configuration to TSconfig.

      :param array $config: the config

   .. php:method:: fetchType(array $value, string $type, string $key)

      Base type fetching method, based on the type that softRefParserObj returns.

      :param array $value: Reference properties
      :param string $type: Current type
      :param string $key: Validator hook name
      :returntype: string
      :returns: string Fetched type

   .. php:method:: getErrorParams()

      Get the value of the private property errorParams.

      :returntype: array
      :returns: array All parameters needed for the rendering of the error message

   .. php:method:: getBrokenUrl(array $row)

      Construct a valid Url for browser output

      :param array $row: Broken link record
      :returntype: string
      :returns: string Parsed broken url

   .. php:method:: getErrorMessage(array $errorParams)

      Generate the localized error message from the error params saved from the parsing

      :param array $errorParams: All parameters needed for the rendering of the error message
      :returntype: string
      :returns: string Validation error message
