LinkValidatorReport

Module 'LinkValidator' as sub module of Web -> Info

Internal

This class is a specific Backend controller implementation and is not part of the TYPO3's Core API.

Table of Contents

Properties

$availableOptions  : array<string|int, mixed>
List of available link types to check defined in the TSconfig
$brokenLinkRepository  : BrokenLinkRepository
$checkOpt  : array<string|int, mixed>
List of link types currently chosen in the statistics table Used to show broken links of these types only For "Report" and "Check link" tab
$hookObjectsArr  : array<string|int, LinktypeInterface>
$iconFactory  : IconFactory
$id  : int
$isAccessibleForCurrentUser  : bool
Information, if the module is accessible for the current user or not
$lastEditedRecord  : array<string|int, mixed>
Information for last edited record
$linkAnalyzer  : LinkAnalyzer
Link validation class
$modTS  : array<string|int, mixed>
TSconfig of the current module
$moduleTemplate  : ModuleTemplate
$moduleTemplateFactory  : ModuleTemplateFactory
$pageRecord  : array<string|int, mixed>
Information about the current page record
$pageRenderer  : PageRenderer
$pagesRepository  : PagesRepository
$pObj  : InfoModuleController
$searchFields  : array<string|int, mixed>
$searchLevel  : array<string|int, mixed>
Depth for the recursive traversal of pages for the link validation For "Report" and "Check link" tab.
$view  : StandaloneView

Methods

__construct()  : mixed
init()  : mixed
Init, called from parent object
main()  : string
Main, called from parent object
createFlashMessagesForNoBrokenLinks()  : void
Used when there are no broken links found.
createView()  : StandaloneView
createViewForBrokenLinksTab()  : StandaloneView
Displays the table of broken links or a note if there were no broken links
getBackendUser()  : BackendUserAuthentication
getCheckOptions()  : array<string|int, mixed>
Builds the checkboxes to show which types of links are available
getLanguageService()  : LanguageService
getPageList()  : array<string|int, int>
Generates an array of page uids from current pageUid.
getVariablesForTableHeader()  : array<string|int, mixed>
Sets variables for the Fluid Template of the table with the broken links
initialize()  : mixed
Initializes the Module
initializeLinkAnalyzer()  : mixed
Updates the table of stored broken links
renderContent()  : string
Create tabs to split the report and the checkLink functions
renderTableRow()  : array<string|int, mixed>
Displays one line of the broken links table
updateBrokenLinks()  : mixed
Check for broken links
validateSettings()  : mixed
Checks for incoming GET/POST parameters to update the module settings

Properties

$availableOptions

List of available link types to check defined in the TSconfig

protected array<string|int, mixed> $availableOptions = []

$checkOpt

List of link types currently chosen in the statistics table Used to show broken links of these types only For "Report" and "Check link" tab

protected array<string|int, mixed> $checkOpt = ['report' => [], 'check' => []]

$id

protected int $id

Value of the GET/POST var 'id'

$isAccessibleForCurrentUser

Information, if the module is accessible for the current user or not

protected bool $isAccessibleForCurrentUser = false

$lastEditedRecord

Information for last edited record

protected array<string|int, mixed> $lastEditedRecord = ['uid' => 0, 'table' => '', 'field' => '', 'timestamp' => 0]

$modTS

TSconfig of the current module

protected array<string|int, mixed> $modTS = []

$pageRecord

Information about the current page record

protected array<string|int, mixed> $pageRecord = []

$searchFields

protected array<string|int, mixed> $searchFields = []

$searchLevel

Depth for the recursive traversal of pages for the link validation For "Report" and "Check link" tab.

protected array<string|int, mixed> $searchLevel = ['report' => 0, 'check' => 0]

Methods

__construct()

public __construct([PagesRepository|null $pagesRepository = null ][, BrokenLinkRepository|null $brokenLinkRepository = null ][, ModuleTemplateFactory|null $moduleTemplateFactory = null ][, IconFactory|null $iconFactory = null ][, PageRenderer|null $pageRecord = null ]) : mixed
Parameters
$pagesRepository : PagesRepository|null = null
$brokenLinkRepository : BrokenLinkRepository|null = null
$moduleTemplateFactory : ModuleTemplateFactory|null = null
$iconFactory : IconFactory|null = null
$pageRecord : PageRenderer|null = null

main()

Main, called from parent object

public main(ServerRequestInterface $request) : string
Parameters
$request : ServerRequestInterface
Return values
string

Module content

Used when there are no broken links found.

protected createFlashMessagesForNoBrokenLinks() : void

createViewForBrokenLinksTab()

Displays the table of broken links or a note if there were no broken links

protected createViewForBrokenLinksTab(array<string|int, mixed> $amountOfBrokenLinks) : StandaloneView
Parameters
$amountOfBrokenLinks : array<string|int, mixed>
Return values
StandaloneView

getCheckOptions()

Builds the checkboxes to show which types of links are available

protected getCheckOptions(array<string|int, mixed> $brokenLinkOverView, string $prefix) : array<string|int, mixed>
Parameters
$brokenLinkOverView : array<string|int, mixed>

Array of broken links information

$prefix : string

"report" or "check" for "Report" and "Check links" tab

Return values
array<string|int, mixed>

getPageList()

Generates an array of page uids from current pageUid.

protected getPageList() : array<string|int, int>

List does include pageUid itself.

Return values
array<string|int, int>

getVariablesForTableHeader()

Sets variables for the Fluid Template of the table with the broken links

protected getVariablesForTableHeader() : array<string|int, mixed>
Return values
array<string|int, mixed>

variables

initialize()

Initializes the Module

protected initialize() : mixed

initializeLinkAnalyzer()

Updates the table of stored broken links

protected initializeLinkAnalyzer() : mixed

renderContent()

Create tabs to split the report and the checkLink functions

protected renderContent() : string
Return values
string

renderTableRow()

Displays one line of the broken links table

protected renderTableRow(string $table, array<string|int, mixed> $row) : array<string|int, mixed>
Parameters
$table : string

Name of database table

$row : array<string|int, mixed>

Record row to be processed

Return values
array<string|int, mixed>

HTML of the rendered row

Check for broken links

protected updateBrokenLinks() : mixed

validateSettings()

Checks for incoming GET/POST parameters to update the module settings

protected validateSettings(ServerRequestInterface $request) : mixed
Parameters
$request : ServerRequestInterface

        
On this page

Search results