TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport Class Reference

Public Member Functions
	__construct ()
	init ($pObj)
string	main ()

Protected Member Functions
	createView (string $templateName)
	validateSettings ()
	renderContent ()
	initialize ()
	initializeLinkAnalyzer ()
	updateBrokenLinks ()
StandaloneView	createViewForBrokenLinksTab (array $amountOfBrokenLinks)
array	getPageList ()
	createFlashMessagesForNoBrokenLinks ()
array	getVariablesForTableHeader ()
array	renderTableRow ($table, array $row)
array	getCheckOptions (array $brokenLinkOverView, $prefix)
LanguageService	getLanguageService ()
BackendUserAuthentication	getBackendUser ()
	addPageTranslationsToPageList (string $theList, string $permsClause)

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
ModuleTemplate	$moduleTemplate
StandaloneView	$view

Detailed Description

Module 'Link validator' 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 42 of file LinkValidatorReport.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::__construct

(

)

Definition at line 132 of file LinkValidatorReport.php.

Member Function Documentation

addPageTranslationsToPageList()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::addPageTranslationsToPageList ( string  $theList, string  $permsClause  )

protected

Definition at line 605 of file LinkValidatorReport.php.

References TYPO3\CMS\Core\Database\Query\QueryHelper\stripLogicalOperatorPrefix().

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

createFlashMessagesForNoBrokenLinks()

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

protected

Used when there are no broken links found.

Definition at line 437 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 152 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 378 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 600 of file LinkValidatorReport.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getPageList(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\initialize(), 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 564 of file LinkValidatorReport.php.

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

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 592 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()

array TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::getPageList ( )

protected

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

Returns

‪array

Definition at line 418 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\$id, TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\addPageTranslationsToPageList(), TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getBackendUser(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getPagePermsClause(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), 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 455 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService(), and TYPO3\CMS\Backend\Utility\BackendUtility\wrapInHelp().

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

init()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::init

(

$pObj

)

Init, called from parent object

Parameters

InfoModuleController

$pObj

‪A reference to the parent (calling) object

Definition at line 142 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 311 of file LinkValidatorReport.php.

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

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 337 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

(

)

Main, called from parent object

Returns

‪string Module content

Definition at line 232 of file LinkValidatorReport.php.

References TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), 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 271 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 481 of file LinkValidatorReport.php.

References $GLOBALS, TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordPath(), 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 367 of file LinkValidatorReport.php.

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

validateSettings()

TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport::validateSettings ( )

protected

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

Definition at line 166 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 72 of file LinkValidatorReport.php.

$brokenLinkRepository

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

protected

Definition at line 122 of file LinkValidatorReport.php.

$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 87 of file LinkValidatorReport.php.

$hookObjectsArr

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

protected

Definition at line 101 of file LinkValidatorReport.php.

$iconFactory

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

protected

Definition at line 105 of file LinkValidatorReport.php.

$id

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

protected

Definition at line 110 of file LinkValidatorReport.php.

Referenced by 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 54 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 92 of file LinkValidatorReport.php.

$linkAnalyzer

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

protected

Link validation class

Definition at line 60 of file LinkValidatorReport.php.

$modTS

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

protected

TSconfig of the current module

Definition at line 66 of file LinkValidatorReport.php.

$moduleTemplate

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

protected

Definition at line 126 of file LinkValidatorReport.php.

$pageRecord

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

protected

Information about the current page record

Definition at line 48 of file LinkValidatorReport.php.

$pObj

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

protected

Contains a reference to the parent calling object

Definition at line 114 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 118 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 79 of file LinkValidatorReport.php.

$view

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

protected

Definition at line 130 of file LinkValidatorReport.php.

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