‪TYPO3CMS  11.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport Class Reference

Public Member Functions

 __construct (PagesRepository $pagesRepository=null, BrokenLinkRepository $brokenLinkRepository=null, ModuleTemplateFactory $moduleTemplateFactory=null, IconFactory $iconFactory=null, PageRenderer $pageRecord=null)
 
 init ($pObj, ServerRequestInterface $request)
 
string main (ServerRequestInterface $request)
 

Protected Member Functions

 createView (string $templateName)
 
 validateSettings (ServerRequestInterface $request)
 
 renderContent ()
 
 initialize ()
 
 initializeLinkAnalyzer ()
 
 updateBrokenLinks ()
 
StandaloneView createViewForBrokenLinksTab (array $amountOfBrokenLinks)
 
int[] getPageList ()
 
 createFlashMessagesForNoBrokenLinks ()
 
array getVariablesForTableHeader ()
 
array renderTableRow ($table, array $row)
 
array getCheckOptions (array $brokenLinkOverView, $prefix)
 
LanguageService getLanguageService ()
 
BackendUserAuthentication getBackendUser ()
 

Protected Attributes

array $pageRecord = array( )
 
bool $isAccessibleForCurrentUser = false
 
LinkAnalyzer $linkAnalyzer
 
array $modTS = array( )
 
array $availableOptions = array( )
 
array $searchLevel = array( 'report' => 0, 'check' => 0 )
 
array $checkOpt = array( 'report' => [], 'check' => [] )
 
array $lastEditedRecord
 
LinktypeInterface[] $hookObjectsArr = array( )
 
IconFactory $iconFactory
 
 $id
 
InfoModuleController $pObj
 
array $searchFields = array( )
 
BrokenLinkRepository $brokenLinkRepository
 
PagesRepository $pagesRepository
 
ModuleTemplate $moduleTemplate
 
StandaloneView $view
 
ModuleTemplateFactory $moduleTemplateFactory
 
PageRenderer $pageRenderer
 

Detailed Description

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

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

Definition at line 43 of file LinkValidatorReport.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::__construct ( PagesRepository  $pagesRepository = null,
BrokenLinkRepository  $brokenLinkRepository = null,
ModuleTemplateFactory  $moduleTemplateFactory = null,
IconFactory  $iconFactory = null,
PageRenderer  $pageRecord = null 
)

Definition at line 140 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\$brokenLinkRepository, TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\$iconFactory, TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\$moduleTemplateFactory, TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\$pageRecord, and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\$pagesRepository.

Member Function Documentation

◆ createFlashMessagesForNoBrokenLinks()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::createFlashMessagesForNoBrokenLinks ( )
protected

Used when there are no broken links found.

Definition at line 469 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService(), and TYPO3\CMS\Core\Messaging\AbstractMessage\OK.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\createViewForBrokenLinksTab().

◆ createView()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::createView ( string  $templateName)
protected

Definition at line 174 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\$view, TYPO3\CMS\Extbase\Mvc\View\ViewInterface\assign(), TYPO3\CMS\Fluid\View\AbstractTemplateView\setLayoutRootPaths(), TYPO3\CMS\Fluid\View\AbstractTemplateView\setPartialRootPaths(), TYPO3\CMS\Fluid\View\AbstractTemplateView\setTemplate(), and TYPO3\CMS\Fluid\View\AbstractTemplateView\setTemplateRootPaths().

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\createViewForBrokenLinksTab(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\init(), and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\renderContent().

◆ createViewForBrokenLinksTab()

StandaloneView TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::createViewForBrokenLinksTab ( array  $amountOfBrokenLinks)
protected

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

Parameters
array$amountOfBrokenLinks
Returns
‪StandaloneView

Definition at line 406 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\$view, TYPO3\CMS\Extbase\Mvc\View\ViewInterface\assign(), TYPO3\CMS\Extbase\Mvc\View\ViewInterface\assignMultiple(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\createFlashMessagesForNoBrokenLinks(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\createView(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getCheckOptions(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getPageList(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getVariablesForTableHeader(), and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\renderTableRow().

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\renderContent().

◆ getBackendUser()

BackendUserAuthentication TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::getBackendUser ( )
protected
Returns
‪BackendUserAuthentication

Definition at line 626 of file LinkValidatorReport.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getPageList(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\initialize(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\renderTableRow(), and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\validateSettings().

◆ getCheckOptions()

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::getCheckOptions ( array  $brokenLinkOverView,
  $prefix 
)
protected

Builds the checkboxes to show which types of links are available

Parameters
array$brokenLinkOverView‪Array of broken links information
string$prefix‪"report" or "check" for "Report" and "Check links" tab
Returns
‪array

Definition at line 591 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\$id, TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService(), TYPO3\CMS\Core\Localization\LanguageService\getLL(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\createViewForBrokenLinksTab(), and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\renderContent().

◆ getLanguageService()

LanguageService TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::getLanguageService ( )
protected
Returns
‪LanguageService

Definition at line 618 of file LinkValidatorReport.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\createFlashMessagesForNoBrokenLinks(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getCheckOptions(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getVariablesForTableHeader(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\main(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\renderContent(), and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\renderTableRow().

◆ getPageList()

int [] TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::getPageList ( )
protected

Generates an array of page uids from current pageUid. List does include pageUid itself.

Returns
‪int[]

Definition at line 446 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\$id, TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getBackendUser(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getPagePermsClause(), and TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\createViewForBrokenLinksTab(), and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\initializeLinkAnalyzer().

◆ getVariablesForTableHeader()

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::getVariablesForTableHeader ( )
protected

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

Returns
‪array variables

Definition at line 487 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService().

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\createViewForBrokenLinksTab().

◆ init()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::init (   $pObj,
ServerRequestInterface  $request 
)

Init, called from parent object

Parameters
InfoModuleController$pObj‪A reference to the parent (calling) object

Definition at line 166 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\$pObj, and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\createView().

◆ initialize()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::initialize ( )
protected

Initializes the Module

Definition at line 330 of file LinkValidatorReport.php.

References $GLOBALS, TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getBackendUser(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\initializeLinkAnalyzer(), and TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\main().

◆ initializeLinkAnalyzer()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::initializeLinkAnalyzer ( )
protected

Updates the table of stored broken links

Definition at line 358 of file LinkValidatorReport.php.

References $fields, TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getPageList(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\initialize().

◆ main()

string TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::main ( ServerRequestInterface  $request)

Main, called from parent object

Returns
‪string Module content

Definition at line 251 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService(), TYPO3\CMS\Core\Localization\LanguageService\includeLLFile(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\initialize(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\renderContent(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\updateBrokenLinks(), and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\validateSettings().

◆ renderContent()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::renderContent ( )
protected

Create tabs to split the report and the checkLink functions

Definition at line 290 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\createView(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\createViewForBrokenLinksTab(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getCheckOptions(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService(), and TYPO3\CMS\Core\Localization\LanguageService\getLL().

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\main().

◆ renderTableRow()

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::renderTableRow (   $table,
array  $row 
)
protected

Displays one line of the broken links table

Parameters
string$table‪Name of database table
array$row‪Record row to be processed
Returns
‪array HTML of the rendered row

Definition at line 513 of file LinkValidatorReport.php.

References $GLOBALS, TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getBackendUser(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW, and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\createViewForBrokenLinksTab().

◆ updateBrokenLinks()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::updateBrokenLinks ( )
protected

Check for broken links

Definition at line 388 of file LinkValidatorReport.php.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\main().

◆ validateSettings()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::validateSettings ( ServerRequestInterface  $request)
protected

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

Definition at line 188 of file LinkValidatorReport.php.

References $GLOBALS, TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getBackendUser(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\pushModuleData().

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\main().

Member Data Documentation

◆ $availableOptions

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$availableOptions = array( )
protected

List of available link types to check defined in the TSconfig

Definition at line 73 of file LinkValidatorReport.php.

◆ $brokenLinkRepository

BrokenLinkRepository TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$brokenLinkRepository
protected

Definition at line 123 of file LinkValidatorReport.php.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\__construct().

◆ $checkOpt

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$checkOpt = array( 'report' => [], 'check' => [] )
protected

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

Definition at line 88 of file LinkValidatorReport.php.

◆ $hookObjectsArr

LinktypeInterface [] TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$hookObjectsArr = array( )
protected

Definition at line 102 of file LinkValidatorReport.php.

◆ $iconFactory

IconFactory TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$iconFactory
protected

Definition at line 106 of file LinkValidatorReport.php.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\__construct().

◆ $id

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$id
protected

Definition at line 111 of file LinkValidatorReport.php.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getCheckOptions(), and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getPageList().

◆ $isAccessibleForCurrentUser

bool TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$isAccessibleForCurrentUser = false
protected

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

Definition at line 55 of file LinkValidatorReport.php.

◆ $lastEditedRecord

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$lastEditedRecord
protected
Initial value:
= array(
'uid' => 0,
'table' => '',
'field' => '',
'timestamp' => 0,
)

Information for last edited record

Definition at line 93 of file LinkValidatorReport.php.

◆ $linkAnalyzer

LinkAnalyzer TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$linkAnalyzer
protected

Link validation class

Definition at line 61 of file LinkValidatorReport.php.

◆ $modTS

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$modTS = array( )
protected

TSconfig of the current module

Definition at line 67 of file LinkValidatorReport.php.

◆ $moduleTemplate

ModuleTemplate TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$moduleTemplate
protected

Definition at line 131 of file LinkValidatorReport.php.

◆ $moduleTemplateFactory

ModuleTemplateFactory TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$moduleTemplateFactory
protected

Definition at line 137 of file LinkValidatorReport.php.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\__construct().

◆ $pageRecord

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$pageRecord = array( )
protected

Information about the current page record

Definition at line 49 of file LinkValidatorReport.php.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\__construct().

◆ $pageRenderer

PageRenderer TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$pageRenderer
protected

Definition at line 138 of file LinkValidatorReport.php.

◆ $pagesRepository

PagesRepository TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$pagesRepository
protected

Definition at line 127 of file LinkValidatorReport.php.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\__construct().

◆ $pObj

InfoModuleController TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$pObj
protected

Contains a reference to the parent calling object

Definition at line 115 of file LinkValidatorReport.php.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\init().

◆ $searchFields

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$searchFields = array( )
protected

Definition at line 119 of file LinkValidatorReport.php.

◆ $searchLevel

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$searchLevel = array( 'report' => 0, 'check' => 0 )
protected

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

Definition at line 80 of file LinkValidatorReport.php.

◆ $view

StandaloneView TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::$view
protected

Definition at line 135 of file LinkValidatorReport.php.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\createView(), and TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\createViewForBrokenLinksTab().