LinkAnalyzerResult

Used to work with LinkAnalyzer results

Internal

Table of Contents

Properties

$brokenLinks  : array<string|int, mixed>
$differentToLastResult  : bool
$localizedPages  : array<string, int>
Save localized pages to reduce database requests
$newBrokenLinkCounts  : array<string|int, mixed>
$oldBrokenLinkCounts  : array<string|int, mixed>

Methods

__construct()  : mixed
getBrokenLinks()  : array<string|int, mixed>
getNewBrokenLinkCounts()  : array<string|int, mixed>
getOldBrokenLinkCounts()  : array<string|int, mixed>
getResultForTask()  : self
Call LinkAnalyzer with provided task configuration and process result values
getTotalBrokenLinksCount()  : int
isDifferentToLastResult()  : bool
setBrokenLinks()  : void
setNewBrokenLinkCounts()  : void
setOldBrokenLinkCounts()  : void
getLanguageService()  : LanguageService
getLocalizedPageId()  : int
Get localized page id and store it in the local property localizedPages
processBrokenLinks()  : self
Process broken link values and assign them to new variables which are used in the templates shipped by the core but can also be used in custom templates. The raw data is untouched and can also still be used in custom templates.
processLinkCounts()  : self
Process the link counts (old and new) and ensures that all link types are available in the array

Properties

$brokenLinks

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

$differentToLastResult

protected bool $differentToLastResult = false

$localizedPages

Save localized pages to reduce database requests

protected array<string, int> $localizedPages = []

$newBrokenLinkCounts

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

$oldBrokenLinkCounts

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

Methods

getBrokenLinks()

public getBrokenLinks() : array<string|int, mixed>
Return values
array<string|int, mixed>

getNewBrokenLinkCounts()

public getNewBrokenLinkCounts() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOldBrokenLinkCounts()

public getOldBrokenLinkCounts() : array<string|int, mixed>
Return values
array<string|int, mixed>

getResultForTask()

Call LinkAnalyzer with provided task configuration and process result values

public getResultForTask(int $page, int $depth, array<string|int, mixed> $pageRow, array<string|int, mixed> $modTSconfig[, array<string|int, mixed> $searchFields = [] ][, array<string|int, mixed> $linkTypes = [] ][, string $languages = '' ]) : self
Parameters
$page : int
$depth : int
$pageRow : array<string|int, mixed>
$modTSconfig : array<string|int, mixed>
$searchFields : array<string|int, mixed> = []
$linkTypes : array<string|int, mixed> = []
$languages : string = ''
Return values
self

getTotalBrokenLinksCount()

public getTotalBrokenLinksCount() : int
Return values
int

isDifferentToLastResult()

public isDifferentToLastResult() : bool
Return values
bool

setBrokenLinks()

public setBrokenLinks(array<string|int, mixed> $brokenLinks) : void
Parameters
$brokenLinks : array<string|int, mixed>

setNewBrokenLinkCounts()

public setNewBrokenLinkCounts(array<string|int, mixed> $newBrokenLinkCounts) : void
Parameters
$newBrokenLinkCounts : array<string|int, mixed>

setOldBrokenLinkCounts()

public setOldBrokenLinkCounts(array<string|int, mixed> $oldBrokenLinkCounts) : void
Parameters
$oldBrokenLinkCounts : array<string|int, mixed>

getLocalizedPageId()

Get localized page id and store it in the local property localizedPages

protected getLocalizedPageId(int $parentId, int $languageId) : int
Parameters
$parentId : int
$languageId : int
Return values
int

processBrokenLinks()

Process broken link values and assign them to new variables which are used in the templates shipped by the core but can also be used in custom templates. The raw data is untouched and can also still be used in custom templates.

protected processBrokenLinks() : self
Return values
self

processLinkCounts()

Process the link counts (old and new) and ensures that all link types are available in the array

protected processLinkCounts(array<int, string> $linkTypes) : self
Parameters
$linkTypes : array<int, string>

list of link types

Return values
self 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results