‪TYPO3CMS  ‪main
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype Class Reference
Inheritance diagram for TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype:
TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface

Public Member Functions

bool checkLink (string $url, array $softRefEntry, LinkAnalyzer $reference)
 
string getErrorMessage (array $errorParams)
 
string getBrokenUrl (array $row)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype
 getIdentifier ()
 
 setAdditionalConfig (array $config)
 
string fetchType (array $value, string $type, string $key)
 
array getErrorParams ()
 

Public Attributes

const DELETED = 'deleted'
 
const HIDDEN = 'hidden'
 
const MOVED = 'moved'
 
const NOTEXISTING = 'notExisting'
 

Protected Member Functions

bool checkPage ($page)
 
bool checkContent ($page, $anchor)
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype
 setErrorParams ($value)
 
 getLanguageService ()
 

Protected Attributes

bool $responsePage = true
 
bool $responseContent = true
 
string $identifier = 'db'
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype
array $errorParams = []
 
string $identifier = ''
 

Detailed Description

This class provides Check Internal Links plugin implementation

Definition at line 29 of file InternalLinktype.php.

Member Function Documentation

◆ checkContent()

bool TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype::checkContent (   $page,
  $anchor 
)
protected

Checks a given content uid for validity

Parameters
int$page‪Uid of the page to which the link is pointing
int$anchor‪Uid of the content element to check
Returns
‪bool TRUE on success or FALSE on error

Definition at line 176 of file InternalLinktype.php.

References $GLOBALS, TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\$responseContent, TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\DELETED, TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\HIDDEN, TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\MOVED, TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\NOTEXISTING, and TYPO3\CMS\Core\Database\Connection\PARAM_INT.

Referenced by TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\checkLink().

◆ checkLink()

bool TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype::checkLink ( string  $url,
array  $softRefEntry,
LinkAnalyzer  $reference 
)

Checks a given URL + /path/filename.ext for validity

Parameters
string$url‪Url to check as page-id or page-id#anchor (if anchor is present)
array$softRefEntry‪The soft reference entry which builds the context of that url
\TYPO3\CMS\Linkvalidator\LinkAnalyzer$reference‪Parent instance
Returns
‪bool TRUE on success or FALSE on error

Implements TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface.

Definition at line 73 of file InternalLinktype.php.

References TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\$responseContent, TYPO3\CMS\Webhooks\Message\$url, TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\checkContent(), TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\checkPage(), and TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype\setErrorParams().

◆ checkPage()

bool TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype::checkPage (   $page)
protected

Checks a given page uid for validity

Parameters
int$page‪Page uid to check
Returns
‪bool TRUE on success or FALSE on error

Definition at line 129 of file InternalLinktype.php.

References $GLOBALS, TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\$responsePage, TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\DELETED, TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\HIDDEN, TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\NOTEXISTING, and TYPO3\CMS\Core\Database\Connection\PARAM_INT.

Referenced by TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\checkLink().

◆ getBrokenUrl()

string TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype::getBrokenUrl ( array  $row)

Constructs a valid Url for browser output

Parameters
array$row‪Broken link record
Returns
‪string Parsed broken url

Reimplemented from TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype.

Definition at line 350 of file InternalLinktype.php.

References $GLOBALS.

◆ getErrorMessage()

string TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype::getErrorMessage ( array  $errorParams)

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

Parameters
array$errorParams‪All parameters needed for the rendering of the error message
Returns
‪string Validation error message

Implements TYPO3\CMS\Linkvalidator\Linktype\LinktypeInterface.

Definition at line 236 of file InternalLinktype.php.

References TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype\$errorParams, TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\DELETED, TYPO3\CMS\Linkvalidator\Linktype\AbstractLinktype\getLanguageService(), TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\HIDDEN, and TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\MOVED.

Member Data Documentation

◆ $identifier

string TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype::$identifier = 'db'
protected

Definition at line 63 of file InternalLinktype.php.

◆ $responseContent

bool TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype::$responseContent = true
protected

Result of the check, if the current content uid is valid or not

Definition at line 61 of file InternalLinktype.php.

Referenced by TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\checkContent(), and TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\checkLink().

◆ $responsePage

bool TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype::$responsePage = true
protected

Result of the check, if the current page uid is valid or not

Definition at line 55 of file InternalLinktype.php.

Referenced by TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\checkPage().

◆ DELETED

const TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype::DELETED = 'deleted'

Definition at line 34 of file InternalLinktype.php.

Referenced by TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\checkContent(), TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\checkPage(), and TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\getErrorMessage().

◆ HIDDEN

const TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype::HIDDEN = 'hidden'

Definition at line 39 of file InternalLinktype.php.

Referenced by TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\checkContent(), TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\checkPage(), and TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\getErrorMessage().

◆ MOVED

const TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype::MOVED = 'moved'

Definition at line 44 of file InternalLinktype.php.

Referenced by TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\checkContent(), and TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\getErrorMessage().

◆ NOTEXISTING

const TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype::NOTEXISTING = 'notExisting'

Definition at line 49 of file InternalLinktype.php.

Referenced by TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\checkContent(), and TYPO3\CMS\Linkvalidator\Linktype\InternalLinktype\checkPage().